REFERENCE MANUAL
#include <sprk_ops.h>
Public Member Functions | |
SelectionResults | GetActiveSelection () const |
virtual UTF8 | GetName () const |
SelectionOptionsKit | GetSelectionOptions () const |
virtual bool | OnMouseUp (MouseState const &in_state) |
virtual bool | OnTouchUp (TouchState const &in_state) |
virtual void | OnViewAttached () |
SelectAreaOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys()) | |
void | SetSelectionOptions (SelectionOptionsKit const &in_options) |
![]() | |
ConstructRectangleOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys(), bool draw_faces=false) | |
Rectangle | GetRectangle () 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) |
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 | OnTimerTick (TimerTickEvent const &in_event) |
virtual void | OnViewDetached () |
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 (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
enum | Priority { Low, Normal, High } |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
ModifierKeys | modifier_trigger |
MouseButtons | mouse_trigger |
The SelectAreaOperator class is a selection mechanism that operates on a rectangle input. As with all operators, this operator must be made active on a 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 SelectionOptionsKit passed to SetSelectionOptions. See Programming Guide section "User Interaction" for more details on how to use operators.
SelectAreaOperator::SelectAreaOperator | ( | MouseButtons | in_mouse_trigger = MouseButtons::ButtonLeft() , |
ModifierKeys | in_modifier_trigger = ModifierKeys() |
||
) |
SelectAreaOperator constructor. The operator is not active until it is attached to a 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. |
SelectionResults SelectAreaOperator::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 ConstructRectangleOperator.
Reimplemented in HighlightAreaOperator.
|
inline |
Gets the selection options kit that was set on this operator.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.
in_state | A MouseState object describing the current mouse state. |
Reimplemented from ConstructRectangleOperator.
Reimplemented in HighlightAreaOperator.
|
virtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.
in_state | A TouchState object describing the current touch state. |
Reimplemented from ConstructRectangleOperator.
Reimplemented in HighlightAreaOperator.
|
virtual |
This function is called whenever a view is attached to this operator.
Reimplemented from ConstructRectangleOperator.
Reimplemented in HighlightAreaOperator.
|
inline |
Sets the selection options that will be used as selection criteria for this operator.
in_options | The SelectionOptionsKit that contains the selection options for this operator |