HPS::HighlightOperator Class Reference
Inheritance diagram for HPS::HighlightOperator:
HPS::SelectOperator HPS::Operator HPS::Sprocket HPS::Object

Public Member Functions

HPS::HighlightOptionsKit GetHighlightOptions () const
 
virtual HPS::UTF8 GetName () const
 
 HighlightOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
virtual bool OnMouseDown (MouseState const &in_state)
 
virtual bool OnTouchDown (TouchState const &in_state)
 
void SetHighlightOptions (HPS::HighlightOptionsKit const &in_options)
 
- Public Member Functions inherited from HPS::SelectOperator
HPS::SelectionResults GetActiveSelection () const
 
HPS::SelectionOptionsKit GetSelectionOptions () const
 
 SelectOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
void SetSelectionOptions (HPS::SelectionOptionsKit const &in_options)
 
- Public Member Functions inherited from HPS::Operator
virtual void Assign (Operator const &in_that)
 
void DetachView ()
 
virtual bool Equals (Operator const &in_that) const
 
View GetAttachedView () const
 
ModifierKeys GetModifierTrigger () const
 
MouseButtons GetMouseTrigger () const
 
virtual bool IsMouseTriggered (MouseState const &in_state)
 
HPS::Type ObjectType () const
 
virtual bool OnKeyDown (KeyboardState const &in_state)
 
virtual bool OnKeyUp (KeyboardState const &in_state)
 
virtual void OnModelAttached ()
 
virtual void OnModelDetached ()
 
virtual bool OnMouseEnter (MouseState const &in_state)
 
virtual bool OnMouseLeave (MouseState const &in_state)
 
virtual bool OnMouseMove (MouseState const &in_state)
 
virtual bool OnMouseUp (MouseState const &in_state)
 
virtual bool OnMouseWheel (MouseState const &in_state)
 
virtual bool OnTextInput (HPS::UTF8 const &in_text)
 
virtual bool OnTimerTick (HPS::TimerTickEvent const &in_event)
 
virtual bool OnTouchMove (TouchState const &in_state)
 
virtual bool OnTouchUp (TouchState const &in_state)
 
virtual void OnViewAttached (HPS::View const &in_attached_view)
 
virtual void OnViewDetached (HPS::View const &in_detached_view)
 
 Operator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
 Operator (Operator const &in_that)
 
virtual bool operator!= (Operator const &in_that) const
 
virtual Operatoroperator= (Operator const &in_that)
 
virtual bool operator== (Operator const &in_that) const
 
void SetModifierTrigger (ModifierKeys in_modifiers)
 
void SetMouseTrigger (MouseButtons in_buttons)
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Additional Inherited Members

- Public Types inherited from HPS::Operator
enum  Priority { Low, Default, High }
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Static Public Attributes inherited from HPS::Operator
static const HPS::Type staticType = HPS::Type::Operator
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 
- Protected Attributes inherited from HPS::SelectOperator
HPS::SelectionResults active_selection
 
- Protected Attributes inherited from HPS::Operator
HPS::ModifierKeys modifier_trigger
 
HPS::MouseButtons mouse_trigger
 

Constructor & Destructor Documentation

◆ HighlightOperator()

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

Constructor for HighlightOperator

Parameters
in_mouse_triggerThe mouse button that will activate this operator
in_modifier_triggerThe modifier button that, when pressed with the mouse trigger, will activate this operator

Member Function Documentation

◆ GetHighlightOptions()

HPS::HighlightOptionsKit HPS::HighlightOperator::GetHighlightOptions ( ) const
inline

Gets the HPS::HighlightOptionsKit associated with this operator.

Returns
The HPS::HighlightOptionsKit associated with this operator

◆ GetName()

virtual HPS::UTF8 HPS::HighlightOperator::GetName ( ) const
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS::SelectOperator.

◆ OnMouseDown()

virtual bool HPS::HighlightOperator::OnMouseDown ( MouseState const &  in_state)
virtual

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

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS::SelectOperator.

◆ OnTouchDown()

virtual bool HPS::HighlightOperator::OnTouchDown ( TouchState const &  in_state)
virtual

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

Parameters
in_stateA TouchState object describing the current touch state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS::SelectOperator.

◆ SetHighlightOptions()

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

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

Parameters
in_optionsThe HighlightOptionsKit from which the highlight options will be set

The documentation for this class was generated from the following file: