DtFixedWingJoyDeviceControllerDescriptor Class Reference

DtFixedWingJoyDeviceControllerDescriptor, descriptor for the DtFixedWingJoyFlightController component. More...

Inheritance diagram for DtFixedWingJoyDeviceControllerDescriptor:

List of all members.

Public Member Functions
	DtFixedWingJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtFixedWingJoyDeviceControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtFixedWingJoyDeviceControllerDescriptor ()
	destructor
	DtFixedWingJoyDeviceControllerDescriptor (const DtFixedWingJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtFixedWingJoyDeviceControllerDescriptor &	operator= (const DtFixedWingJoyDeviceControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual int	pitchAxis () const
	Accessor/mutator for myPitchAxis.
virtual void	setPitchAxis (int axis)
	Accessor/mutator for myPitchAxis.
virtual bool	invertPitchAxis () const
	Accessor/mutator for myInvertPitchAxis.
virtual void	setInvertPitchAxis (bool invert)
	Accessor/mutator for myInvertPitchAxis.
virtual int	rollAxis () const
	Accessor/mutator for myRollAxis.
virtual void	setRollAxis (int axis)
	Accessor/mutator for myRollAxis.
virtual bool	invertRollAxis () const
	Accessor/mutator for myInvertRollAxis.
virtual void	setInvertRollAxis (bool invert)
	Accessor/mutator for myInvertRollAxis.
virtual int	throttleAxis () const
	Accessor/mutator for myThrottleAxis.
virtual void	setThrottleAxis (int axis)
	Accessor/mutator for myThrottleAxis.
virtual bool	invertThrottleAxis () const
	Accessor/mutator for myInvertThrottleAxis.
virtual void	setInvertThrottleAxis (bool invert)
	Accessor/mutator for myInvertThrottleAxis.
virtual int	pedalAxis () const
	Accessor/mutator for myPedalAxis.
virtual void	setPedalAxis (int axis)
	Accessor/mutator for myPedalAxis.
virtual bool	invertPedalAxis () const
	Accessor/mutator for myInvertPedalAxis.
virtual void	setInvertPedalAxis (bool invert)
	Accessor/mutator for myInvertPedalAxis.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtFixedWingJoyDeviceControllerDescriptor &orig)
	Copy over the parameters.
	DtFixedWingJoyDeviceControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPitchAxis
	Parameter Name: joy-pitch-axis Parameter Description: Axis used for pitch.
DtRwBoolean	myInvertPitchAxis
	Parameter Name: joy-invert-pitch-axis Parameter Description: Inversion of the pitch axis.
DtRwInt	myRollAxis
	Parameter Name: joy-roll-axis Parameter Description: Axis used for roll.
DtRwBoolean	myInvertRollAxis
	Parameter Name: joy-invert-roll-axis Parameter Description: Inversion of the roll axis.
DtRwInt	myThrottleAxis
	Parameter Name: joy-throttle-axis Parameter Description: Axis used for throttle.
DtRwBoolean	myInvertThrottleAxis
	Parameter Name: joy-invert-throttle-axis Parameter Description: Inversion of the throttle axis.
DtRwInt	myPedalAxis
	Parameter Name: joy-pedal-axis Parameter Description: Axis used for pedal.
DtRwBoolean	myInvertPedalAxis
	Parameter Name: joy-invert-pedal-axis Parameter Description: Inversion of the pedal axis.
Static Protected Attributes
static const char	thePitchAxisName []
static const char	theInvertPitchAxisName []
static const char	theRollAxisName []
static const char	theInvertRollAxisName []
static const char	theThrottleAxisName []
static const char	theInvertThrottleAxisName []
static const char	thePedalAxisName []
static const char	theInvertPedalAxisName []

---

Detailed Description

DtFixedWingJoyDeviceControllerDescriptor, descriptor for the DtFixedWingJoyFlightController component.

Instances of DtFixedWingJoyDeviceControllerDescriptor allow the remapping of the axes used for controlling a fixed wing entity with a joystick.

---

Constructor & Destructor Documentation

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

constructor

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

virtual DtFixedWingJoyDeviceControllerDescriptor::~DtFixedWingJoyDeviceControllerDescriptor

(

)

[virtual]

destructor

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

copy constructor

DtFixedWingJoyDeviceControllerDescriptor::DtFixedWingJoyDeviceControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtFixedWingJoyDeviceControllerDescriptor& DtFixedWingJoyDeviceControllerDescriptor::operator=

(

const DtFixedWingJoyDeviceControllerDescriptor &

orig

)

assignment operator

virtual DtComponentDescriptor* DtFixedWingJoyDeviceControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual DtString DtFixedWingJoyDeviceControllerDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtFixedWingJoyDeviceControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual int DtFixedWingJoyDeviceControllerDescriptor::pitchAxis

(

)

const [virtual]

Accessor/mutator for myPitchAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setPitchAxis

(

int

axis

)

[virtual]

Accessor/mutator for myPitchAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertPitchAxis

(

)

const [virtual]

Accessor/mutator for myInvertPitchAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertPitchAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertPitchAxis.

virtual int DtFixedWingJoyDeviceControllerDescriptor::rollAxis

(

)

const [virtual]

Accessor/mutator for myRollAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setRollAxis

(

int

axis

)

[virtual]

Accessor/mutator for myRollAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertRollAxis

(

)

const [virtual]

Accessor/mutator for myInvertRollAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertRollAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertRollAxis.

virtual int DtFixedWingJoyDeviceControllerDescriptor::throttleAxis

(

)

const [virtual]

Accessor/mutator for myThrottleAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setThrottleAxis

(

int

axis

)

[virtual]

Accessor/mutator for myThrottleAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertThrottleAxis

(

)

const [virtual]

Accessor/mutator for myInvertThrottleAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertThrottleAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertThrottleAxis.

virtual int DtFixedWingJoyDeviceControllerDescriptor::pedalAxis

(

)

const [virtual]

Accessor/mutator for myPedalAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setPedalAxis

(

int

axis

)

[virtual]

Accessor/mutator for myPedalAxis.

virtual bool DtFixedWingJoyDeviceControllerDescriptor::invertPedalAxis

(

)

const [virtual]

Accessor/mutator for myInvertPedalAxis.

virtual void DtFixedWingJoyDeviceControllerDescriptor::setInvertPedalAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertPedalAxis.

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

(

)

[protected, virtual]

set default values;

virtual void DtFixedWingJoyDeviceControllerDescriptor::copyValues

(

const DtFixedWingJoyDeviceControllerDescriptor &

orig

)

[protected, virtual]

Copy over the parameters.

---

Member Data Documentation

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myPitchAxis [protected]

Parameter Name: joy-pitch-axis
Parameter Description: Axis used for pitch.

Parameter Default Value: 1

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertPitchAxis [protected]

Parameter Name: joy-invert-pitch-axis
Parameter Description: Inversion of the pitch axis.

Parameter Default Value: True

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myRollAxis [protected]

Parameter Name: joy-roll-axis
Parameter Description: Axis used for roll.

Parameter Default Value: 0

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertRollAxis [protected]

Parameter Name: joy-invert-roll-axis
Parameter Description: Inversion of the roll axis.

Parameter Default Value: False

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myThrottleAxis [protected]

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

Parameter Default Value: 3

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertThrottleAxis [protected]

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

Parameter Default Value: True

DtRwInt DtFixedWingJoyDeviceControllerDescriptor::myPedalAxis [protected]

Parameter Name: joy-pedal-axis
Parameter Description: Axis used for pedal.

Parameter Default Value: 5

DtRwBoolean DtFixedWingJoyDeviceControllerDescriptor::myInvertPedalAxis [protected]

Parameter Name: joy-invert-pedal-axis
Parameter Description: Inversion of the pedal axis.

Parameter Default Value: False

const char DtFixedWingJoyDeviceControllerDescriptor::thePitchAxisName[] [static, protected]

Constants for reader-writer names

const char DtFixedWingJoyDeviceControllerDescriptor::theInvertPitchAxisName[] [static, protected]

Constants for reader-writer names

const char DtFixedWingJoyDeviceControllerDescriptor::theRollAxisName[] [static, protected]

Constants for reader-writer names

const char DtFixedWingJoyDeviceControllerDescriptor::theInvertRollAxisName[] [static, protected]

Constants for reader-writer names

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

Constants for reader-writer names

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

Constants for reader-writer names

const char DtFixedWingJoyDeviceControllerDescriptor::thePedalAxisName[] [static, protected]

Constants for reader-writer names

const char DtFixedWingJoyDeviceControllerDescriptor::theInvertPedalAxisName[] [static, protected]

Constants for reader-writer names

---

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

• include/vrfobjparam/fixWngJoystickDesc.h