#include <sprk_ops.h>

Inheritance diagram for HPS::FlyOperator:

Public Member Functions
	FlyOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonRight(), ModifierKeys in_modifier_trigger=ModifierKeys())

float	GetJoystickDeadZone () const

float	GetKeyboardSensitivity () const

float	GetLeftJoystickSensitivity () const

float	GetMouseSensitivity () const

virtual HPS::UTF8	GetName () const

float	GetRightJoystickSensitivity () const

float	GetSceneExtents () const

void	InvertXAxis ()

void	InvertYAxis ()

bool	IsXAxisInverted () const

bool	IsYAxisInverted () const

virtual bool	OnKeyDown (KeyboardState const &in_state)

virtual bool	OnKeyUp (KeyboardState const &in_state)

virtual void	OnModelAttached ()

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 (HPS::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)

virtual void	OnViewAttached (HPS::View const &in_attached_view)

virtual void	OnViewDetached (HPS::View const &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 (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)

HPS::Type	ObjectType () const

virtual void	OnModelDetached ()

virtual bool	OnMouseEnter (MouseState const &in_state)

virtual bool	OnMouseLeave (MouseState const &in_state)

virtual bool	OnTextInput (HPS::UTF8 const &in_text)

	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 Operator &	operator= (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 HPS::Sprocket
	Sprocket (Sprocket &&in_that)

Public Member Functions inherited from HPS::Object
virtual bool	Empty () const

intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Protected Types
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
void	MoveBack (HPS::Point &position, HPS::Point &target, HPS::Vector const &direction)

void	MoveDown (HPS::Point &position, HPS::Point &target, HPS::Vector &up)

void	MoveForward (HPS::Point &position, HPS::Point &target, HPS::Vector const &direction)

void	MoveLeft (HPS::Point &position, HPS::Point &target, HPS::Vector &up)

void	MoveRight (HPS::Point &position, HPS::Point &target, HPS::Vector &up)

void	MoveUp (HPS::Point &position, HPS::Point &target, HPS::Vector &up)

bool	MoveWithTouch (HPS::Point &position, HPS::Point &target, HPS::Vector &up, HPS::Vector const &walking_direction)

void	RotateCommon (HPS::Point const &delta, HPS::Point &position, HPS::Point &target)

bool	RotateScene (HPS::Point &position, HPS::Point &target)

bool	RotateWithTouch (HPS::Point &position, HPS::Point &target)

Protected Attributes
unsigned int	movement_flags

Protected Attributes inherited from HPS::Operator
HPS::ModifierKeys	modifier_trigger

HPS::MouseButtons	mouse_trigger

Additional Inherited Members
Public Types inherited from HPS::Operator
enum	Priority { Low, Default, High }

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Static Public Attributes inherited from HPS::Operator
static const HPS::Type	staticType = HPS::Type::Operator

Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Detailed Description

The FlyOperator class defines an operator which allows the user to accurately move the camera around the scene. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: W: Move camera position and target forward A: Pan camera left S: Move camera position and target forward D: Pan camera right C: Pan camera down Space: Pan camera up
Q: Roll camera left E: Roll camera right Right-button down and move: Rotate camera in place Shift: Walk at double the speed while pressed Ctrl: Walk at half the speed while pressed Mouse Wheel: Increase / Decrease step length Shift + Mouse Wheel: Increase / Decrease field of view Touch-Driven Devices: touch -left side of screen: Pans camera in left or right, moves camera forward or back touch -right side of screen: Rotates camera in place Two-finger touch -right side of screen: Pans camera up or down, rolls camera left or right The movement speed increases as the user drags his fingers away from the initial touch position

Member Function Documentation

◆ GetName()

virtual HPS::UTF8 HPS::FlyOperator::GetName ( ) const

inlinevirtual

Returns the name of the operator.

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator, and HPS::WalkOperator.

◆ OnKeyDown()

virtual bool HPS::FlyOperator::OnKeyDown ( KeyboardState const & in_state )

virtual

This function is called whenever HPS receives a KeyboardState event that signals a button was pressed. This function instructs the operator on which direction to move towards.

Parameters

in_state A KeyboardState object describing the current keyboard state. W: Move camera position and target forward A: Pan camera left S: Move camera position and target forward D: Pan camera right C: Pan camera down Space: Pan camera up
Q: Roll camera left E: Roll camera right Shift: Walk at double the speed while pressed Ctrl: Walk at half the speed while pressed

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnKeyUp()

virtual bool HPS::FlyOperator::OnKeyUp ( KeyboardState const & in_state )

virtual

This function is called whenever HPS receives a KeyboardState event that signals a button was released.

Parameters

in_state A KeyboardState object describing the current keyboard state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnModelAttached()

virtual void HPS::FlyOperator::OnModelAttached ( )

virtual

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::Operator.

Reimplemented in HPS::SimpleWalkOperator, and HPS::WalkOperator.

◆ OnMouseDown()

virtual bool HPS::FlyOperator::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_state A MouseState object describing the current mouse state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnMouseMove()

virtual bool HPS::FlyOperator::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 if the right mouse button is down.

Parameters

in_state A MouseState object describing the current mouse state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnMouseUp()

virtual bool HPS::FlyOperator::OnMouseUp ( MouseState const & in_state )

virtual

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

Parameters

in_state A MouseState object describing the current mouse state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnMouseWheel()

virtual bool HPS::FlyOperator::OnMouseWheel ( MouseState const & in_state )

virtual

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. If shift is pressed this function increases or decreases the camera field of view.

Parameters

in_state A MouseState object describing the current mouse state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnTimerTick()

virtual bool HPS::FlyOperator::OnTimerTick ( HPS::TimerTickEvent const & in_event )

virtual

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

Parameters

in_event A TimerTickEvent object describing the current timer tick.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator, and HPS::WalkOperator.

◆ OnTouchDown()

virtual bool HPS::FlyOperator::OnTouchDown ( TouchState const & in_state )

virtual

This function is called whenever HPS receives a TouchEvent that signals the device was touched. This function starts the operator and computes the position of the starting point.

Parameters

in_state A TouchState object describing the current touch state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnTouchMove()

virtual bool HPS::FlyOperator::OnTouchMove ( TouchState const & in_state )

virtual

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. This function rotates the camera in place.

Parameters

in_state A TouchState object describing the current touch state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnTouchUp()

virtual bool HPS::FlyOperator::OnTouchUp ( TouchState const & in_state )

virtual

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

Parameters

in_state A TouchState object describing the current touch state.

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator.

◆ OnViewAttached()

virtual void HPS::FlyOperator::OnViewAttached ( HPS::View const & in_attached_view )

virtual

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::SimpleWalkOperator, and HPS::WalkOperator.

◆ OnViewDetached()

virtual void HPS::FlyOperator::OnViewDetached ( HPS::View const & in_detached_view )

virtual

This function is called whenever a view is detached from this operator.

Reimplemented from HPS::Operator.

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

include/sprk_ops.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetName()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnModelAttached()

◆ OnMouseDown()

◆ OnMouseMove()

◆ OnMouseUp()

◆ OnMouseWheel()

◆ OnTimerTick()

◆ OnTouchDown()

◆ OnTouchMove()

◆ OnTouchUp()

◆ OnViewAttached()

◆ OnViewDetached()