HPS.HighlightOperator Class Reference
Inheritance diagram for HPS.HighlightOperator:
HPS.SelectOperator HPS.Operator HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
HPS.HighlightOptionsKit GetHighlightOptions ()
 Gets the HPS.HighlightOptionsKit associated with this operator. More...
 
override string GetName ()
 Returns the name of the Operator. More...
 
 HighlightOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 Constructor for HighlightOperator More...
 
 HighlightOperator (HPS.MouseButtons in_mouse_trigger)
 Constructor for HighlightOperator More...
 
 HighlightOperator ()
 Constructor for HighlightOperator More...
 
 HighlightOperator (HPS.HighlightOperator in_that)
 
delegate int HighlightOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate bool HighlightOperatorDelegate_1 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_10 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_11 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_12 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_13 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_14 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_15 (IntPtr cPtr, string in_text)
 
delegate bool HighlightOperatorDelegate_16 (IntPtr cPtr, IntPtr in_event)
 
delegate void HighlightOperatorDelegate_17 (IntPtr cPtr)
 
delegate void HighlightOperatorDelegate_18 (IntPtr cPtr)
 
delegate void HighlightOperatorDelegate_19 (IntPtr cPtr)
 
delegate bool HighlightOperatorDelegate_2 (IntPtr cPtr, IntPtr in_state)
 
delegate void HighlightOperatorDelegate_20 (IntPtr cPtr)
 
delegate bool HighlightOperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type HighlightOperatorDelegate_22 (IntPtr cPtr)
 
delegate bool HighlightOperatorDelegate_23 (IntPtr cPtr)
 
delegate void HighlightOperatorDelegate_24 (IntPtr cPtr)
 
delegate HPS.Type HighlightOperatorDelegate_3 (IntPtr cPtr)
 
delegate void HighlightOperatorDelegate_4 (IntPtr cPtr, IntPtr in_that)
 
delegate bool HighlightOperatorDelegate_5 (IntPtr cPtr, IntPtr in_that)
 
delegate bool HighlightOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool HighlightOperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
override bool OnMouseDown (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. More...
 
override bool OnTouchDown (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals the device was touched. More...
 
void SetHighlightOptions (HPS.HighlightOptionsKit in_options)
 Accepts a HighlightOptionsKit that defines how an object will be highlighted. More...
 
- Public Member Functions inherited from HPS.SelectOperator
override void Dispose ()
 
HPS.SelectionResults GetActiveSelection ()
 This method returns the results of the last selection action. If no objects were selected, the SelectionResults object returned will be have a count of 0. More...
 
override string GetName ()
 Returns the name of the Operator. More...
 
HPS.SelectionOptionsKit GetSelectionOptions ()
 Gets the HPS.SelectionOptionsKit that has been set on this operator. More...
 
override bool OnMouseDown (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. More...
 
override bool OnTouchDown (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals the device was touched. More...
 
 SelectOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 SelectOperator constructor. The operator is not active until it is attached to a HPS.View. Even after being attached, operator must remain in scope until you're done using it. More...
 
 SelectOperator (HPS.MouseButtons in_mouse_trigger)
 SelectOperator constructor. The operator is not active until it is attached to a HPS.View. Even after being attached, operator must remain in scope until you're done using it. More...
 
 SelectOperator ()
 SelectOperator constructor. The operator is not active until it is attached to a HPS.View. Even after being attached, operator must remain in scope until you're done using it. More...
 
 SelectOperator (HPS.SelectOperator in_that)
 
delegate int SelectOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate bool SelectOperatorDelegate_1 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_10 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_11 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_12 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_13 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_14 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_15 (IntPtr cPtr, string in_text)
 
delegate bool SelectOperatorDelegate_16 (IntPtr cPtr, IntPtr in_event)
 
delegate void SelectOperatorDelegate_17 (IntPtr cPtr)
 
delegate void SelectOperatorDelegate_18 (IntPtr cPtr)
 
delegate void SelectOperatorDelegate_19 (IntPtr cPtr)
 
delegate bool SelectOperatorDelegate_2 (IntPtr cPtr, IntPtr in_state)
 
delegate void SelectOperatorDelegate_20 (IntPtr cPtr)
 
delegate bool SelectOperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type SelectOperatorDelegate_22 (IntPtr cPtr)
 
delegate bool SelectOperatorDelegate_23 (IntPtr cPtr)
 
delegate void SelectOperatorDelegate_24 (IntPtr cPtr)
 
delegate HPS.Type SelectOperatorDelegate_3 (IntPtr cPtr)
 
delegate void SelectOperatorDelegate_4 (IntPtr cPtr, IntPtr in_that)
 
delegate bool SelectOperatorDelegate_5 (IntPtr cPtr, IntPtr in_that)
 
delegate bool SelectOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SelectOperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
void SetSelectionOptions (HPS.SelectionOptionsKit in_options)
 Accepts a SelectionOptionsKit that defines the parameters that will be used for selection. More...
 
- Public Member Functions inherited from HPS.Operator
virtual void Assign (HPS.Operator in_that)
 Assigns the parameter in_that to this operator, resulting in a clone. More...
 
void DetachView ()
 Detaches the Operator from the View it was previously attached to. More...
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.Operator in_that)
 Tests this operator for equality against the parameter in_that. Same as Operator.operator== More...
 
HPS.View GetAttachedView ()
 Returns the View the Operator is currently attached to. More...
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierTrigger ()
 Gets the modifier trigger associated with this operator. More...
 
HPS.MouseButtons GetMouseTrigger ()
 Gets the mouse trigger associated with this operator. More...
 
virtual bool IsMouseTriggered (HPS.MouseState in_state)
 Returns true if the MouseButtons and ModifierKeys are active. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
virtual bool OnKeyDown (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed. More...
 
virtual bool OnKeyUp (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardEvent that signals a key was released. More...
 
virtual void OnModelAttached ()
 This function is called whenever a model is attached to the view that is attached to this operator. If no view is attached to this operator, this function will not be called. More...
 
virtual void OnModelDetached ()
 This function is called whenever a model is detached from the view that is attached to this operator. If no view is attached to this operator, this function will not be called. More...
 
virtual bool OnMouseEnter (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More...
 
virtual bool OnMouseLeave (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More...
 
virtual bool OnMouseMove (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse moved More...
 
virtual bool OnMouseUp (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More...
 
virtual bool OnMouseWheel (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled. More...
 
virtual bool OnTextInput (string in_text)
 
virtual bool OnTimerTick (HPS.TimerTickEvent in_event)
 This function is called whenever HPS receives a TimerTickEvent. More...
 
virtual bool OnTouchMove (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. More...
 
virtual bool OnTouchUp (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released. More...
 
virtual void OnViewAttached ()
 This function is called whenever a view is attached to this operator. More...
 
virtual void OnViewDetached ()
 This function is called whenever a view is detached from this operator. More...
 
 Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 Operator (HPS.MouseButtons in_mouse_trigger)
 
 Operator (HPS.Operator in_that)
 
delegate HPS.Type OperatorDelegate_0 (IntPtr cPtr)
 
delegate void OperatorDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate bool OperatorDelegate_10 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_11 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_12 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_13 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_14 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_15 (IntPtr cPtr, string in_text)
 
delegate bool OperatorDelegate_16 (IntPtr cPtr, IntPtr in_event)
 
delegate void OperatorDelegate_17 (IntPtr cPtr)
 
delegate void OperatorDelegate_18 (IntPtr cPtr)
 
delegate void OperatorDelegate_19 (IntPtr cPtr)
 
delegate bool OperatorDelegate_2 (IntPtr cPtr, IntPtr in_that)
 
delegate void OperatorDelegate_20 (IntPtr cPtr)
 
delegate bool OperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type OperatorDelegate_22 (IntPtr cPtr)
 
delegate bool OperatorDelegate_23 (IntPtr cPtr)
 
delegate void OperatorDelegate_24 (IntPtr cPtr)
 
delegate int OperatorDelegate_3 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate bool OperatorDelegate_4 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_5 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
void SetModifierTrigger (HPS.ModifierKeys in_modifiers)
 Sets the modifier trigger associated with this operator. More...
 
void SetMouseTrigger (HPS.MouseButtons in_buttons)
 Sets the mouse trigger for this operator More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 
- Protected Member Functions inherited from HPS.SelectOperator
override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Additional Inherited Members

- Public Types inherited from HPS.Operator
enum  Priority { Low = 0, Default = 1, High = 2 }
 
- Static Public Member Functions inherited from HPS.Operator
static bool operator!= (HPS.Operator a, HPS.Operator b)
 
static bool operator== (HPS.Operator a, HPS.Operator b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Operator
HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Operator
static Dictionary< IntPtr,
Operator
cachedObjects = new Dictionary<IntPtr, Operator>()
 
static Dictionary< IntPtr,
WeakReference > 
cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Constructor & Destructor Documentation

HPS.HighlightOperator.HighlightOperator ( HPS.MouseButtons  in_mouse_trigger,
HPS.ModifierKeys  in_modifier_trigger 
)
inline

Constructor for HighlightOperator

Parameters
in_mouse_triggerThe mouse button that will activate this operator
in_modifier_triggerThe modifier button that, when pressed with the mouse trigger, will activate this operator
HPS.HighlightOperator.HighlightOperator ( HPS.MouseButtons  in_mouse_trigger)
inline

Constructor for HighlightOperator

Parameters
in_mouse_triggerThe mouse button that will activate this operator
HPS.HighlightOperator.HighlightOperator ( )
inline

Constructor for HighlightOperator

Member Function Documentation

HPS.HighlightOptionsKit HPS.HighlightOperator.GetHighlightOptions ( )
inline

Gets the HPS.HighlightOptionsKit associated with this operator.

Returns
    The HPS.HighlightOptionsKit associated with this operator
override string HPS.HighlightOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.Operator.

override bool HPS.HighlightOperator.OnMouseDown ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed.

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
    true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.HighlightOperator.OnTouchDown ( HPS.TouchState  in_state)
inlinevirtual

This function is called whenever HPS receives a TouchEvent that signals the device was touched.

Parameters
in_stateA TouchState object describing the current touch state.
Returns
    true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

void HPS.HighlightOperator.SetHighlightOptions ( HPS.HighlightOptionsKit  in_options)
inline

Accepts a HighlightOptionsKit that defines how an object will be highlighted.

Parameters
in_optionsThe HighlightOptionsKit from which the highlight options will be set

The documentation for this class was generated from the following file:
  • internals/hps_sprk_ops/source/cs/HPS.HighlightOperator.cs