< Home

< Table of Contents

REFERENCE MANUAL

SimpleWalkOperator Class Reference

#include <sprk_ops.h>

Inheritance diagram for SimpleWalkOperator:
WalkOperator FlyOperator Operator Sprocket Object

Public Member Functions

virtual UTF8 GetName () const
 
virtual bool OnKeyDown (KeyboardState const &in_state)
 
virtual bool OnKeyUp (KeyboardState const &in_state)
 
virtual bool OnMouseDown (MouseState const &in_state)
 
virtual bool OnMouseMove (MouseState const &in_state)
 
virtual bool OnMouseUp (MouseState const &in_state)
 
virtual bool OnMouseWheel (MouseState const &in_state)
 
virtual bool OnTimerTick (TimerTickEvent const &in_event)
 
virtual bool OnTouchDown (TouchState const &in_state)
 
virtual bool OnTouchMove (TouchState const &in_state)
 
virtual bool OnTouchUp (TouchState const &in_state)
 
 SimpleWalkOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
- Public Member Functions inherited from WalkOperator
Plane GetGroundPlane ()
 
float GetWalkerHeight ()
 
virtual void OnViewAttached ()
 
void SetGroundPlane (Plane const &in_plane)
 
void SetWalkerHeight (float height)
 
 WalkOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonRight(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
- Public Member Functions inherited from FlyOperator
 FlyOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonRight(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
float GetJoystickDeadZone ()
 
float GetKeyboardSensitivity ()
 
float GetLeftJoystickSensitivity ()
 
float GetMouseSensitivity ()
 
float GetRightJoystickSensitivity ()
 
void InvertXAxis ()
 
void InvertYAxis ()
 
bool IsXAxisInverted ()
 
bool IsYAxisInverted ()
 
virtual void OnModelAttached ()
 
virtual void OnViewDetached ()
 
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 Operator
virtual void Assign (Operator const &in_that)
 
void DetachView ()
 
virtual bool Equals (Operator const &in_that) const
 
View GetAttachedView () const
 
ModifierKeys GetModifierTrigger () const
 
MouseButtons GetMouseTrigger () const
 
virtual bool IsMouseTriggered (MouseState const &in_state)
 
Type ObjectType () const
 
virtual void OnModelDetached ()
 
virtual bool OnMouseEnter (MouseState const &in_state)
 
virtual bool OnMouseLeave (MouseState const &in_state)
 
 Operator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
 
 Operator (Operator const &in_that)
 
virtual bool operator!= (Operator const &in_that) const
 
virtual Operatoroperator= (Operator const &in_that)
 
virtual bool operator== (Operator const &in_that) const
 
void SetModifierTrigger (ModifierKeys in_modifiers)
 
void SetMouseTrigger (MouseButtons in_buttons)
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Public Types inherited from Operator
enum  Priority { Low, Normal, High }
 
- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Types inherited from FlyOperator
enum  MovementFlags {
  no_movement = 0x0000, moving_forward = 0x0001, moving_back = 0x0002, moving_left = 0x0004,
  moving_right = 0x0008, moving_up = 0x0010, moving_down = 0x0020, roll_left = 0x0040,
  roll_right = 0x0080, rotating = 0x0100, move_with_touch = 0x0200, rotate_with_touch = 0x0400
}
 
- Protected Member Functions inherited from FlyOperator
void MoveBack (Point &position, Point &target, Vector const &direction)
 
void MoveDown (Point &position, Point &target, Vector &up)
 
void MoveForward (Point &position, Point &target, Vector const &direction)
 
void MoveLeft (Point &position, Point &target, Vector &up)
 
void MoveRight (Point &position, Point &target, Vector &up)
 
void MoveUp (Point &position, Point &target, Vector &up)
 
void MoveWithTouch (Point &position, Point &target, Vector &up, Vector const &walking_direction)
 
void RotateCommon (Point const &delta, Point &position, Point &target)
 
void RotateScene (Point &position, Point &target)
 
void RotateWithTouch (Point &position, Point &target)
 
- Protected Attributes inherited from FlyOperator
unsigned int movement_flags
 
- Protected Attributes inherited from Operator
ModifierKeys modifier_trigger
 
MouseButtons mouse_trigger
 

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

virtual UTF8 SimpleWalkOperator::GetName ( ) const
inlinevirtual

Returns the name of the operator.

Reimplemented from WalkOperator.

virtual bool SimpleWalkOperator::OnKeyDown ( KeyboardState const &  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 FlyOperator.

virtual bool SimpleWalkOperator::OnKeyUp ( KeyboardState const &  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 FlyOperator.

virtual bool SimpleWalkOperator::OnMouseDown ( MouseState const &  in_state)
virtual

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

virtual bool SimpleWalkOperator::OnMouseMove ( MouseState const &  in_state)
virtual

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

virtual bool SimpleWalkOperator::OnMouseUp ( MouseState const &  in_state)
virtual

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

virtual bool SimpleWalkOperator::OnMouseWheel ( MouseState const &  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 FlyOperator.

virtual bool SimpleWalkOperator::OnTimerTick ( TimerTickEvent const &  in_event)
virtual

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

Parameters
in_stateA TimerTickEvent object describing the current timer tick.
Returns
true if the input event was handled, false otherwise.

Reimplemented from WalkOperator.

virtual bool SimpleWalkOperator::OnTouchDown ( TouchState const &  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 FlyOperator.

virtual bool SimpleWalkOperator::OnTouchMove ( TouchState const &  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 FlyOperator.

virtual bool SimpleWalkOperator::OnTouchUp ( TouchState const &  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 FlyOperator.


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