DtTurretJoyDeviceControllerDescriptor Class Reference

DtTurretJoyDeviceControllerDescriptor; descriptor for the DtGroundJoyTurretController component. More...

Inheritance diagram for DtTurretJoyDeviceControllerDescriptor:

List of all members.

Public Member Functions
	DtTurretJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtTurretJoyDeviceControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtTurretJoyDeviceControllerDescriptor ()
	destructor
	DtTurretJoyDeviceControllerDescriptor (const DtTurretJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtTurretJoyDeviceControllerDescriptor &	operator= (const DtTurretJoyDeviceControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual int	slewAxis () const
	Accessor/mutator for mySlewAxis.
virtual void	setSlewAxis (int axis)
	Accessor/mutator for mySlewAxis.
virtual bool	invertSlewAxis () const
	Accessor/mutator for myInvertSlewAxis.
virtual void	setInvertSlewAxis (bool invert)
	Accessor/mutator for myInvertSlewAxis.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtTurretJoyDeviceControllerDescriptor &orig)
	Copy over the parameters.
	DtTurretJoyDeviceControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	mySlewAxis
	Parameter Name: joy-slew-axis Parameter Description: Axis used for rotation.
DtRwBoolean	myInvertSlewAxis
	Parameter Name: joy-invert-slew-axis Parameter Description: Inversion of the rotation axis.
Static Protected Attributes
static const char	theSlewAxisName []
	Constants for reader-writer names.
static const char	theInvertSlewAxisName []

---

Detailed Description

DtTurretJoyDeviceControllerDescriptor; descriptor for the DtGroundJoyTurretController component.

Instances of DtTurretJoyDeviceControllerDescriptor allow the remapping of the axis used for slewing the turret.

---

Constructor & Destructor Documentation

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

constructor

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

virtual DtTurretJoyDeviceControllerDescriptor::~DtTurretJoyDeviceControllerDescriptor

(

)

[virtual]

destructor

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

copy constructor

DtTurretJoyDeviceControllerDescriptor::DtTurretJoyDeviceControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtTurretJoyDeviceControllerDescriptor& DtTurretJoyDeviceControllerDescriptor::operator=

(

const DtTurretJoyDeviceControllerDescriptor &

orig

)

assignment operator

virtual DtComponentDescriptor* DtTurretJoyDeviceControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtComponentDescriptor.

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

DtTurretJoyDeviceControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual int DtTurretJoyDeviceControllerDescriptor::slewAxis

(

)

const [virtual]

Accessor/mutator for mySlewAxis.

virtual void DtTurretJoyDeviceControllerDescriptor::setSlewAxis

(

int

axis

)

[virtual]

Accessor/mutator for mySlewAxis.

virtual bool DtTurretJoyDeviceControllerDescriptor::invertSlewAxis

(

)

const [virtual]

Accessor/mutator for myInvertSlewAxis.

virtual void DtTurretJoyDeviceControllerDescriptor::setInvertSlewAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertSlewAxis.

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

(

)

[protected, virtual]

set default values;

virtual void DtTurretJoyDeviceControllerDescriptor::copyValues

(

const DtTurretJoyDeviceControllerDescriptor &

orig

)

[protected, virtual]

Copy over the parameters.

---

Member Data Documentation

DtRwInt DtTurretJoyDeviceControllerDescriptor::mySlewAxis [protected]

Parameter Name: joy-slew-axis
Parameter Description: Axis used for rotation.

Parameter Default Value: 0.

DtRwBoolean DtTurretJoyDeviceControllerDescriptor::myInvertSlewAxis [protected]

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

Parameter Default Value: False

const char DtTurretJoyDeviceControllerDescriptor::theSlewAxisName[] [static, protected]

Constants for reader-writer names.

const char DtTurretJoyDeviceControllerDescriptor::theInvertSlewAxisName[] [static, protected]

---

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

• include/vrfobjparam/turretJoystickDesc.h