Inheritance diagram for HPS.SelectOperator:
HPS.Operator HPS.Sprocket HPS.Object HPS.CuttingSectionOperator HPS.HighlightOperator

Public Member Functions

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

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.SelectOperator class is a selection mechanism that is intended to operate on a single selection point. 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

◆ SelectOperator() [1/3]

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

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.

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.

◆ SelectOperator() [2/3]

HPS.SelectOperator.SelectOperator ( HPS.MouseButtons  in_mouse_trigger)
inline

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.

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

◆ SelectOperator() [3/3]

HPS.SelectOperator.SelectOperator ( )
inline

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.

Member Function Documentation

◆ GetActiveSelection()

HPS.SelectionResults HPS.SelectOperator.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.SelectOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.Operator.

◆ GetSelectionOptions()

HPS.SelectionOptionsKit HPS.SelectOperator.GetSelectionOptions ( )
inline

Gets the HPS.SelectionOptionsKit that has been set on this operator.

Returns
The HPS.SelectionOptionsKit associated with this operator

◆ OnMouseDown()

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

◆ SetSelectionOptions()

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

Accepts a SelectionOptionsKit that defines the parameters that will be used for selection.

Parameters
in_optionsThe SelectionOptionsKit from which the selection options will be set

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