HighlightOperator

class HPS::HighlightOperator : public HPS::SelectOperator 

Public Functions

inline HPS::HighlightOptionsKit GetHighlightOptions() const

Gets the HPS::HighlightOptionsKit associated with this operator.

inline virtual HPS::UTF8 GetName() const: Returns the name of the Operator.

HighlightOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys())

Parameters

in_mouse_trigger – The mouse button that will activate this operator
in_modifier_trigger – The modifier button that, when pressed with the mouse trigger, will activate this operator

virtual bool OnMouseDown(MouseState const &in_state)

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

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

virtual bool OnTouchDown(TouchState const &in_state)

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

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

inline void SetHighlightOptions(HPS::HighlightOptionsKit const &in_options)

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

Parameters: in_options – The HighlightOptionsKit from which the highlight options will be set