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

Public Member Functions

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 ()
 

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)
 

Detailed Description

The HPS.SelectAreaOperator class is a selection mechanism that operates on a rectangle input. As with all operators, this operator must be made active on a HPS.View object before it can be used. The results of the last selection can be obtained by calling GetActiveSelection(). Selection options such as granularity, algorithm, proximity, and more are set using a HPS.SelectionOptionsKit passed to SetSelectionOptions. See Programming Guide section "User Interaction" for more details on how to use operators.

Constructor & Destructor Documentation

◆ SelectAreaOperator() [1/3]

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

SelectAreaOperator 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.

Parameters
in_mouse_triggerThe mouse button that will trigger this operator. Defaults to left mouse button.
in_modifier_triggerThe modifier key that, when used with the in_mouse_trigger, will trigger this operator. Passing an empty ModifierKeys object means no modifier key is necessary to trigger the operator.

◆ SelectAreaOperator() [2/3]

HPS.SelectAreaOperator.SelectAreaOperator ( HPS.MouseButtons  in_mouse_trigger)
inline

SelectAreaOperator 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.

Parameters
in_mouse_triggerThe mouse button that will trigger this operator. Defaults to left mouse button.

◆ SelectAreaOperator() [3/3]

HPS.SelectAreaOperator.SelectAreaOperator ( )
inline

SelectAreaOperator 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.

Member Function Documentation

◆ GetActiveSelection()

HPS.SelectionResults HPS.SelectAreaOperator.GetActiveSelection ( )
inline

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.

◆ GetName()

override string HPS.SelectAreaOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.ConstructRectangleOperator.

◆ GetSelectionOptions()

HPS.SelectionOptionsKit HPS.SelectAreaOperator.GetSelectionOptions ( )
inline

Gets the selection options kit that was set on this operator.

◆ OnMouseUp()

override bool HPS.SelectAreaOperator.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.SelectAreaOperator.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.SelectAreaOperator.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.

◆ SetSelectionOptions()

void HPS.SelectAreaOperator.SetSelectionOptions ( HPS.SelectionOptionsKit  in_options)
inline

Sets the selection options that will be used as selection criteria for this operator.

Parameters
in_optionsThe HPS.SelectionOptionsKit that contains the selection options for this operator

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