HighlightOperator

class HPS.HighlightOperator : public HPS.SelectOperator

Public Functions

override void Dispose ()
HPS.HighlightOptionsKit GetHighlightOptions ()

Gets the HPS.HighlightOptionsKit associated with this operator.

Return

The HPS.HighlightOptionsKit associated with this operator

override string GetName ()

Returns the name of the Operator.

HighlightOperator ()

Constructor for HighlightOperator

HighlightOperator (HPS.HighlightOperator in_that)
HighlightOperator (HPS.MouseButtons in_mouse_trigger)

Constructor for HighlightOperator

Param in_mouse_trigger

The mouse button that will activate this operator

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

Constructor for HighlightOperator

Param in_mouse_trigger

The mouse button that will activate this operator

Param in_modifier_trigger

The modifier button that, when pressed with the mouse trigger, will activate 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.

void SetHighlightOptions (HPS.HighlightOptionsKit in_options)

Accepts a HighlightOptionsKit that defines how an object will be highlighted.

Param in_options

The HighlightOptionsKit from which the highlight options will be set