API Search || Global Search
HPS.SimpleWalkOperator Class Reference

More...

Inheritance diagram for HPS.SimpleWalkOperator:
HPS.WalkOperator HPS.FlyOperator HPS.Operator HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
bool GetEnableMiddleMouseButtonDolly ()
 This function returns the state of Camera Dolly operations using the middle mouse button. The SimpleWalkOperator has Camera Dolly operations fixed to the middle mouse button by default. To disable this behavior, set this value to false. More...
 
override string GetName ()
 Returns the name of the operator. More...
 
override bool IsMouseTriggered (HPS.MouseState in_state)
 This function overrides the base class implementation to additionally inspect in_state for the middle mouse button state if middle mouse button Camera Dollying is enabled. More...
 
override bool OnKeyDown (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardState event that signals a button was pressed. This operator does not handle key down events. More...
 
override bool OnKeyUp (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardState event that signals a button was released. This operator does not handle key up events. More...
 
override void OnModelAttached ()
 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. More...
 
override bool OnMouseDown (HPS.MouseState in_state)
 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. More...
 
override bool OnMouseEnter (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More...
 
override bool OnMouseLeave (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More...
 
override bool OnMouseMove (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse moved This function rotates the camera in place and moves forward/back if the left mouse button is down. 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 More...
 
override bool OnTimerTick (HPS.TimerTickEvent in_event)
 This function is called whenever HPS receives a TimerTickEvent This function moves the camera 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...
 
override void OnViewAttached (HPS.View in_attached_view)
 This function is called whenever a view is attached to this operator. More...
 
void SetEnableMiddleMouseButtonDolly (bool in_enable)
 This function enables or disables Camera Dolly operations using the middle mouse button. The SimpleWalkOperator has Camera Dolly operations fixed to the middle mouse button by default. To disable this behavior, set this value to false. More...
 
void SetKeyboardControlKey (bool in_state)
 This function sets the Control key state in this operator. Call this function from your application to inform the the operator of the Control key state. The Control key decreases the velocities of forward/backward and rotation movements. More...
 
void SetKeyboardShiftKey (bool in_state)
 This function sets the Shift key state in this operator. Call this function from your application to inform the the operator of the Shift key state. The Shift key increases the mouse trigger button forward/backward velocity. More...
 
 SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger)
 
 SimpleWalkOperator (HPS.SimpleWalkOperator in_that)
 
delegate int SimpleWalkOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate void SimpleWalkOperatorDelegate_1 (IntPtr cPtr)
 
delegate bool SimpleWalkOperatorDelegate_10 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_11 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_12 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_13 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_14 (IntPtr cPtr, IntPtr in_event)
 
delegate bool SimpleWalkOperatorDelegate_15 (IntPtr cPtr, IntPtr in_state)
 
delegate void SimpleWalkOperatorDelegate_16 (IntPtr cPtr, IntPtr in_detached_view)
 
delegate HPS.Type SimpleWalkOperatorDelegate_17 (IntPtr cPtr)
 
delegate void SimpleWalkOperatorDelegate_18 (IntPtr cPtr, IntPtr in_that)
 
delegate bool SimpleWalkOperatorDelegate_19 (IntPtr cPtr, IntPtr in_that)
 
delegate void SimpleWalkOperatorDelegate_2 (IntPtr cPtr, IntPtr in_attached_view)
 
delegate bool SimpleWalkOperatorDelegate_20 (IntPtr cPtr, string in_text)
 
delegate void SimpleWalkOperatorDelegate_21 (IntPtr cPtr)
 
delegate HPS.Type SimpleWalkOperatorDelegate_22 (IntPtr cPtr)
 
delegate bool SimpleWalkOperatorDelegate_23 (IntPtr cPtr)
 
delegate void SimpleWalkOperatorDelegate_24 (IntPtr cPtr)
 
delegate bool SimpleWalkOperatorDelegate_3 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_4 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_5 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
- Public Member Functions inherited from HPS.WalkOperator
override void Dispose ()
 
HPS.Plane GetGroundPlane ()
 
override string GetName ()
 Returns the name of the operator. More...
 
HPS.WalkOperator.Axis GetPrimaryUpAxis ()
 
float GetWalkerHeight ()
 
override void OnModelAttached ()
 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. More...
 
override bool OnTimerTick (HPS.TimerTickEvent in_event)
 This function is called whenever HPS receives a TimerTickEvent This function moves the camera More...
 
override void OnViewAttached (HPS.View in_attached_view)
 This function is called whenever a view is attached to this operator. More...
 
void SetGroundPlane (HPS.Plane in_plane)
 
void SetWalkerHeight (float height)
 
HPS.WalkOperator.Axis UpdatePrimaryUpAxis (HPS.Vector v)
 
 WalkOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 WalkOperator (HPS.MouseButtons in_mouse_trigger)
 
 WalkOperator (HPS.WalkOperator in_that)
 
delegate int WalkOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate void WalkOperatorDelegate_1 (IntPtr cPtr)
 
delegate bool WalkOperatorDelegate_10 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_11 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_12 (IntPtr cPtr, IntPtr in_state)
 
delegate void WalkOperatorDelegate_13 (IntPtr cPtr, IntPtr in_detached_view)
 
delegate HPS.Type WalkOperatorDelegate_14 (IntPtr cPtr)
 
delegate void WalkOperatorDelegate_15 (IntPtr cPtr, IntPtr in_that)
 
delegate bool WalkOperatorDelegate_16 (IntPtr cPtr, IntPtr in_that)
 
delegate bool WalkOperatorDelegate_17 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_18 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_19 (IntPtr cPtr, string in_text)
 
delegate void WalkOperatorDelegate_2 (IntPtr cPtr, IntPtr in_attached_view)
 
delegate void WalkOperatorDelegate_20 (IntPtr cPtr)
 
delegate bool WalkOperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type WalkOperatorDelegate_22 (IntPtr cPtr)
 
delegate bool WalkOperatorDelegate_23 (IntPtr cPtr)
 
delegate void WalkOperatorDelegate_24 (IntPtr cPtr)
 
delegate bool WalkOperatorDelegate_3 (IntPtr cPtr, IntPtr in_event)
 
delegate bool WalkOperatorDelegate_4 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_5 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool WalkOperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
- Public Member Functions inherited from HPS.FlyOperator
 FlyOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 FlyOperator (HPS.MouseButtons in_mouse_trigger)
 
 FlyOperator (HPS.FlyOperator in_that)
 
delegate int FlyOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate bool FlyOperatorDelegate_1 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_10 (IntPtr cPtr, IntPtr in_event)
 
delegate void FlyOperatorDelegate_11 (IntPtr cPtr)
 
delegate void FlyOperatorDelegate_12 (IntPtr cPtr, IntPtr in_attached_view)
 
delegate void FlyOperatorDelegate_13 (IntPtr cPtr, IntPtr in_detached_view)
 
delegate HPS.Type FlyOperatorDelegate_14 (IntPtr cPtr)
 
delegate void FlyOperatorDelegate_15 (IntPtr cPtr, IntPtr in_that)
 
delegate bool FlyOperatorDelegate_16 (IntPtr cPtr, IntPtr in_that)
 
delegate bool FlyOperatorDelegate_17 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_18 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_19 (IntPtr cPtr, string in_text)
 
delegate bool FlyOperatorDelegate_2 (IntPtr cPtr, IntPtr in_state)
 
delegate void FlyOperatorDelegate_20 (IntPtr cPtr)
 
delegate bool FlyOperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type FlyOperatorDelegate_22 (IntPtr cPtr)
 
delegate bool FlyOperatorDelegate_23 (IntPtr cPtr)
 
delegate void FlyOperatorDelegate_24 (IntPtr cPtr)
 
delegate bool FlyOperatorDelegate_3 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_4 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_5 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool FlyOperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
float GetJoystickDeadZone ()
 
float GetKeyboardSensitivity ()
 
float GetLeftJoystickSensitivity ()
 
float GetMouseSensitivity ()
 
float GetRightJoystickSensitivity ()
 
float GetSceneExtents ()
 
void InvertXAxis ()
 
void InvertYAxis ()
 
bool IsXAxisInverted ()
 
bool IsYAxisInverted ()
 
override void OnViewDetached (HPS.View in_detached_view)
 This function is called whenever a view is detached from this operator. More...
 
void SetJoystickDeadZone (float in_dead_zone)
 
void SetKeyboardSensitivity (float in_keyboard_sensitivity)
 
void SetLeftJoystickSensitivity (float in_left_joystick_sensitivity)
 
void SetMouseSensitivity (float in_mouse_sensitivity)
 
void SetRightJoystickSensitivity (float in_right_joystick_sensitivity)
 
- Public Member Functions inherited from HPS.Operator
virtual void Assign (HPS.Operator in_that)
 Assigns the parameter in_that to this operator, resulting in a clone. More...
 
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)
 Tests this operator for equality against the parameter in_that. Same as Operator.operator== More...
 
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...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More...
 
virtual void OnModelDetached ()
 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. More...
 
virtual bool OnTextInput (string in_text)
 
 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 (IntPtr cPtr)
 
delegate void OperatorDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate bool OperatorDelegate_10 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_11 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_12 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_13 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_14 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_15 (IntPtr cPtr, string in_text)
 
delegate bool OperatorDelegate_16 (IntPtr cPtr, IntPtr in_event)
 
delegate void OperatorDelegate_17 (IntPtr cPtr, IntPtr in_attached_view)
 
delegate void OperatorDelegate_18 (IntPtr cPtr, IntPtr in_detached_view)
 
delegate void OperatorDelegate_19 (IntPtr cPtr)
 
delegate bool OperatorDelegate_2 (IntPtr cPtr, IntPtr in_that)
 
delegate void OperatorDelegate_20 (IntPtr cPtr)
 
delegate bool OperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type OperatorDelegate_22 (IntPtr cPtr)
 
delegate bool OperatorDelegate_23 (IntPtr cPtr)
 
delegate void OperatorDelegate_24 (IntPtr cPtr)
 
delegate int OperatorDelegate_3 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate bool OperatorDelegate_4 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_5 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_7 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_8 (IntPtr cPtr, IntPtr in_state)
 
delegate bool OperatorDelegate_9 (IntPtr cPtr, IntPtr in_state)
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 
- Protected Member Functions inherited from HPS.WalkOperator
override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Additional Inherited Members

- Public Types inherited from HPS.WalkOperator
enum  Axis {
  X = 0, Y = 1, Z = 2, Negative_X = 3,
  Negative_Y = 4, Negative_Z = 5
}
 
- Public Types inherited from HPS.Operator
enum  Priority { Low = 0, Default = 1, High = 2 }
 
- Static Public Member Functions inherited from HPS.WalkOperator
static HPS.WalkOperator.Axis GetPrimaryAxis (HPS.Vector v)
 
- 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.Operator
HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Operator
static Dictionary< IntPtr,
Operator
cachedObjects = new Dictionary<IntPtr, Operator>()
 
static Dictionary< IntPtr,
WeakReference > 
cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The SimpleWalkOperator class defines an operator which allows the user to move forward and backwards and rotate while staying snapped to a plane.

Mouse Operation:

Left-button down and move:Dollies the camera forward or backward, or Pans the camera left or right based on the mouse movement direction. The movement velocity changes based on how far the mouse is dragged from the starting point.
Middle-button down and move:Dollies the camera vertically or horizontally based on the mouse movement direction. The movement velocity changes based on how far the mouse is dragged from the starting point.
Shift:With the Shift key down the forward/backward velocity is ten times faster.
Ctrl:With the Ctrl key down the forward/backward velocity is ten times slower, and the left/right velocity is 45% slower.
Mouse wheel:Pans the camera vertically. This will change the tilt direction that the camera is looking, but does not change the direction of forward/backward movement.
Shift + mouse wheel:Increases or decreases the base velocity of Dolly operations.

Touch Operation:

Single Finger DragDollies the camera forward or backward, or Pans the camera left or right based on the touch movement direction. The movement velocity changes based on how far the touch is dragged from the starting point.
Two Finger DragDollies the camera vertically or horizontally based on the touch movement direction. The movement velocity changes based on how far the touch is dragged from the starting point.
Shift:With the Shift key down the forward/backward velocity is ten times faster.
Ctrl:With the Ctrl key down the forward/backward velocity is ten times slower, and the left/right velocity is 45% slower.

Member Function Documentation

bool HPS.SimpleWalkOperator.GetEnableMiddleMouseButtonDolly ( )
inline

This function returns the state of Camera Dolly operations using the middle mouse button. The SimpleWalkOperator has Camera Dolly operations fixed to the middle mouse button by default. To disable this behavior, set this value to false.

Returns
true if middle mouse button Camera Dollying is enabled, false otherwise.
override string HPS.SimpleWalkOperator.GetName ( )
inlinevirtual

Returns the name of the operator.

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.IsMouseTriggered ( HPS.MouseState  in_state)
inlinevirtual

This function overrides the base class implementation to additionally inspect in_state for the middle mouse button state if middle mouse button Camera Dollying is enabled.

Returns
true if the MouseButtons and ModifierKeys are active.

Reimplemented from HPS.Operator.

override bool HPS.SimpleWalkOperator.OnKeyDown ( HPS.KeyboardState  in_state)
inlinevirtual

This function is called whenever HPS receives a KeyboardState event that signals a button was pressed. This operator does not handle key down events.

Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnKeyUp ( HPS.KeyboardState  in_state)
inlinevirtual

This function is called whenever HPS receives a KeyboardState event that signals a button was released. This operator does not handle key up events.

Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.FlyOperator.

override void HPS.SimpleWalkOperator.OnModelAttached ( )
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 from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnMouseDown ( HPS.MouseState  in_state)
inlinevirtual

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.

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

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnMouseEnter ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window.

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.SimpleWalkOperator.OnMouseLeave ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse left the window.

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.SimpleWalkOperator.OnMouseMove ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse moved This function rotates the camera in place and moves forward/back if the left mouse button is down.

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

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnMouseUp ( HPS.MouseState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnMouseWheel ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse wheel moved

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

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnTimerTick ( HPS.TimerTickEvent  in_event)
inlinevirtual

This function is called whenever HPS receives a TimerTickEvent This function moves the camera

Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnTouchDown ( HPS.TouchState  in_state)
inlinevirtual

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 HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnTouchMove ( HPS.TouchState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.FlyOperator.

override bool HPS.SimpleWalkOperator.OnTouchUp ( HPS.TouchState  in_state)
inlinevirtual

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

Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.FlyOperator.

override void HPS.SimpleWalkOperator.OnViewAttached ( HPS.View  in_attached_view)
inlinevirtual

This function is called whenever a view is attached to this operator.

Reimplemented from HPS.FlyOperator.

void HPS.SimpleWalkOperator.SetEnableMiddleMouseButtonDolly ( bool  in_enable)
inline

This function enables or disables Camera Dolly operations using the middle mouse button. The SimpleWalkOperator has Camera Dolly operations fixed to the middle mouse button by default. To disable this behavior, set this value to false.

void HPS.SimpleWalkOperator.SetKeyboardControlKey ( bool  in_state)
inline

This function sets the Control key state in this operator. Call this function from your application to inform the the operator of the Control key state. The Control key decreases the velocities of forward/backward and rotation movements.

Parameters
in_stateThe new state of the Control key.
void HPS.SimpleWalkOperator.SetKeyboardShiftKey ( bool  in_state)
inline

This function sets the Shift key state in this operator. Call this function from your application to inform the the operator of the Shift key state. The Shift key increases the mouse trigger button forward/backward velocity.

Parameters
in_stateThe new state of the Shift key.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_ops/source/cs/HPS.SimpleWalkOperator.cs