#include <sprk_ops.h>
Public Member Functions | |
SelectOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys()) | |
virtual HPS::UTF8 | GetName () const |
virtual bool | OnMouseDown (MouseState const &in_state) |
virtual bool | OnTouchDown (TouchState const &in_state) |
HPS::SelectionResults | GetActiveSelection () const |
void | SetSelectionOptions (HPS::SelectionOptionsKit const &in_options) |
HPS::SelectionOptionsKit | GetSelectionOptions () const |
![]() | |
Operator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys()) | |
Operator (Operator const &in_that) | |
HPS::Type | ObjectType () const |
virtual Operator & | operator= (Operator const &in_that) |
virtual void | Assign (Operator const &in_that) |
virtual bool | Equals (Operator const &in_that) const |
virtual bool | operator!= (Operator const &in_that) const |
virtual bool | operator== (Operator const &in_that) const |
void | DetachView () |
View | GetAttachedView () const |
virtual bool | OnMouseUp (MouseState const &in_state) |
virtual bool | OnMouseMove (MouseState const &in_state) |
virtual bool | OnMouseWheel (MouseState const &in_state) |
virtual bool | OnMouseEnter (MouseState const &in_state) |
virtual bool | OnMouseLeave (MouseState const &in_state) |
virtual bool | OnTouchUp (TouchState const &in_state) |
virtual bool | OnTouchMove (TouchState const &in_state) |
virtual bool | OnKeyDown (KeyboardState const &in_state) |
virtual bool | OnKeyUp (KeyboardState const &in_state) |
virtual bool | OnTimerTick (HPS::TimerTickEvent const &in_event) |
virtual void | OnViewAttached () |
virtual void | OnViewDetached () |
virtual void | OnModelAttached () |
virtual void | OnModelDetached () |
void | SetMouseTrigger (MouseButtons in_buttons) |
MouseButtons | GetMouseTrigger () const |
void | SetModifierTrigger (ModifierKeys in_modifiers) |
ModifierKeys | GetModifierTrigger () const |
virtual bool | IsMouseTriggered (MouseState const &in_state) |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
enum | Priority { Low, Normal, High } |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
HPS::MouseButtons | mouse_trigger |
HPS::ModifierKeys | modifier_trigger |
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.
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.
in_mouse_trigger | The mouse button that will trigger this operator. Defaults to left mouse button. |
in_modifier_trigger | The 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. |
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.
|
inlinevirtual |
Returns the name of the Operator.
Reimplemented from HPS::Operator.
Reimplemented in HPS::CuttingSectionOperator, and HPS::HighlightOperator.
|
inline |
Gets the HPS::SelectionOptionsKit that has been set on this operator.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed.
in_state | A MouseState object describing the current mouse state. |
Reimplemented from HPS::Operator.
Reimplemented in HPS::CuttingSectionOperator, and HPS::HighlightOperator.
|
virtual |
This function is called whenever HPS receives a TouchEvent that signals the device was touched.
in_state | A TouchState object describing the current touch state. |
Reimplemented from HPS::Operator.
Reimplemented in HPS::CuttingSectionOperator, and HPS::HighlightOperator.
|
inline |
Accepts a SelectionOptionsKit that defines the parameters that will be used for selection.
in_options | The SelectionOptionsKit from which the selection options will be set |