< Home

< Table of Contents

REFERENCE MANUAL

HPS.WalkOperator Class Reference

The WalkOperator class defines an operator which allows the user to accurately move the camera around the scene, while snapped to a plane. More...

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

Public Member Functions

override void Dispose ()
 
HPS.Plane GetGroundPlane ()
 
override string GetName ()
 Returns the name of the operator. More...
 
float GetWalkerHeight ()
 
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 ()
 This function is called whenever a view is attached to this operator. More...
 
void SetGroundPlane (HPS.Plane in_plane)
 
void SetWalkerHeight (float height)
 
 WalkOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 WalkOperator (HPS.MouseButtons in_mouse_trigger)
 
delegate int WalkOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str)
 
delegate void WalkOperatorDelegate_1 ()
 
delegate bool WalkOperatorDelegate_10 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_11 (IntPtr in_state)
 
delegate void WalkOperatorDelegate_12 ()
 
delegate void WalkOperatorDelegate_13 ()
 
delegate HPS.Type WalkOperatorDelegate_14 ()
 
delegate void WalkOperatorDelegate_15 (IntPtr in_that)
 
delegate bool WalkOperatorDelegate_16 (IntPtr in_that)
 
delegate bool WalkOperatorDelegate_17 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_18 (IntPtr in_state)
 
delegate void WalkOperatorDelegate_19 ()
 
delegate bool WalkOperatorDelegate_2 (IntPtr in_event)
 
delegate bool WalkOperatorDelegate_20 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_21 ()
 
delegate void WalkOperatorDelegate_22 ()
 
delegate bool WalkOperatorDelegate_3 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_4 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_5 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_6 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_7 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_8 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_9 (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)
 
delegate int FlyOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str)
 
delegate bool FlyOperatorDelegate_1 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_10 (IntPtr in_event)
 
delegate void FlyOperatorDelegate_11 ()
 
delegate void FlyOperatorDelegate_12 ()
 
delegate void FlyOperatorDelegate_13 ()
 
delegate HPS.Type FlyOperatorDelegate_14 ()
 
delegate void FlyOperatorDelegate_15 (IntPtr in_that)
 
delegate bool FlyOperatorDelegate_16 (IntPtr in_that)
 
delegate bool FlyOperatorDelegate_17 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_18 (IntPtr in_state)
 
delegate void FlyOperatorDelegate_19 ()
 
delegate bool FlyOperatorDelegate_2 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_20 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_21 ()
 
delegate void FlyOperatorDelegate_22 ()
 
delegate bool FlyOperatorDelegate_3 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_4 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_5 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_6 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_7 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_8 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_9 (IntPtr in_state)
 
float GetJoystickDeadZone ()
 
float GetKeyboardSensitivity ()
 
float GetLeftJoystickSensitivity ()
 
float GetMouseSensitivity ()
 
float GetRightJoystickSensitivity ()
 
void InvertXAxis ()
 
void InvertYAxis ()
 
bool IsXAxisInverted ()
 
bool IsYAxisInverted ()
 
override bool OnKeyDown (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardState event that signals a button was pressed. More...
 
override bool OnKeyUp (HPS.KeyboardState in_state)
 This function is called whenever HPS receives a KeyboardState event that signals a button was released. More...
 
override void OnModelAttached ()
 This function is called whenever a model is attached to the view that is attached to this 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 rotates the camera in place if the right 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 If shift is not pressed this function increases or decreases the step length. 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 OnViewDetached ()
 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 right_joystick_sensitivity)
 
- 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 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...
 
 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 WalkOperator class defines an operator which allows the user to accurately move the camera around the scene, while snapped to a plane.

This operator works for both mouse and touch-driven devices.

Mouse-driven devices:

WMove camera position and target forward
SMove camera position and target backward
A

Pan camera left

DPan camera right
CPan camera down
spacePan camera up
Right-button down and moveRotate camera in place
ShiftWalk at double the speed while pressed
CtrlWalk at half the speed while pressed
Mouse wheelIncrease / decrease step length
Shift + mouse wheelIncrease / decrease field of view
<h4>Touch devices:</h4>
<table>
   <tr><td class="td-bk">touch left side of screen</td><td class="td-bk">Pans camera in left or right, moves camera forward or back</td></tr>
   <tr><td class="td-bk">touch right side of screen</td><td class="td-bk">Rotates camera in place</td></tr>
   <tr><td class="td-bk">Two-finger touch and move one finger</td><td class="td-bk">Pans camera up or down, rolls camera left or right</td></tr>
</table>
<br>
<p><b>NOTE:</b> The movement speed increases as the user drags his fingers away from the initial touch position</p>

Member Function Documentation

override string HPS.WalkOperator.GetName ( )
virtual

Returns the name of the operator.

Reimplemented from HPS.FlyOperator.

override bool HPS.WalkOperator.OnTimerTick ( HPS.TimerTickEvent  in_event)
virtual

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 void HPS.WalkOperator.OnViewAttached ( )
virtual

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

Reimplemented from HPS.FlyOperator.


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