< Home

< Table of Contents

REFERENCE MANUAL

HPS.TurntableOperator Class Reference

The TurntableOperator class defines an operator which allows the user to orbit the camera along a specific axis. More...

Inheritance diagram for HPS.TurntableOperator:
HPS.Operator HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override string GetName ()
 Returns the name of the operator. More...
 
override bool OnMouseDown (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. More...
 
override bool OnMouseMove (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse moved This function orbits the camera around the z-axis. More...
 
override bool OnMouseUp (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More...
 
override bool OnMouseWheel (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse wheel moved This function orbits the camera around the y-axis. More...
 
override bool OnTouchDown (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals the device was touched. More...
 
override bool OnTouchMove (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. More...
 
override bool OnTouchUp (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released. More...
 
 TurntableOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 TurntableOperator (HPS.MouseButtons in_mouse_trigger)
 
delegate int TurntableOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str)
 
delegate bool TurntableOperatorDelegate_1 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_10 (IntPtr in_that)
 
delegate bool TurntableOperatorDelegate_11 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_12 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_13 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_14 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_15 (IntPtr in_event)
 
delegate void TurntableOperatorDelegate_16 ()
 
delegate void TurntableOperatorDelegate_17 ()
 
delegate void TurntableOperatorDelegate_18 ()
 
delegate void TurntableOperatorDelegate_19 ()
 
delegate bool TurntableOperatorDelegate_2 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_20 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_21 ()
 
delegate void TurntableOperatorDelegate_22 ()
 
delegate bool TurntableOperatorDelegate_3 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_4 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_5 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_6 (IntPtr in_state)
 
delegate bool TurntableOperatorDelegate_7 (IntPtr in_state)
 
delegate HPS.Type TurntableOperatorDelegate_8 ()
 
delegate void TurntableOperatorDelegate_9 (IntPtr in_that)
 
- Public Member Functions inherited from HPS.Operator
virtual void Assign (HPS.Operator in_that)
 
void DetachView ()
 Detaches the Operator from the View it was previously attached to. More...
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.Operator in_that)
 
HPS.View GetAttachedView ()
 Returns the View the Operator is currently attached to. More...
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierTrigger ()
 Gets the modifier trigger associated with this operator. More...
 
HPS.MouseButtons GetMouseTrigger ()
 Gets the mouse trigger associated with this operator. More...
 
virtual bool IsMouseTriggered (HPS.MouseState in_state)
 Returns true if the MouseButtons and ModifierKeys are active. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
virtual bool OnKeyDown (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed. More...
 
virtual bool OnKeyUp (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardEvent that signals a key was released. More...
 
virtual void OnModelAttached ()
 This function is called whenever a model is attached to the view that is attached to this operator. More...
 
virtual void OnModelDetached ()
 This function is called whenever a model is detached from the view that is attached to this operator. More...
 
virtual bool OnMouseEnter (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More...
 
virtual bool OnMouseLeave (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More...
 
virtual bool OnTimerTick (HPS.TimerTickEvent in_event)
 This function is called whenever HPS receives a TimerTickEvent. More...
 
virtual void OnViewAttached ()
 This function is called whenever a view is attached to this operator. More...
 
virtual void OnViewDetached ()
 This function is called whenever a view is detached from this operator. More...
 
 Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 Operator (HPS.MouseButtons in_mouse_trigger)
 
 Operator (HPS.Operator in_that)
 
delegate HPS.Type OperatorDelegate_0 ()
 
delegate void OperatorDelegate_1 (IntPtr in_that)
 
delegate bool OperatorDelegate_10 (IntPtr in_state)
 
delegate bool OperatorDelegate_11 (IntPtr in_state)
 
delegate bool OperatorDelegate_12 (IntPtr in_state)
 
delegate bool OperatorDelegate_13 (IntPtr in_state)
 
delegate bool OperatorDelegate_14 (IntPtr in_state)
 
delegate bool OperatorDelegate_15 (IntPtr in_event)
 
delegate void OperatorDelegate_16 ()
 
delegate void OperatorDelegate_17 ()
 
delegate void OperatorDelegate_18 ()
 
delegate void OperatorDelegate_19 ()
 
delegate bool OperatorDelegate_2 (IntPtr in_that)
 
delegate bool OperatorDelegate_20 (IntPtr in_state)
 
delegate bool OperatorDelegate_21 ()
 
delegate void OperatorDelegate_22 ()
 
delegate int OperatorDelegate_3 (int ret_maxsize, IntPtr ret_str)
 
delegate bool OperatorDelegate_4 (IntPtr in_state)
 
delegate bool OperatorDelegate_5 (IntPtr in_state)
 
delegate bool OperatorDelegate_6 (IntPtr in_state)
 
delegate bool OperatorDelegate_7 (IntPtr in_state)
 
delegate bool OperatorDelegate_8 (IntPtr in_state)
 
delegate bool OperatorDelegate_9 (IntPtr in_state)
 
void SetModifierTrigger (HPS.ModifierKeys in_modifiers)
 Sets the modifier trigger associated with this operator. More...
 
void SetMouseTrigger (HPS.MouseButtons in_buttons)
 Sets the mouse trigger for this operator More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
override IntPtr GetNonDirectorClassID ()
 
- Protected Member Functions inherited from HPS.Operator
void DtorCallback (IntPtr p)
 

Additional Inherited Members

- Public Types inherited from HPS.Operator
enum  Priority { Low = 0, Normal = 1, High = 2 }
 
- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Static Public Member Functions inherited from HPS.Operator
static bool operator!= (HPS.Operator a, HPS.Operator b)
 
static bool operator== (HPS.Operator a, HPS.Operator b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The TurntableOperator class defines an operator which allows the user to orbit the camera along a specific axis.

This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: Left button pressed and move: Orbit camera around z-axis Mouse wheel: Orbit camera around y-axis Left click + Control: Selects click location as rotation center Touch-Driven Devices: Touch down and move: Orbit camera around z-axis Two finger touch and move: Orbit camera around y-axis Double Tap: Selects click location as rotation center

Member Function Documentation

override string HPS.TurntableOperator.GetName ( )
virtual

Returns the name of the operator.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnMouseDown ( HPS.MouseState  in_state)
virtual

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed.

This function starts the operator and computes the position of the starting point. If the Control button is pressed the click location will become the rotation center point.

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnMouseMove ( HPS.MouseState  in_state)
virtual

This function is called whenever HPS receives a MouseEvent that signals the mouse moved This function orbits the camera around the z-axis.

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnMouseUp ( HPS.MouseState  in_state)
virtual

This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.

This function stops the operator.

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnMouseWheel ( HPS.MouseState  in_state)
virtual

This function is called whenever HPS receives a MouseEvent that signals the mouse wheel moved This function orbits the camera around the y-axis.

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnTouchDown ( HPS.TouchState  in_state)
virtual

This function is called whenever HPS receives a TouchEvent that signals the device was touched.

This function starts the operator and computes the position of the starting point. If a double-tap is received, the touch location will become the rotation center point.

Parameters
in_stateA TouchState object describing the current touch state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnTouchMove ( HPS.TouchState  in_state)
virtual

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved.

If a one-finger touch was received, this function orbits the camera around the z-axis. If a two-finger touch was received, this function orbits the camera around the y-axis.

Parameters
in_stateA TouchState object describing the current touch state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

override bool HPS.TurntableOperator.OnTouchUp ( HPS.TouchState  in_state)
virtual

This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.

This function stops the operator.

Parameters
in_stateA TouchState object describing the current touch state.
Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.


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