HPS.SelectAreaOperator Class Reference

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

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

Public Member Functions

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 selection options kit that was set on this operator. More...
 
override bool OnMouseUp (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More...
 
override 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...
 
override void OnViewAttached ()
 This function is called whenever a view is attached to this operator. More...
 
 SelectAreaOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 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. More...
 
 SelectAreaOperator (HPS.MouseButtons in_mouse_trigger)
 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. More...
 
 SelectAreaOperator ()
 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. More...
 
 SelectAreaOperator (HPS.SelectAreaOperator in_that)
 
delegate int SelectAreaOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str)
 
delegate void SelectAreaOperatorDelegate_1 ()
 
delegate bool SelectAreaOperatorDelegate_10 (IntPtr in_that)
 
delegate bool SelectAreaOperatorDelegate_11 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_12 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_13 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_14 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_15 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_16 (string in_text)
 
delegate bool SelectAreaOperatorDelegate_17 (IntPtr in_event)
 
delegate void SelectAreaOperatorDelegate_18 ()
 
delegate void SelectAreaOperatorDelegate_19 ()
 
delegate bool SelectAreaOperatorDelegate_2 (IntPtr in_state)
 
delegate void SelectAreaOperatorDelegate_20 ()
 
delegate bool SelectAreaOperatorDelegate_21 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_22 ()
 
delegate void SelectAreaOperatorDelegate_23 ()
 
delegate bool SelectAreaOperatorDelegate_3 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_4 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_5 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_6 (IntPtr in_state)
 
delegate bool SelectAreaOperatorDelegate_7 (IntPtr in_state)
 
delegate HPS.Type SelectAreaOperatorDelegate_8 ()
 
delegate void SelectAreaOperatorDelegate_9 (IntPtr in_that)
 
void SetSelectionOptions (HPS.SelectionOptionsKit in_options)
 Sets the selection options that will be used as selection criteria for this operator. More...
 
- 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)
 
delegate int ConstructRectangleOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str)
 
delegate void ConstructRectangleOperatorDelegate_1 ()
 
delegate bool ConstructRectangleOperatorDelegate_10 (IntPtr in_that)
 
delegate bool ConstructRectangleOperatorDelegate_11 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_12 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_13 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_14 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_15 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_16 (string in_text)
 
delegate bool ConstructRectangleOperatorDelegate_17 (IntPtr in_event)
 
delegate void ConstructRectangleOperatorDelegate_18 ()
 
delegate void ConstructRectangleOperatorDelegate_19 ()
 
delegate bool ConstructRectangleOperatorDelegate_2 (IntPtr in_state)
 
delegate void ConstructRectangleOperatorDelegate_20 ()
 
delegate bool ConstructRectangleOperatorDelegate_21 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_22 ()
 
delegate void ConstructRectangleOperatorDelegate_23 ()
 
delegate bool ConstructRectangleOperatorDelegate_3 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_4 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_5 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_6 (IntPtr in_state)
 
delegate bool ConstructRectangleOperatorDelegate_7 (IntPtr in_state)
 
delegate HPS.Type ConstructRectangleOperatorDelegate_8 ()
 
delegate void ConstructRectangleOperatorDelegate_9 (IntPtr in_that)
 
HPS.Rectangle GetRectangle ()
 Returns the rectangle associated with this operator. More...
 
bool IsRectangleValid ()
 
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 OnMouseMove (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse moved More...
 
override bool OnTouchDown (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals the device was touched. More...
 
override bool OnTouchMove (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. 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 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 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 ()
 
delegate void OperatorDelegate_1 (IntPtr in_that)
 
delegate bool OperatorDelegate_10 (IntPtr in_state)
 
delegate bool OperatorDelegate_11 (IntPtr in_state)
 
delegate bool OperatorDelegate_12 (IntPtr in_state)
 
delegate bool OperatorDelegate_13 (IntPtr in_state)
 
delegate bool OperatorDelegate_14 (IntPtr in_state)
 
delegate bool OperatorDelegate_15 (string in_text)
 
delegate bool OperatorDelegate_16 (IntPtr in_event)
 
delegate void OperatorDelegate_17 ()
 
delegate void OperatorDelegate_18 ()
 
delegate void OperatorDelegate_19 ()
 
delegate bool OperatorDelegate_2 (IntPtr in_that)
 
delegate void OperatorDelegate_20 ()
 
delegate bool OperatorDelegate_21 (IntPtr in_state)
 
delegate bool OperatorDelegate_22 ()
 
delegate void OperatorDelegate_23 ()
 
delegate int OperatorDelegate_3 (int ret_maxsize, IntPtr ret_str)
 
delegate bool OperatorDelegate_4 (IntPtr in_state)
 
delegate bool OperatorDelegate_5 (IntPtr in_state)
 
delegate bool OperatorDelegate_6 (IntPtr in_state)
 
delegate bool OperatorDelegate_7 (IntPtr in_state)
 
delegate bool OperatorDelegate_8 (IntPtr in_state)
 
delegate bool OperatorDelegate_9 (IntPtr in_state)
 
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...
 
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 IntPtr GetNonDirectorClassID ()
 
- Protected Member Functions inherited from HPS.Operator
void DtorCallback (IntPtr p)
 

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
 
HandleRef wptr
 
- 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 > 
weakRefs = new Dictionary<IntPtr, WeakReference>()
 

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

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.

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.

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

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.

override string HPS.SelectAreaOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.ConstructRectangleOperator.

HPS.SelectionOptionsKit HPS.SelectAreaOperator.GetSelectionOptions ( )
inline

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

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.

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.

override void HPS.SelectAreaOperator.OnViewAttached ( )
inlinevirtual

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

Reimplemented from HPS.ConstructRectangleOperator.

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

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


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