HighlightAreaOperator

class HPS.HighlightAreaOperator : public HPS.SelectAreaOperator

Public Functions

override void Dispose ()

HPS.HighlightOptionsKit GetHighlightOptions ()

Gets the highlight options kit associated with this operator.

override string GetName ()

Returns the name of the Operator.

HighlightAreaOperator ()

Constructor for HighlightAreaOperator

HighlightAreaOperator (HPS.HighlightAreaOperator in_that)

HighlightAreaOperator (HPS.MouseButtons in_mouse_trigger)

Constructor for HighlightAreaOperator

Param in_mouse_trigger

The mouse trigger that will activate this operator

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

Constructor for HighlightAreaOperator

Param in_mouse_trigger

The mouse trigger that will activate this operator

Param in_modifier_trigger

The modifier keys needed to activate this operator. Optional.

override bool OnMouseUp (HPS.MouseState in_state)

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

Param in_state

A MouseState object describing the current mouse state.

Return

true if the input event was handled, false otherwise.

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.

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

override void OnViewAttached (HPS.View in_attached_view)

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

Param in_attached_view

The view attached to this operator.

void SetHighlightOptions (HPS.HighlightOptionsKit in_options)

Sets the highlight options that will be used when an entity is highlighted.

Param in_options

The HPS.HighlightOptionsKit containing the highlight options