SelectOperator

class HPS.SelectOperator : public HPS.Operator 

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.

Subclassed by HPS.CuttingSectionOperator, HPS.HighlightOperator

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

override string GetName (): Returns the name of the Operator.

HPS.SelectionOptionsKit GetSelectionOptions ()

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

Return: The HPS.SelectionOptionsKit associated with this operator

override bool OnMouseDown (HPS.MouseState in_state)

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

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

override bool OnTouchDown (HPS.TouchState in_state)

This function is called whenever HPS receives a TouchEvent that signals the device was touched.

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

SelectOperator (): 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.

SelectOperator (HPS.MouseButtons in_mouse_trigger)

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.

Param in_mouse_trigger: The mouse button that will trigger this operator. Defaults to left mouse button.

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

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.

Param in_mouse_trigger: The mouse button that will trigger this operator. Defaults to left mouse button.
Param in_modifier_trigger: The 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 (HPS.SelectOperator in_that)

void SetSelectionOptions (HPS.SelectionOptionsKit in_options)

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

Param in_options: The SelectionOptionsKit from which the selection options will be set