dtCore::UFOMotionModel Class Reference

A motion model that simulates the action of flying in a UFO. More...

#include <ufomotionmodel.h>

Inheritance diagram for dtCore::UFOMotionModel:

List of all members.

Public Member Functions
	UFOMotionModel (Keyboard *keyboard=NULL, Mouse *mouse=NULL)
	Constructor.
void	SetDefaultMappings (Keyboard *keyboard, Mouse *mouse)
	Sets the input axes to a set of default mappings for mouse and keyboard.
void	SetFlyForwardBackwardAxis (Axis *flyForwardBackwardAxis)
	Sets the axis that moves the target forwards (for positive values) or backwards (for negative values).
Axis *	GetFlyForwardBackwardAxis ()
	Returns the axis that moves the target forwards (for positive values) or backwards (for negative values).
void	SetFlyLeftRightAxis (Axis *flyLeftRightAxis)
	Sets the axis that moves the target left (for negative values) or right (for positive values).
Axis *	GetFlyLeftRightAxis ()
	Returns the axis that moves the target left (for negative values) or right (for positive values).
void	SetFlyUpDownAxis (Axis *flyUpDownAxis)
	Sets the axis that moves the target up (for positive values) or down (for negative values).
Axis *	GetFlyUpDownAxis ()
	Returns the axis that moves the target up (for positive values) or down (for negative values).
void	SetTurnLeftRightAxis (Axis *turnLeftRightAxis)
	Sets the axis that turns the target left (for negative values) or right (for positive values).
Axis *	GetTurnLeftRightAxis ()
	Returns the axis that turns the target left (for negative values) or right (for positive values).
void	SetMaximumFlySpeed (float maximumFlySpeed)
	Sets the maximum fly speed (meters per second).
float	GetMaximumFlySpeed ()
	Returns the maximum fly speed (meters per second).
void	SetMaximumTurnSpeed (float maximumTurnSpeed)
	Sets the maximum turn speed (degrees per second).
float	GetMaximumTurnSpeed ()
	Returns the maximum turn speed (degrees per second).
virtual void	OnMessage (MessageData *data)
	Message handler callback.
Protected Member Functions
virtual	~UFOMotionModel ()
	Destructor.

---

Detailed Description

A motion model that simulates the action of flying in a UFO.

---

Constructor & Destructor Documentation

dtCore::UFOMotionModel::UFOMotionModel	(	Keyboard *	keyboard = NULL,
		Mouse *	mouse = NULL
	)

Constructor.

Parameters:

	keyboard	the keyboard instance, or 0 to avoid creating default input mappings
	mouse	the mouse instance, or 0 to avoid creating default input mappings

dtCore::UFOMotionModel::~UFOMotionModel

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

void dtCore::UFOMotionModel::SetDefaultMappings	(	Keyboard *	keyboard,
		Mouse *	mouse
	)

Sets the input axes to a set of default mappings for mouse and keyboard.

Parameters:

	keyboard	the keyboard instance
	mouse	the mouse instance

void dtCore::UFOMotionModel::SetFlyForwardBackwardAxis

(

Axis *

flyForwardBackwardAxis

)

Sets the axis that moves the target forwards (for positive values) or backwards (for negative values).

Parameters:

flyForwardBackwardAxis

the new forward/backward axis

Axis * dtCore::UFOMotionModel::GetFlyForwardBackwardAxis

(

)

Returns the axis that moves the target forwards (for positive values) or backwards (for negative values).

Returns:

the current forward/backward axis

void dtCore::UFOMotionModel::SetFlyLeftRightAxis

(

Axis *

flyLeftRightAxis

)

Sets the axis that moves the target left (for negative values) or right (for positive values).

Parameters:

flyLeftRightAxis

the new left/right axis

Axis * dtCore::UFOMotionModel::GetFlyLeftRightAxis

(

)

Returns the axis that moves the target left (for negative values) or right (for positive values).

Returns:

the current left/right axis

void dtCore::UFOMotionModel::SetFlyUpDownAxis

(

Axis *

flyUpDownAxis

)

Sets the axis that moves the target up (for positive values) or down (for negative values).

Parameters:

flyUpDownAxis

the new up/down axis

Axis * dtCore::UFOMotionModel::GetFlyUpDownAxis

(

)

Returns the axis that moves the target up (for positive values) or down (for negative values).

Returns:

the current up/down axis

void dtCore::UFOMotionModel::SetTurnLeftRightAxis

(

Axis *

turnLeftRightAxis

)

Sets the axis that turns the target left (for negative values) or right (for positive values).

Parameters:

turnLeftRightAxis

the new turn left/right axis

Axis * dtCore::UFOMotionModel::GetTurnLeftRightAxis

(

)

Returns the axis that turns the target left (for negative values) or right (for positive values).

Returns:

the current turn left/right axis

void dtCore::UFOMotionModel::SetMaximumFlySpeed

(

float

maximumFlySpeed

)

Sets the maximum fly speed (meters per second).

Parameters:

maximumFlySpeed

the new maximum fly speed

float dtCore::UFOMotionModel::GetMaximumFlySpeed

(

)

Returns the maximum fly speed (meters per second).

Returns:

the current maximum fly speed

void dtCore::UFOMotionModel::SetMaximumTurnSpeed

(

float

maximumTurnSpeed

)

Sets the maximum turn speed (degrees per second).

Parameters:

maximumTurnSpeed

the new maximum turn speed

float dtCore::UFOMotionModel::GetMaximumTurnSpeed

(

)

Returns the maximum turn speed (degrees per second).

Returns:

the current maximum turn speed

void dtCore::UFOMotionModel::OnMessage

(

MessageData *

data

)

[virtual]

Message handler callback.

Parameters:

data

the message data

Reimplemented from dtCore::Base.

---