DtRotaryWingJoyDeviceControllerDescriptor Class Reference

DtRotaryWingJoyDeviceControllerDescriptor; descriptor for the DtRotaryWingJoyFlightController component. More...

Inheritance diagram for DtRotaryWingJoyDeviceControllerDescriptor:

List of all members.

Public Member Functions
	DtRotaryWingJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtRotaryWingJoyDeviceControllerDescriptor ()
	destructor
	DtRotaryWingJoyDeviceControllerDescriptor (const DtRotaryWingJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtRotaryWingJoyDeviceControllerDescriptor &	operator= (const DtRotaryWingJoyDeviceControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtReal	riseTime () const
	Accessor for myRiseTime.
virtual DtReal	yawConst () const
	Accessor for myYawConst.
virtual DtReal	pitchConst () const
	Accessor for myPitchConst.
virtual DtReal	rollConst () const
	Accessor for myRollConst.
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	yawAxis () const
	Accessor/mutator for myYawAxis.
virtual void	setYawAxis (int axis)
	Accessor/mutator for myYawAxis.
virtual bool	invertYawAxis () const
	Accessor/mutator for myInvertYawAxis.
virtual void	setInvertYawAxis (bool invert)
	Accessor/mutator for myInvertYawAxis.
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	collectiveAxis () const
	Accessor/mutator for myCollectiveAxis.
virtual void	setCollectiveAxis (int axis)
	Accessor/mutator for myCollectiveAxis.
virtual bool	invertCollectiveAxis () const
	Accessor/mutator for myInvertCollectiveAxis.
virtual void	setInvertCollectiveAxis (bool invert)
	Accessor/mutator for myInvertCollectiveAxis.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
	Set default values.
virtual void	copyValues (const DtRotaryWingJoyDeviceControllerDescriptor &orig)
	Copy over the parameters.
	DtRotaryWingJoyDeviceControllerDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myRiseTime
	Parameter Name: controller-rise-time Parameter Description: Parameter Default Value: 1.5 .
DtRwReal	myYawConst
	Parameter Name: yaw-control-feedback-constant Parameter Description: Parameter Default Value: 2.0 .
DtRwReal	myPitchConst
	Parameter Name: pitch-control-feedback-constant Parameter Description: Parameter Default Value: 1.0 .
DtRwReal	myRollConst
	Parameter Name: roll-control-feedback-constant Parameter Description: Parameter Default Value: 2.2 .
DtRwInt	myPitchAxis
	Parameter Name: joy-pitch-axis Parameter Description: Parameter Default Value: 1 .
DtRwBoolean	myInvertPitchAxis
	Parameter Name: joy-invert-pitch-axis Parameter Description: Parameter Default Value: True .
DtRwInt	myYawAxis
	Parameter Name: joy-yaw-axis Parameter Description: Parameter Default Value: 5 .
DtRwBoolean	myInvertYawAxis
	Parameter Name: joy-invert-yaw-axis Parameter Description: Parameter Default Value: False .
DtRwInt	myRollAxis
	Parameter Name: joy-roll-axis Parameter Description: Parameter Default Value: 0 .
DtRwBoolean	myInvertRollAxis
	Parameter Name: joy-invert-roll-axis Parameter Description: Parameter Default Value: False .
DtRwInt	myCollectiveAxis
	Parameter Name: joy-collective-axis Parameter Description: Parameter Default Value: 3 .
DtRwBoolean	myInvertCollectiveAxis
	Parameter Name: joy-invert-collective-axis Parameter Description: Parameter Default Value: True .
Static Protected Attributes
static const char	thePitchAxisName []
	Constants for reader-writer names.
static const char	theInvertPitchAxisName []
static const char	theRollAxisName []
static const char	theInvertRollAxisName []
static const char	theYawAxisName []
static const char	theInvertYawAxisName []
static const char	theCollectiveAxisName []
static const char	theInvertCollectiveAxisName []

---

Detailed Description

DtRotaryWingJoyDeviceControllerDescriptor; descriptor for the DtRotaryWingJoyFlightController component.

The DtRotaryWingJoyDeviceControllerDescriptor contains parameters that configure joystick control of rotary wing entities.

---

Constructor & Destructor Documentation

DtRotaryWingJoyDeviceControllerDescriptor::DtRotaryWingJoyDeviceControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

virtual DtRotaryWingJoyDeviceControllerDescriptor::~DtRotaryWingJoyDeviceControllerDescriptor

(

)

[virtual]

destructor

DtRotaryWingJoyDeviceControllerDescriptor::DtRotaryWingJoyDeviceControllerDescriptor	(	const DtRotaryWingJoyDeviceControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

DtRotaryWingJoyDeviceControllerDescriptor::DtRotaryWingJoyDeviceControllerDescriptor

(

)

[protected]

default constructor

---

Member Function Documentation

DtRotaryWingJoyDeviceControllerDescriptor& DtRotaryWingJoyDeviceControllerDescriptor::operator=

(

const DtRotaryWingJoyDeviceControllerDescriptor &

orig

)

assignment operator

virtual DtComponentDescriptor* DtRotaryWingJoyDeviceControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

virtual DtString DtRotaryWingJoyDeviceControllerDescriptor::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:

DtRotaryWingJoyDeviceControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtReal DtRotaryWingJoyDeviceControllerDescriptor::riseTime

(

)

const [virtual]

Accessor for myRiseTime.

virtual DtReal DtRotaryWingJoyDeviceControllerDescriptor::yawConst

(

)

const [virtual]

Accessor for myYawConst.

virtual DtReal DtRotaryWingJoyDeviceControllerDescriptor::pitchConst

(

)

const [virtual]

Accessor for myPitchConst.

virtual DtReal DtRotaryWingJoyDeviceControllerDescriptor::rollConst

(

)

const [virtual]

Accessor for myRollConst.

virtual int DtRotaryWingJoyDeviceControllerDescriptor::pitchAxis

(

)

const [virtual]

Accessor/mutator for myPitchAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setPitchAxis

(

int

axis

)

[virtual]

Accessor/mutator for myPitchAxis.

virtual bool DtRotaryWingJoyDeviceControllerDescriptor::invertPitchAxis

(

)

const [virtual]

Accessor/mutator for myInvertPitchAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setInvertPitchAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertPitchAxis.

virtual int DtRotaryWingJoyDeviceControllerDescriptor::yawAxis

(

)

const [virtual]

Accessor/mutator for myYawAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setYawAxis

(

int

axis

)

[virtual]

Accessor/mutator for myYawAxis.

virtual bool DtRotaryWingJoyDeviceControllerDescriptor::invertYawAxis

(

)

const [virtual]

Accessor/mutator for myInvertYawAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setInvertYawAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertYawAxis.

virtual int DtRotaryWingJoyDeviceControllerDescriptor::rollAxis

(

)

const [virtual]

Accessor/mutator for myRollAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setRollAxis

(

int

axis

)

[virtual]

Accessor/mutator for myRollAxis.

virtual bool DtRotaryWingJoyDeviceControllerDescriptor::invertRollAxis

(

)

const [virtual]

Accessor/mutator for myInvertRollAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setInvertRollAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertRollAxis.

virtual int DtRotaryWingJoyDeviceControllerDescriptor::collectiveAxis

(

)

const [virtual]

Accessor/mutator for myCollectiveAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setCollectiveAxis

(

int

axis

)

[virtual]

Accessor/mutator for myCollectiveAxis.

virtual bool DtRotaryWingJoyDeviceControllerDescriptor::invertCollectiveAxis

(

)

const [virtual]

Accessor/mutator for myInvertCollectiveAxis.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::setInvertCollectiveAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertCollectiveAxis.

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

(

)

[protected, virtual]

Set default values.

virtual void DtRotaryWingJoyDeviceControllerDescriptor::copyValues

(

const DtRotaryWingJoyDeviceControllerDescriptor &

orig

)

[protected, virtual]

Copy over the parameters.

---

Member Data Documentation

DtRwReal DtRotaryWingJoyDeviceControllerDescriptor::myRiseTime [protected]

Parameter Name: controller-rise-time
Parameter Description:
Parameter Default Value: 1.5
.

DtRwReal DtRotaryWingJoyDeviceControllerDescriptor::myYawConst [protected]

Parameter Name: yaw-control-feedback-constant
Parameter Description:
Parameter Default Value: 2.0
.

DtRwReal DtRotaryWingJoyDeviceControllerDescriptor::myPitchConst [protected]

Parameter Name: pitch-control-feedback-constant
Parameter Description:
Parameter Default Value: 1.0
.

DtRwReal DtRotaryWingJoyDeviceControllerDescriptor::myRollConst [protected]

Parameter Name: roll-control-feedback-constant
Parameter Description:
Parameter Default Value: 2.2
.

DtRwInt DtRotaryWingJoyDeviceControllerDescriptor::myPitchAxis [protected]

Parameter Name: joy-pitch-axis
Parameter Description:
Parameter Default Value: 1
.

DtRwBoolean DtRotaryWingJoyDeviceControllerDescriptor::myInvertPitchAxis [protected]

Parameter Name: joy-invert-pitch-axis
Parameter Description:
Parameter Default Value: True
.

DtRwInt DtRotaryWingJoyDeviceControllerDescriptor::myYawAxis [protected]

Parameter Name: joy-yaw-axis
Parameter Description:
Parameter Default Value: 5
.

DtRwBoolean DtRotaryWingJoyDeviceControllerDescriptor::myInvertYawAxis [protected]

Parameter Name: joy-invert-yaw-axis
Parameter Description:
Parameter Default Value: False
.

DtRwInt DtRotaryWingJoyDeviceControllerDescriptor::myRollAxis [protected]

Parameter Name: joy-roll-axis
Parameter Description:
Parameter Default Value: 0
.

DtRwBoolean DtRotaryWingJoyDeviceControllerDescriptor::myInvertRollAxis [protected]

Parameter Name: joy-invert-roll-axis
Parameter Description:
Parameter Default Value: False
.

DtRwInt DtRotaryWingJoyDeviceControllerDescriptor::myCollectiveAxis [protected]

Parameter Name: joy-collective-axis
Parameter Description:
Parameter Default Value: 3
.

DtRwBoolean DtRotaryWingJoyDeviceControllerDescriptor::myInvertCollectiveAxis [protected]

Parameter Name: joy-invert-collective-axis
Parameter Description:
Parameter Default Value: True
.

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

Constants for reader-writer names.

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

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

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

const char DtRotaryWingJoyDeviceControllerDescriptor::theYawAxisName[] [static, protected]

const char DtRotaryWingJoyDeviceControllerDescriptor::theInvertYawAxisName[] [static, protected]

const char DtRotaryWingJoyDeviceControllerDescriptor::theCollectiveAxisName[] [static, protected]

const char DtRotaryWingJoyDeviceControllerDescriptor::theInvertCollectiveAxisName[] [static, protected]

---

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

• include/vrfobjparam/rotWngJoyDsc.h