< Home

< Table of Contents

REFERENCE MANUAL

SelectOperator Class Reference

#include <sprk_ops.h>

Inheritance diagram for SelectOperator:
Operator Sprocket Object CuttingSectionOperator HighlightOperator

Public Member Functions

SelectionResults GetActiveSelection () const
 
virtual UTF8 GetName () const
 
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 (SelectionOptionsKit const &in_options)
 
- Public Member Functions inherited from 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)
 
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 OnTimerTick (TimerTickEvent const &in_event)
 
virtual bool OnTouchMove (TouchState const &in_state)
 
virtual bool OnTouchUp (TouchState const &in_state)
 
virtual void OnViewAttached ()
 
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 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 Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Public Types inherited from Operator
enum  Priority { Low, Normal, High }
 
- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Attributes inherited from Operator
ModifierKeys modifier_trigger
 
MouseButtons mouse_trigger
 

Detailed Description

The 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 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.

Constructor & Destructor Documentation

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 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

SelectionResults 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.

virtual UTF8 SelectOperator::GetName ( ) const
inlinevirtual

Returns the name of the Operator.

Reimplemented from Operator.

Reimplemented in CuttingSectionOperator, and HighlightOperator.

SelectionOptionsKit SelectOperator::GetSelectionOptions ( ) const
inline

Gets the SelectionOptionsKit that has been set on this operator.

Returns
The SelectionOptionsKit associated with this operator
virtual bool 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 Operator.

Reimplemented in CuttingSectionOperator, and HighlightOperator.

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

Reimplemented in CuttingSectionOperator, and HighlightOperator.

void SelectOperator::SetSelectionOptions ( 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: