REFERENCE MANUAL
#include <sprk.h>
Public Types | |
enum | Priority { Low, Normal, High } |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
Public Member Functions | |
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 UTF8 | GetName () 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 | OnMouseDown (MouseState const &in_state) |
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 | OnTouchDown (TouchState const &in_state) |
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 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 |
Protected Attributes | |
ModifierKeys | modifier_trigger |
MouseButtons | mouse_trigger |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The Operator class is the base class for classes which handle under input and operate on the scene. This class handles GUI events such as key presses, mouse movement and clicks, and touches
|
inline |
Gets the modifier trigger associated with this operator.
|
inline |
Gets the mouse trigger associated with this operator.
|
inlinevirtual |
Returns the name of the Operator.
Reimplemented in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, WalkOperator, FlyOperator, ZoomFitTouchOperator, TurntableOperator, MouseWheelOperator, HighlightOperator, SelectOperator, HighlightAreaOperator, SelectAreaOperator, ZoomBoxOperator, ConstructRectangleOperator, ZoomOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
Returns true if the MouseButtons and ModifierKeys are active.
References MouseState::GetButtons(), MouseState::GetModifierKeys(), ModifierKeys::HasAll(), and MouseButtons::HasAll().
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
|
inlinevirtual |
This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed.
in_state | A KeyboardState object describing the current keyboard state. |
Reimplemented in SimpleWalkOperator, and FlyOperator.
|
inlinevirtual |
This function is called whenever HPS receives a KeyboardEvent that signals a key was released.
in_state | A KeyboardState object describing the current keyboard state. |
Reimplemented in SimpleWalkOperator, and FlyOperator.
|
inlinevirtual |
This function is called whenever a model is attached to the view that is attached to this operator. If no view is attached to this operator, this function will not be called.
Reimplemented in NavigationCubeOperator, CuttingSectionOperator, FlyOperator, and MouseWheelOperator.
|
inlinevirtual |
This function is called whenever a model is detached from the view that is attached to this operator. If no view is attached to this operator, this function will not be called.
|
inlinevirtual |
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 in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, FlyOperator, TurntableOperator, HighlightOperator, SelectOperator, ConstructRectangleOperator, ZoomOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window.
in_state | A MouseState object describing the current mouse state. |
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse left the window.
in_state | A MouseState object describing the current mouse state. |
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved
in_state | A MouseState object describing the current mouse state. |
Reimplemented in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, FlyOperator, TurntableOperator, ConstructRectangleOperator, ZoomOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
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 in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, FlyOperator, TurntableOperator, HighlightAreaOperator, SelectAreaOperator, ZoomBoxOperator, ConstructRectangleOperator, ZoomOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled.
in_state | A MouseState object describing the current mouse state. |
Reimplemented in SimpleWalkOperator, FlyOperator, TurntableOperator, and MouseWheelOperator.
|
inlinevirtual |
This function is called whenever HPS receives a TimerTickEvent.
in_event | A TimerTickEvent object describing the current event state. |
Reimplemented in CuttingSectionOperator, SimpleWalkOperator, WalkOperator, and FlyOperator.
|
inlinevirtual |
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 in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, FlyOperator, ZoomFitTouchOperator, TurntableOperator, HighlightOperator, SelectOperator, ConstructRectangleOperator, ZoomOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved.
in_state | A TouchState object describing the current touch state. |
Reimplemented in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, FlyOperator, TurntableOperator, ConstructRectangleOperator, ZoomOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
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 in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, SimpleWalkOperator, FlyOperator, ZoomFitTouchOperator, TurntableOperator, HighlightAreaOperator, SelectAreaOperator, ZoomBoxOperator, ConstructRectangleOperator, RelativeOrbitOperator, OrbitOperator, PanOperator, and PanOrbitZoomOperator.
|
inlinevirtual |
This function is called whenever a view is attached to this operator.
Reimplemented in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, WalkOperator, FlyOperator, HighlightAreaOperator, SelectAreaOperator, and ConstructRectangleOperator.
|
inlinevirtual |
This function is called whenever a view is detached from this operator.
Reimplemented in NavigationCubeOperator, AxisTriadOperator, CuttingSectionOperator, and FlyOperator.
|
inline |
Sets the modifier trigger associated with this operator.
in_modifiers | The modifier keys that are used to trigger this operator. |
|
inline |
Sets the mouse trigger for this operator