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 ()
 
override string GetName ()
 
 HighlightOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 HighlightOperator (HPS.MouseButtons in_mouse_trigger)
 
 HighlightOperator ()
 
 HighlightOperator (HPS.HighlightOperator in_that)
 
override bool OnMouseDown (HPS.MouseState in_state)
 
override bool OnTouchDown (HPS.TouchState in_state)
 
void SetHighlightOptions (HPS.HighlightOptionsKit in_options)
 
- Public Member Functions inherited from HPS.SelectOperator
override void Dispose ()
 
HPS.SelectionResults GetActiveSelection ()
 
override string GetName ()
 
HPS.SelectionOptionsKit GetSelectionOptions ()
 
override bool OnMouseDown (HPS.MouseState in_state)
 
override bool OnTouchDown (HPS.TouchState in_state)
 
 SelectOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 SelectOperator (HPS.MouseButtons in_mouse_trigger)
 
 SelectOperator ()
 
 SelectOperator (HPS.SelectOperator in_that)
 
void SetSelectionOptions (HPS.SelectionOptionsKit in_options)
 
- Public Member Functions inherited from HPS.Operator
virtual void Assign (HPS.Operator in_that)
 
void DetachView ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.Operator in_that)
 
HPS.View GetAttachedView ()
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierTrigger ()
 
HPS.MouseButtons GetMouseTrigger ()
 
virtual bool IsMouseTriggered (HPS.MouseState in_state)
 
override HPS.Type ObjectType ()
 
virtual bool OnKeyDown (HPS.KeyboardState in_state)
 
virtual bool OnKeyUp (HPS.KeyboardState in_state)
 
virtual void OnModelAttached ()
 
virtual void OnModelDetached ()
 
virtual bool OnMouseEnter (HPS.MouseState in_state)
 
virtual bool OnMouseLeave (HPS.MouseState in_state)
 
virtual bool OnMouseMove (HPS.MouseState in_state)
 
virtual bool OnMouseUp (HPS.MouseState in_state)
 
virtual bool OnMouseWheel (HPS.MouseState in_state)
 
virtual bool OnTextInput (string in_text)
 
virtual bool OnTimerTick (HPS.TimerTickEvent in_event)
 
virtual bool OnTouchMove (HPS.TouchState in_state)
 
virtual bool OnTouchUp (HPS.TouchState in_state)
 
virtual void OnViewAttached (HPS.View in_attached_view)
 
virtual void OnViewDetached (HPS.View in_detached_view)
 
 Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 Operator (HPS.MouseButtons in_mouse_trigger)
 
 Operator (HPS.Operator in_that)
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
void SetModifierTrigger (HPS.ModifierKeys in_modifiers)
 
void SetMouseTrigger (HPS.MouseButtons in_buttons)
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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, OperatorcachedObjects = new Dictionary<IntPtr, Operator>()
 
static Dictionary< IntPtr, WeakReference > cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Constructor & Destructor Documentation

◆ HighlightOperator() [1/3]

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

◆ HighlightOperator() [2/3]

HPS.HighlightOperator.HighlightOperator ( HPS.MouseButtons  in_mouse_trigger)
inline

Constructor for HighlightOperator

Parameters
in_mouse_triggerThe mouse button that will activate this operator

◆ HighlightOperator() [3/3]

HPS.HighlightOperator.HighlightOperator ( )
inline

Constructor for HighlightOperator

Member Function Documentation

◆ GetHighlightOptions()

HPS.HighlightOptionsKit HPS.HighlightOperator.GetHighlightOptions ( )
inline

Gets the HPS.HighlightOptionsKit associated with this operator.

Returns
The HPS.HighlightOptionsKit associated with this operator

◆ GetName()

override string HPS.HighlightOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.Operator.

◆ OnMouseDown()

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.

◆ OnTouchDown()

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.

◆ SetHighlightOptions()

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