HPS::HighlightAreaOperator Class Reference
Inheritance diagram for HPS::HighlightAreaOperator:

Public Member Functions | |
HPS::HighlightOptionsKit | GetHighlightOptions () const |
virtual HPS::UTF8 | GetName () const |
HighlightAreaOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys()) | |
virtual bool | OnMouseUp (MouseState const &in_state) |
virtual bool | OnTouchUp (TouchState const &in_state) |
virtual void | OnViewAttached (HPS::View const &in_attached_view) |
void | SetHighlightOptions (HPS::HighlightOptionsKit const &in_options) |
![]() | |
HPS::SelectionResults | GetActiveSelection () const |
HPS::SelectionOptionsKit | GetSelectionOptions () const |
SelectAreaOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys()) | |
void | SetSelectionOptions (HPS::SelectionOptionsKit const &in_options) |
![]() | |
ConstructRectangleOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys(), bool draw_faces=false) | |
HPS::Rectangle | GetInnerWindowRectangle () const |
HPS::Rectangle | GetWindowRectangle () const |
bool | IsRectangleValid () const |
virtual bool | OnMouseDown (MouseState const &in_state) |
virtual bool | OnMouseMove (MouseState const &in_state) |
virtual bool | OnTouchDown (TouchState const &in_state) |
virtual bool | OnTouchMove (TouchState const &in_state) |
![]() | |
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 | OnMouseWheel (MouseState const &in_state) |
virtual bool | OnTextInput (HPS::UTF8 const &in_text) |
virtual bool | OnTimerTick (HPS::TimerTickEvent const &in_event) |
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 Operator & | operator= (Operator const &in_that) |
virtual bool | operator== (Operator const &in_that) const |
void | SetModifierTrigger (ModifierKeys in_modifiers) |
void | SetMouseTrigger (MouseButtons in_buttons) |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
enum | Priority { Low, Default, High } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
static const HPS::Type | staticType = HPS::Type::Operator |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
![]() | |
HPS::ModifierKeys | modifier_trigger |
HPS::MouseButtons | mouse_trigger |
Constructor & Destructor Documentation
◆ HighlightAreaOperator()
HPS::HighlightAreaOperator::HighlightAreaOperator | ( | MouseButtons | in_mouse_trigger = MouseButtons::ButtonLeft() , |
ModifierKeys | in_modifier_trigger = ModifierKeys() |
||
) |
Constructor for HighlightAreaOperator
- Parameters
-
in_mouse_trigger The mouse trigger that will activate this operator in_modifier_trigger The modifier keys needed to activate this operator. Optional.
Member Function Documentation
◆ GetHighlightOptions()
|
inline |
Gets the highlight options kit associated with this operator.
◆ GetName()
|
inlinevirtual |
Returns the name of the Operator.
Reimplemented from HPS::SelectAreaOperator.
◆ OnMouseUp()
|
virtual |
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.
Reimplemented from HPS::SelectAreaOperator.
◆ OnTouchUp()
|
virtual |
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.
Reimplemented from HPS::SelectAreaOperator.
◆ OnViewAttached()
|
virtual |
This function is called whenever a view is attached to this operator.
- Parameters
-
in_attached_view The view attached to this operator.
Reimplemented from HPS::SelectAreaOperator.
◆ SetHighlightOptions()
|
inline |
Sets the highlight options that will be used when an entity is highlighted.
- Parameters
-
in_options The HPS::HighlightOptionsKit containing the highlight options
The documentation for this class was generated from the following file:
- include/sprk_ops.h