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

Public Member Functions

override void Dispose ()
 
bool GetEnableMiddleMouseButtonDolly ()
 
override string GetName ()
 
override bool IsMouseTriggered (HPS.MouseState in_state)
 
override bool OnKeyDown (HPS.KeyboardState in_state)
 
override bool OnKeyUp (HPS.KeyboardState in_state)
 
override void OnModelAttached ()
 
override bool OnMouseDown (HPS.MouseState in_state)
 
override bool OnMouseEnter (HPS.MouseState in_state)
 
override bool OnMouseLeave (HPS.MouseState in_state)
 
override bool OnMouseMove (HPS.MouseState in_state)
 
override bool OnMouseUp (HPS.MouseState in_state)
 
override bool OnMouseWheel (HPS.MouseState in_state)
 
override bool OnTimerTick (HPS.TimerTickEvent in_event)
 
override bool OnTouchDown (HPS.TouchState in_state)
 
override bool OnTouchMove (HPS.TouchState in_state)
 
override bool OnTouchUp (HPS.TouchState in_state)
 
override void OnViewAttached (HPS.View in_attached_view)
 
void SetEnableMiddleMouseButtonDolly (bool in_enable)
 
void SetKeyboardControlKey (bool in_state)
 
void SetKeyboardShiftKey (bool in_state)
 
 SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger)
 
 SimpleWalkOperator (HPS.SimpleWalkOperator in_that)
 
- Public Member Functions inherited from HPS.WalkOperator
override void Dispose ()
 
HPS.Plane GetGroundPlane ()
 
override string GetName ()
 
HPS.WalkOperator.Axis GetPrimaryUpAxis ()
 
float GetWalkerHeight ()
 
override void OnModelAttached ()
 
override bool OnTimerTick (HPS.TimerTickEvent in_event)
 
override void OnViewAttached (HPS.View in_attached_view)
 
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)
 
- 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)
 
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)
 
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)
 
void DetachView ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.Operator in_that)
 
HPS.View GetAttachedView ()
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierTrigger ()
 
HPS.MouseButtons GetMouseTrigger ()
 
override HPS.Type ObjectType ()
 
virtual void OnModelDetached ()
 
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 void RemoveCacheItemDelegate (IntPtr cPtr)
 
void SetModifierTrigger (HPS.ModifierKeys in_modifiers)
 
void SetMouseTrigger (HPS.MouseButtons in_buttons)
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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, OperatorcachedObjects = 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.

Member Function Documentation

◆ GetEnableMiddleMouseButtonDolly()

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.

◆ GetName()

override string HPS.SimpleWalkOperator.GetName ( )
inlinevirtual

Returns the name of the operator.

Reimplemented from HPS.FlyOperator.

◆ IsMouseTriggered()

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.

◆ OnKeyDown()

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.

◆ OnKeyUp()

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.

◆ OnModelAttached()

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.

◆ OnMouseDown()

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.

◆ OnMouseEnter()

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.

◆ OnMouseLeave()

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.

◆ OnMouseMove()

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.

◆ OnMouseUp()

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.

◆ OnMouseWheel()

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.

◆ OnTimerTick()

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.

◆ OnTouchDown()

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.

◆ OnTouchMove()

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.

◆ OnTouchUp()

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.

◆ OnViewAttached()

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.

◆ SetEnableMiddleMouseButtonDolly()

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.

◆ SetKeyboardControlKey()

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.

◆ SetKeyboardShiftKey()

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