HighlightAreaOperator

class HPS::HighlightAreaOperator : public HPS::SelectAreaOperator 

Public Functions

inline HPS::HighlightOptionsKit GetHighlightOptions() const: Gets the highlight options kit associated with this operator.

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

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

Parameters

in_mouse_trigger – The mouse trigger that will activate this operator
in_modifier_trigger – The modifier keys needed to activate this operator. Optional.

virtual bool OnMouseUp(MouseState const &in_state)

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

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

virtual bool OnTouchUp(TouchState const &in_state)

This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.

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

virtual void OnViewAttached(HPS::View const &in_attached_view)

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

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

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

Parameters: in_options – The HPS::HighlightOptionsKit containing the highlight options