HPS::SelectOperator Class Reference

#include <sprk_ops.h>

Inheritance diagram for HPS::SelectOperator:
HPS::Operator HPS::Sprocket HPS::Object HPS::CuttingSectionOperator HPS::HighlightOperator

Public Member Functions

HPS::SelectionResults GetActiveSelection () const
 
virtual HPS::UTF8 GetName () const
 
HPS::SelectionOptionsKit GetSelectionOptions () const
 
virtual bool OnMouseDown (MouseState const &in_state)
 
virtual bool OnTouchDown (TouchState const &in_state)
 
 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
 

Protected Attributes

HPS::SelectionResults active_selection
 
- Protected Attributes inherited from HPS::Operator
HPS::ModifierKeys modifier_trigger
 
HPS::MouseButtons mouse_trigger
 

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
 

Detailed Description

The HPS::SelectOperator class is a selection mechanism that is intended to operate on a single selection point. As with all operators, this operator must be made active on a HPS::View object before it can be used. The results of the last selection can be obtained by calling GetActiveSelection(). Selection options such as granularity, algorithm, proximity, and more are set using a HPS::SelectionOptionsKit passed to SetSelectionOptions. See Programming Guide section "User Interaction" for more details on how to use operators.

Constructor & Destructor Documentation

◆ SelectOperator()

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

SelectOperator constructor. The operator is not active until it is attached to a HPS::View. Even after being attached, operator must remain in scope until you're done using it.

Parameters
in_mouse_triggerThe mouse button that will trigger this operator. Defaults to left mouse button.
in_modifier_triggerThe modifier key that, when used with the in_mouse_trigger, will trigger this operator. Passing an empty ModifierKeys object means no modifier key is necessary to trigger the operator.

Member Function Documentation

◆ GetActiveSelection()

HPS::SelectionResults HPS::SelectOperator::GetActiveSelection ( ) const

This method returns the results of the last selection action. If no objects were selected, the SelectionResults object returned will be have a count of 0.

◆ GetName()

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

Returns the name of the Operator.

Reimplemented from HPS::Operator.

Reimplemented in HPS::CuttingSectionOperator, and HPS::HighlightOperator.

◆ GetSelectionOptions()

HPS::SelectionOptionsKit HPS::SelectOperator::GetSelectionOptions ( ) const
inline

Gets the HPS::SelectionOptionsKit that has been set on this operator.

Returns
The HPS::SelectionOptionsKit associated with this operator

◆ OnMouseDown()

virtual bool HPS::SelectOperator::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::Operator.

Reimplemented in HPS::CuttingSectionOperator, and HPS::HighlightOperator.

◆ OnTouchDown()

virtual bool HPS::SelectOperator::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::Operator.

Reimplemented in HPS::CuttingSectionOperator, and HPS::HighlightOperator.

◆ SetSelectionOptions()

void HPS::SelectOperator::SetSelectionOptions ( HPS::SelectionOptionsKit const &  in_options)
inline

Accepts a SelectionOptionsKit that defines the parameters that will be used for selection.

Parameters
in_optionsThe SelectionOptionsKit from which the selection options will be set

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