Overview

Sample Code

Programming Guide

API Reference

Support

HPS.SimpleWalkOperator Class Reference

The SimpleWalkOperator class defines an operator which allows the user to move forward and backwards and rotate while staying snapped to a plane. This Operator works for both mouse-driven devices only. Mouse-Driven Devices: Left-mouse button down and move: Pans the camera forward and backward, or rotates the scene based on the movement direction. The mouse sensitivity changes based on how far the mouse is dragged from the starting point Shift + Mouse Wheel: Increases / Decreases field of view More...

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

Public Member Functions

override void Dispose ()
 
override string GetName ()
 Returns the name of the operator. 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 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 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 This operator does not handle mouse wheel events. 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. This operator does not handle touch down events. 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. This operator does not handle touch move events. 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. This operator does not handle touch up events. More...
 
 SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger)
 
delegate int SimpleWalkOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str)
 
delegate bool SimpleWalkOperatorDelegate_1 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_10 (IntPtr in_event)
 
delegate void SimpleWalkOperatorDelegate_11 ()
 
delegate void SimpleWalkOperatorDelegate_12 ()
 
delegate void SimpleWalkOperatorDelegate_13 ()
 
delegate HPS.Type SimpleWalkOperatorDelegate_14 ()
 
delegate void SimpleWalkOperatorDelegate_15 (IntPtr in_that)
 
delegate bool SimpleWalkOperatorDelegate_16 (IntPtr in_that)
 
delegate bool SimpleWalkOperatorDelegate_17 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_18 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_19 (string in_text)
 
delegate bool SimpleWalkOperatorDelegate_2 (IntPtr in_state)
 
delegate void SimpleWalkOperatorDelegate_20 ()
 
delegate bool SimpleWalkOperatorDelegate_21 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_22 ()
 
delegate void SimpleWalkOperatorDelegate_23 ()
 
delegate bool SimpleWalkOperatorDelegate_3 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_4 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_5 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_6 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_7 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_8 (IntPtr in_state)
 
delegate bool SimpleWalkOperatorDelegate_9 (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...
 
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 ()
 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)
 
 WalkOperator (HPS.WalkOperator in_that)
 
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 bool WalkOperatorDelegate_12 (IntPtr in_state)
 
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 bool WalkOperatorDelegate_19 (string in_text)
 
delegate void WalkOperatorDelegate_2 ()
 
delegate void WalkOperatorDelegate_20 ()
 
delegate bool WalkOperatorDelegate_21 (IntPtr in_state)
 
delegate bool WalkOperatorDelegate_22 ()
 
delegate void WalkOperatorDelegate_23 ()
 
delegate bool WalkOperatorDelegate_3 (IntPtr in_event)
 
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)
 
 FlyOperator (HPS.FlyOperator in_that)
 
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 bool FlyOperatorDelegate_19 (string in_text)
 
delegate bool FlyOperatorDelegate_2 (IntPtr in_state)
 
delegate void FlyOperatorDelegate_20 ()
 
delegate bool FlyOperatorDelegate_21 (IntPtr in_state)
 
delegate bool FlyOperatorDelegate_22 ()
 
delegate void FlyOperatorDelegate_23 ()
 
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 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 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...
 
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. This does not necessarily give the true type of the underlying 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 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 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 ()
 
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 (string in_text)
 
delegate bool OperatorDelegate_16 (IntPtr in_event)
 
delegate void OperatorDelegate_17 ()
 
delegate void OperatorDelegate_18 ()
 
delegate void OperatorDelegate_19 ()
 
delegate bool OperatorDelegate_2 (IntPtr in_that)
 
delegate void OperatorDelegate_20 ()
 
delegate bool OperatorDelegate_21 (IntPtr in_state)
 
delegate bool OperatorDelegate_22 ()
 
delegate void OperatorDelegate_23 ()
 
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. 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...
 
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 IntPtr GetNonDirectorClassID ()
 
- Protected Member Functions inherited from HPS.WalkOperator
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, Default = 1, High = 2 }
 
- 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 SimpleWalkOperator class defines an operator which allows the user to move forward and backwards and rotate while staying snapped to a plane. This Operator works for both mouse-driven devices only. Mouse-Driven Devices: Left-mouse button down and move: Pans the camera forward and backward, or rotates the scene based on the movement direction. The mouse sensitivity changes based on how far the mouse is dragged from the starting point Shift + Mouse Wheel: Increases / Decreases field of view

Member Function Documentation

override string HPS.SimpleWalkOperator.GetName ( )
inlinevirtual

Returns the name of the operator.

Reimplemented from HPS.FlyOperator.

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 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.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 This operator does not handle mouse wheel events.

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. This operator does not handle touch down events.

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. This operator does not handle touch move events.

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. This operator does not handle touch up events.

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

Reimplemented from HPS.FlyOperator.


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