DtGroundJoyDeviceControllerDescriptor Class Reference

DtGroundJoyDeviceControllerDescriptor. More...

Inheritance diagram for DtGroundJoyDeviceControllerDescriptor:

List of all members.

Public Member Functions
	DtGroundJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtGroundJoyDeviceControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtGroundJoyDeviceControllerDescriptor ()
	destructor
	DtGroundJoyDeviceControllerDescriptor (const DtGroundJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtGroundJoyDeviceControllerDescriptor &	operator= (const DtGroundJoyDeviceControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of descriptor.
virtual void	setSteeringAxis (int axis)
	Accessor/mutator for mySteeringAxis.
virtual int	steeringAxis () const
	Accessor/mutator for mySteeringAxis.
virtual void	setInvertSteeringAxis (bool invert)
	Accessor/mutator for myInvertSteeringAxis.
virtual bool	invertSteeringAxis () const
	Accessor/mutator for myInvertSteeringAxis.
virtual void	setThrottleAxis (int axis)
	Accessor/mutator for myThrottleAxis.
virtual int	throttleAxis () const
	Accessor/mutator for myThrottleAxis.
virtual void	setInvertThrottleAxis (bool invert)
	Accessor/mutator for myInvertThrottleAxis.
virtual bool	invertThrottleAxis () const
	Accessor/mutator for myInvertThrottleAxis.
virtual void	setBrakeButton (int button)
	Accessor/mutator for myBrakeButton.
virtual int	brakeButton () const
	Accessor/mutator for myBrakeButton.
virtual void	setForwardGearButton (int button)
	Accessor/mutator for myForwardGearButton.
virtual int	forwardGearButton () const
	Accessor/mutator for myForwardGearButton.
virtual void	setReverseGearButton (int button)
	Accessor/mutator for myReverseGearButton.
virtual int	reverseGearButton () const
	Accessor/mutator for myReverseGearButton.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtGroundJoyDeviceControllerDescriptor &orig)
	Copy over the parameters.
	DtGroundJoyDeviceControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	mySteeringAxis
	Parameter Name: joy-steering-axis Parameter Description: Axis used for steering Parameter Default Value: 5 .
DtRwBoolean	myInvertSteeringAxis
	Parameter Name: joy-invert-steering-axis Parameter Description: Inversion of the steering axis Parameter Default Value: False .
DtRwInt	myThrottleAxis
	Parameter Name: joy-throttle-axis Parameter Description: Axis used for throttle Parameter Default Value: 3 .
DtRwBoolean	myInvertThrottleAxis
	Parameter Name: joy-invert-throttle-axis Parameter Description: Inversion of the throttle axis Parameter Default Value: True .
DtRwInt	myBrakeButton
	Parameter Name: joy-brake-button Parameter Description: Button used for braking Parameter Default Value: 3 .
DtRwInt	myForwardGearButton
	Parameter Name: joy-forward-gear-button Parameter Description: Button used to select forward gear Parameter Default Value: 4 .
DtRwInt	myReverseGearButton
	Parameter Name: joy-reverse-gear-button Parameter Description: Button used to select reverse gear Parameter Default Value: 5 .
Static Protected Attributes
static const char	theSteeringAxisName []
	Constants for reader-writer names.
static const char	theInvertSteeringAxisName []
static const char	theThrottleAxisName []
static const char	theInvertThrottleAxisName []
static const char	theBrakeButtonName []
static const char	theForwardGearButtonName []
static const char	theReverseGearButtonName []

---

Detailed Description

DtGroundJoyDeviceControllerDescriptor.

class DtGroundJoyDeviceControllerDescriptor:

Instances of DtGroundJoyDeviceControllerDescriptor allow the remapping of the axes used for steering and throttle, as well as the buttons used for braking and gear changes.

---

Constructor & Destructor Documentation

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

constructor

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

virtual DtGroundJoyDeviceControllerDescriptor::~DtGroundJoyDeviceControllerDescriptor

(

)

[virtual]

destructor

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

copy constructor

DtGroundJoyDeviceControllerDescriptor::DtGroundJoyDeviceControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtGroundJoyDeviceControllerDescriptor& DtGroundJoyDeviceControllerDescriptor::operator=

(

const DtGroundJoyDeviceControllerDescriptor &

orig

)

assignment operator

virtual DtComponentDescriptor* DtGroundJoyDeviceControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual DtString DtGroundJoyDeviceControllerDescriptor::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 DtGroundJoyDeviceControllerDescriptor::setSteeringAxis

(

int

axis

)

[virtual]

Accessor/mutator for mySteeringAxis.

virtual int DtGroundJoyDeviceControllerDescriptor::steeringAxis

(

)

const [virtual]

Accessor/mutator for mySteeringAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setInvertSteeringAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertSteeringAxis.

virtual bool DtGroundJoyDeviceControllerDescriptor::invertSteeringAxis

(

)

const [virtual]

Accessor/mutator for myInvertSteeringAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setThrottleAxis

(

int

axis

)

[virtual]

Accessor/mutator for myThrottleAxis.

virtual int DtGroundJoyDeviceControllerDescriptor::throttleAxis

(

)

const [virtual]

Accessor/mutator for myThrottleAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setInvertThrottleAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertThrottleAxis.

virtual bool DtGroundJoyDeviceControllerDescriptor::invertThrottleAxis

(

)

const [virtual]

Accessor/mutator for myInvertThrottleAxis.

virtual void DtGroundJoyDeviceControllerDescriptor::setBrakeButton

(

int

button

)

[virtual]

Accessor/mutator for myBrakeButton.

virtual int DtGroundJoyDeviceControllerDescriptor::brakeButton

(

)

const [virtual]

Accessor/mutator for myBrakeButton.

virtual void DtGroundJoyDeviceControllerDescriptor::setForwardGearButton

(

int

button

)

[virtual]

Accessor/mutator for myForwardGearButton.

virtual int DtGroundJoyDeviceControllerDescriptor::forwardGearButton

(

)

const [virtual]

Accessor/mutator for myForwardGearButton.

virtual void DtGroundJoyDeviceControllerDescriptor::setReverseGearButton

(

int

button

)

[virtual]

Accessor/mutator for myReverseGearButton.

virtual int DtGroundJoyDeviceControllerDescriptor::reverseGearButton

(

)

const [virtual]

Accessor/mutator for myReverseGearButton.

static DtComponentDescriptor* DtGroundJoyDeviceControllerDescriptor::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 DtGroundJoyDeviceControllerDescriptor::setDefaults

(

)

[protected, virtual]

set default values;

virtual void DtGroundJoyDeviceControllerDescriptor::copyValues

(

const DtGroundJoyDeviceControllerDescriptor &

orig

)

[protected, virtual]

Copy over the parameters.

---

Member Data Documentation

DtRwInt DtGroundJoyDeviceControllerDescriptor::mySteeringAxis [protected]

Parameter Name: joy-steering-axis
Parameter Description: Axis used for steering
Parameter Default Value: 5
.

DtRwBoolean DtGroundJoyDeviceControllerDescriptor::myInvertSteeringAxis [protected]

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

DtRwInt DtGroundJoyDeviceControllerDescriptor::myThrottleAxis [protected]

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

DtRwBoolean DtGroundJoyDeviceControllerDescriptor::myInvertThrottleAxis [protected]

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

DtRwInt DtGroundJoyDeviceControllerDescriptor::myBrakeButton [protected]

Parameter Name: joy-brake-button
Parameter Description: Button used for braking
Parameter Default Value: 3
.

DtRwInt DtGroundJoyDeviceControllerDescriptor::myForwardGearButton [protected]

Parameter Name: joy-forward-gear-button
Parameter Description: Button used to select forward gear
Parameter Default Value: 4
.

DtRwInt DtGroundJoyDeviceControllerDescriptor::myReverseGearButton [protected]

Parameter Name: joy-reverse-gear-button
Parameter Description: Button used to select reverse gear
Parameter Default Value: 5
.

const char DtGroundJoyDeviceControllerDescriptor::theSteeringAxisName[] [static, protected]

Constants for reader-writer names.

const char DtGroundJoyDeviceControllerDescriptor::theInvertSteeringAxisName[] [static, protected]

const char DtGroundJoyDeviceControllerDescriptor::theThrottleAxisName[] [static, protected]

const char DtGroundJoyDeviceControllerDescriptor::theInvertThrottleAxisName[] [static, protected]

const char DtGroundJoyDeviceControllerDescriptor::theBrakeButtonName[] [static, protected]

const char DtGroundJoyDeviceControllerDescriptor::theForwardGearButtonName[] [static, protected]

const char DtGroundJoyDeviceControllerDescriptor::theReverseGearButtonName[] [static, protected]

---

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

• include/vrfobjparam/gndJoystickDesc.h