DtHumanJoystickMovementControllerDescriptor Class Reference

DtHumanJoystickMovementControllerDescriptor. More...

Inheritance diagram for DtHumanJoystickMovementControllerDescriptor:

List of all members.

Public Member Functions
	DtHumanJoystickMovementControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtHumanJoystickMovementControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtHumanJoystickMovementControllerDescriptor ()
	destructor
	DtHumanJoystickMovementControllerDescriptor (const DtHumanJoystickMovementControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtHumanJoystickMovementControllerDescriptor &	operator= (const DtHumanJoystickMovementControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of descriptor.
virtual void	setMaxTurningRate (double rate)
	Accessor/mutator for myMaxTurningRate.
virtual double	maxTurningRate () const
virtual void	setDirectionAxis (int axis)
	Accessor/mutator for myDirectionAxis.
virtual int	directionAxis () const
	Accessor/mutator for myDirectionAxis.
virtual void	setInvertDirectionAxis (bool invert)
	Accessor/mutator for myInvertDirectionAxis.
virtual bool	invertDirectionAxis () const
	Accessor/mutator for myInvertDirectionAxis.
virtual void	setSpeedAxis (int axis)
	Accessor/mutator for mySpeedAxis.
virtual int	speedAxis () const
	Accessor/mutator for mySpeedAxis.
virtual void	setInvertSpeedAxis (bool invert)
	Accessor/mutator for myInvertSpeedAxis.
virtual bool	invertSpeedAxis () const
	Accessor/mutator for myInvertSpeedAxis.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtHumanJoystickMovementControllerDescriptor &orig)
	Copy over the parameters.
	DtHumanJoystickMovementControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxTurningRate
	Parameter Name: max-turning-rate Parameter Description: Maximum turning rate of the entity.
DtRwInt	myDirectionAxis
	Parameter Name: joy-direction-axis Parameter Description: Axis used for setting direction of movement Parameter Default Value: 5 .
DtRwBoolean	myInvertDirectionAxis
	Parameter Name: joy-invert-direction-axis Parameter Description: Inversion of the direction axis Parameter Default Value: False .
DtRwInt	mySpeedAxis
	Parameter Name: joy-speed-axis Parameter Description: Axis used for speed Parameter Default Value: 3 .
DtRwBoolean	myInvertSpeedAxis
	Parameter Name: joy-invert-speed-axis Parameter Description: Inversion of the speed axis Parameter Default Value: True .
Static Protected Attributes
static const char	theMaxTurningRateName []
	Constants for reader-writer names.
static const char	theDirectionAxisName []
static const char	theInvertDirectionAxisName []
static const char	theSpeedAxisName []
static const char	theInvertSpeedAxisName []

---

Detailed Description

DtHumanJoystickMovementControllerDescriptor.

class DtHumanJoystickMovementControllerDescriptor:

Instances of DtHumanJoystickMovementControllerDescriptor allow the remapping of the axes used for steering and speed.

---

Constructor & Destructor Documentation

DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtHumanJoystickMovementControllerDescriptor::~DtHumanJoystickMovementControllerDescriptor

(

)

[virtual]

destructor

DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor	(	const DtHumanJoystickMovementControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtHumanJoystickMovementControllerDescriptor& DtHumanJoystickMovementControllerDescriptor::operator=

(

const DtHumanJoystickMovementControllerDescriptor &

orig

)

assignment operator

virtual DtComponentDescriptor* DtHumanJoystickMovementControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual DtString DtHumanJoystickMovementControllerDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

This will be used to create the descriptor read from an mtl file.

Reimplemented from DtComponentDescriptor.

virtual void DtHumanJoystickMovementControllerDescriptor::setMaxTurningRate

(

double

rate

)

[virtual]

Accessor/mutator for myMaxTurningRate.

virtual double DtHumanJoystickMovementControllerDescriptor::maxTurningRate

(

)

const [virtual]

virtual void DtHumanJoystickMovementControllerDescriptor::setDirectionAxis

(

int

axis

)

[virtual]

Accessor/mutator for myDirectionAxis.

virtual int DtHumanJoystickMovementControllerDescriptor::directionAxis

(

)

const [virtual]

Accessor/mutator for myDirectionAxis.

virtual void DtHumanJoystickMovementControllerDescriptor::setInvertDirectionAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertDirectionAxis.

virtual bool DtHumanJoystickMovementControllerDescriptor::invertDirectionAxis

(

)

const [virtual]

Accessor/mutator for myInvertDirectionAxis.

virtual void DtHumanJoystickMovementControllerDescriptor::setSpeedAxis

(

int

axis

)

[virtual]

Accessor/mutator for mySpeedAxis.

virtual int DtHumanJoystickMovementControllerDescriptor::speedAxis

(

)

const [virtual]

Accessor/mutator for mySpeedAxis.

virtual void DtHumanJoystickMovementControllerDescriptor::setInvertSpeedAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertSpeedAxis.

virtual bool DtHumanJoystickMovementControllerDescriptor::invertSpeedAxis

(

)

const [virtual]

Accessor/mutator for myInvertSpeedAxis.

static DtComponentDescriptor* DtHumanJoystickMovementControllerDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

virtual void DtHumanJoystickMovementControllerDescriptor::setDefaults

(

)

[protected, virtual]

set default values;

virtual void DtHumanJoystickMovementControllerDescriptor::copyValues

(

const DtHumanJoystickMovementControllerDescriptor &

orig

)

[protected, virtual]

Copy over the parameters.

---

Member Data Documentation

DtRwReal DtHumanJoystickMovementControllerDescriptor::myMaxTurningRate [protected]

Parameter Name: max-turning-rate
Parameter Description: Maximum turning rate of the entity.

Parameter Default Value: 3.14
Parameter Units: radians/second

DtRwInt DtHumanJoystickMovementControllerDescriptor::myDirectionAxis [protected]

Parameter Name: joy-direction-axis
Parameter Description: Axis used for setting direction of movement
Parameter Default Value: 5
.

DtRwBoolean DtHumanJoystickMovementControllerDescriptor::myInvertDirectionAxis [protected]

Parameter Name: joy-invert-direction-axis
Parameter Description: Inversion of the direction axis
Parameter Default Value: False
.

DtRwInt DtHumanJoystickMovementControllerDescriptor::mySpeedAxis [protected]

Parameter Name: joy-speed-axis
Parameter Description: Axis used for speed
Parameter Default Value: 3
.

DtRwBoolean DtHumanJoystickMovementControllerDescriptor::myInvertSpeedAxis [protected]

Parameter Name: joy-invert-speed-axis
Parameter Description: Inversion of the speed axis
Parameter Default Value: True
.

const char DtHumanJoystickMovementControllerDescriptor::theMaxTurningRateName[] [static, protected]

Constants for reader-writer names.

const char DtHumanJoystickMovementControllerDescriptor::theDirectionAxisName[] [static, protected]

const char DtHumanJoystickMovementControllerDescriptor::theInvertDirectionAxisName[] [static, protected]

const char DtHumanJoystickMovementControllerDescriptor::theSpeedAxisName[] [static, protected]

const char DtHumanJoystickMovementControllerDescriptor::theInvertSpeedAxisName[] [static, protected]

---

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

• include/vrfobjparam/humanJoystickMovementControllerDesc.h