SimpleWalkOperator

class HPS.SimpleWalkOperator : HPS.WalkOperator

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

Public 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.

Return:true if middle mouse button Camera Dollying is enabled, false otherwise.

override string GetName ()

Returns the name of the operator.

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.

Return:true if the MouseButtons and ModifierKeys are active.

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.

Return:true if the input event was handled, false otherwise.

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.

Return:true if the input event was handled, false otherwise.

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.

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.

Param in_state:A MouseState object describing the current mouse state. Return:true if the input event was handled, false otherwise.

override bool OnMouseEnter (HPS.MouseState in_state)

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

Param in_state:A MouseState object describing the current mouse state. Return:true if the input event was handled, false otherwise.

override bool OnMouseLeave (HPS.MouseState in_state)

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

Param in_state:A MouseState object describing the current mouse state. Return:true if the input event was handled, false otherwise.

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.

Param in_state:A MouseState object describing the current mouse state. Return:true if the input event was handled, false otherwise.

override bool OnMouseUp (HPS.MouseState in_state)

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

Param in_state:A MouseState object describing the current mouse state. Return:true if the input event was handled, false otherwise.

override bool OnMouseWheel (HPS.MouseState in_state)

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

Param in_state:A MouseState object describing the current mouse state. Return:true if the input event was handled, false otherwise.

override bool OnTimerTick (HPS.TimerTickEvent in_event)

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

Return:true if the input event was handled, false otherwise.

override bool OnTouchDown (HPS.TouchState in_state)

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

Param in_state:A TouchState object describing the current touch state. Return:true if the input event was handled, false otherwise.

override bool OnTouchMove (HPS.TouchState in_state)

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

Param in_state:A TouchState object describing the current touch state. Return:true if the input event was handled, false otherwise.

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.

Return:true if the input event was handled, false otherwise.

override void OnViewAttached (HPS.View in_attached_view)

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

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.

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.

Param in_state:The new state of the Control key.

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.

Param in_state:The new state of the Shift key.

SimpleWalkOperator ()

SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger)

SimpleWalkOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)

SimpleWalkOperator (HPS.SimpleWalkOperator in_that)