HPS.HighlightAreaOperator Class Reference
Inheritance diagram for HPS.HighlightAreaOperator:
HPS.SelectAreaOperator HPS.ConstructRectangleOperator HPS.Operator HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
HPS.HighlightOptionsKit GetHighlightOptions ()
 
override string GetName ()
 
 HighlightAreaOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 HighlightAreaOperator (HPS.MouseButtons in_mouse_trigger)
 
 HighlightAreaOperator ()
 
 HighlightAreaOperator (HPS.HighlightAreaOperator in_that)
 
override bool OnMouseUp (HPS.MouseState in_state)
 
override bool OnTouchUp (HPS.TouchState in_state)
 
override void OnViewAttached (HPS.View in_attached_view)
 
void SetHighlightOptions (HPS.HighlightOptionsKit in_options)
 
- Public Member Functions inherited from HPS.SelectAreaOperator
override void Dispose ()
 
HPS.SelectionResults GetActiveSelection ()
 
override string GetName ()
 
HPS.SelectionOptionsKit GetSelectionOptions ()
 
override bool OnMouseUp (HPS.MouseState in_state)
 
override bool OnTouchUp (HPS.TouchState in_state)
 
override void OnViewAttached (HPS.View in_attached_view)
 
 SelectAreaOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 SelectAreaOperator (HPS.MouseButtons in_mouse_trigger)
 
 SelectAreaOperator ()
 
 SelectAreaOperator (HPS.SelectAreaOperator in_that)
 
void SetSelectionOptions (HPS.SelectionOptionsKit in_options)
 
- Public Member Functions inherited from HPS.ConstructRectangleOperator
 ConstructRectangleOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger, bool draw_faces)
 
 ConstructRectangleOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 ConstructRectangleOperator (HPS.MouseButtons in_mouse_trigger)
 
 ConstructRectangleOperator (HPS.ConstructRectangleOperator in_that)
 
HPS.Rectangle GetInnerWindowRectangle ()
 
HPS.Rectangle GetWindowRectangle ()
 
bool IsRectangleValid ()
 
override bool OnMouseDown (HPS.MouseState in_state)
 
override bool OnMouseMove (HPS.MouseState in_state)
 
override bool OnTouchDown (HPS.TouchState in_state)
 
override bool OnTouchMove (HPS.TouchState in_state)
 
- 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 OnMouseWheel (HPS.MouseState in_state)
 
virtual bool OnTextInput (string in_text)
 
virtual bool OnTimerTick (HPS.TimerTickEvent in_event)
 
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.SelectAreaOperator
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

◆ HighlightAreaOperator() [1/3]

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

Constructor for HighlightAreaOperator

Parameters
in_mouse_triggerThe mouse trigger that will activate this operator
in_modifier_triggerThe modifier keys needed to activate this operator. Optional.

◆ HighlightAreaOperator() [2/3]

HPS.HighlightAreaOperator.HighlightAreaOperator ( HPS.MouseButtons  in_mouse_trigger)
inline

Constructor for HighlightAreaOperator

Parameters
in_mouse_triggerThe mouse trigger that will activate this operator

◆ HighlightAreaOperator() [3/3]

HPS.HighlightAreaOperator.HighlightAreaOperator ( )
inline

Constructor for HighlightAreaOperator

Member Function Documentation

◆ GetHighlightOptions()

HPS.HighlightOptionsKit HPS.HighlightAreaOperator.GetHighlightOptions ( )
inline

Gets the highlight options kit associated with this operator.

◆ GetName()

override string HPS.HighlightAreaOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.ConstructRectangleOperator.

◆ OnMouseUp()

override bool HPS.HighlightAreaOperator.OnMouseUp ( HPS.MouseState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.ConstructRectangleOperator.

◆ OnTouchUp()

override bool HPS.HighlightAreaOperator.OnTouchUp ( HPS.TouchState  in_state)
inlinevirtual

This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.

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

Reimplemented from HPS.ConstructRectangleOperator.

◆ OnViewAttached()

override void HPS.HighlightAreaOperator.OnViewAttached ( HPS.View  in_attached_view)
inlinevirtual

This function is called whenever a view is attached to this operator.

Parameters
in_attached_viewThe view attached to this operator.

Reimplemented from HPS.ConstructRectangleOperator.

◆ SetHighlightOptions()

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

Sets the highlight options that will be used when an entity is highlighted.

Parameters
in_optionsThe HPS.HighlightOptionsKit containing the highlight options

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