REFERENCE MANUAL
The SelectAreaOperator class is a selection mechanism that operates on a rectangle input. More...
Public Member Functions | |
override void | Dispose () |
HPS.SelectionResults | GetActiveSelection () |
This method returns the results of the last selection action. 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. More... | |
SelectAreaOperator (HPS.MouseButtons in_mouse_trigger) | |
SelectAreaOperator constructor. More... | |
SelectAreaOperator () | |
SelectAreaOperator constructor. More... | |
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 (IntPtr in_event) |
delegate void | SelectAreaOperatorDelegate_17 () |
delegate void | SelectAreaOperatorDelegate_18 () |
delegate void | SelectAreaOperatorDelegate_19 () |
delegate bool | SelectAreaOperatorDelegate_2 (IntPtr in_state) |
delegate bool | SelectAreaOperatorDelegate_20 (IntPtr in_state) |
delegate bool | SelectAreaOperatorDelegate_21 () |
delegate void | SelectAreaOperatorDelegate_22 () |
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... | |
![]() | |
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) | |
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 (IntPtr in_event) |
delegate void | ConstructRectangleOperatorDelegate_17 () |
delegate void | ConstructRectangleOperatorDelegate_18 () |
delegate void | ConstructRectangleOperatorDelegate_19 () |
delegate bool | ConstructRectangleOperatorDelegate_2 (IntPtr in_state) |
delegate bool | ConstructRectangleOperatorDelegate_20 (IntPtr in_state) |
delegate bool | ConstructRectangleOperatorDelegate_21 () |
delegate void | ConstructRectangleOperatorDelegate_22 () |
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... | |
![]() | |
virtual void | Assign (HPS.Operator in_that) |
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) |
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. 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. More... | |
virtual void | OnModelDetached () |
This function is called whenever a model is detached from the view that is attached to this operator. 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 | 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 (IntPtr in_event) |
delegate void | OperatorDelegate_16 () |
delegate void | OperatorDelegate_17 () |
delegate void | OperatorDelegate_18 () |
delegate void | OperatorDelegate_19 () |
delegate bool | OperatorDelegate_2 (IntPtr in_that) |
delegate bool | OperatorDelegate_20 (IntPtr in_state) |
delegate bool | OperatorDelegate_21 () |
delegate void | OperatorDelegate_22 () |
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... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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. More... | |
Protected Member Functions | |
override void | deleteCptr () |
override IntPtr | GetNonDirectorClassID () |
![]() | |
void | DtorCallback (IntPtr p) |
Additional Inherited Members | |
![]() | |
enum | Priority { Low = 0, Normal = 1, High = 2 } |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
static bool | operator!= (HPS.Operator a, HPS.Operator b) |
static bool | operator== (HPS.Operator a, HPS.Operator b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The SelectAreaOperator class is a selection mechanism that operates on a rectangle input.
As with all operators, this operator must be made active on a 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 SelectionOptionsKit passed to SetSelectionOptions. See Programming Guide section "User Interaction" for more details on how to use operators.
HPS.SelectAreaOperator.SelectAreaOperator | ( | HPS.MouseButtons | in_mouse_trigger, |
HPS.ModifierKeys | in_modifier_trigger | ||
) |
SelectAreaOperator constructor.
The operator is not active until it is attached to a View. Even after being attached, operator must remain in scope until you're done using it.
HPS.SelectAreaOperator.SelectAreaOperator | ( | HPS.MouseButtons | in_mouse_trigger | ) |
SelectAreaOperator constructor.
The operator is not active until it is attached to a View. Even after being attached, operator must remain in scope until you're done using it.
HPS.SelectAreaOperator.SelectAreaOperator | ( | ) |
SelectAreaOperator constructor.
The operator is not active until it is attached to a View. Even after being attached, operator must remain in scope until you're done using it.
HPS.SelectionResults HPS.SelectAreaOperator.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.
|
virtual |
Returns the name of the Operator.
Reimplemented from HPS.ConstructRectangleOperator.
HPS.SelectionOptionsKit HPS.SelectAreaOperator.GetSelectionOptions | ( | ) |
Gets the selection options kit that was set on this operator.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.
in_state | A MouseState object describing the current mouse state. |
Reimplemented from HPS.ConstructRectangleOperator.
|
virtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.
in_state | A TouchState object describing the current touch state. |
Reimplemented from HPS.ConstructRectangleOperator.
|
virtual |
This function is called whenever a view is attached to this operator.
Reimplemented from HPS.ConstructRectangleOperator.
void HPS.SelectAreaOperator.SetSelectionOptions | ( | HPS.SelectionOptionsKit | in_options | ) |
Sets the selection options that will be used as selection criteria for this operator.