DtBallisticGunJoyControllerDescriptor Class Reference

DtBallisticGunJoyControllerDescriptor; descriptor for the DtAutomotiveActuator component. More...

Inheritance diagram for DtBallisticGunJoyControllerDescriptor:

List of all members.

Public Member Functions
	DtBallisticGunJoyControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBallisticGunJoyControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
virtual	~DtBallisticGunJoyControllerDescriptor ()
	destructor
	DtBallisticGunJoyControllerDescriptor (const DtBallisticGunJoyControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBallisticGunJoyControllerDescriptor &	operator= (const DtBallisticGunJoyControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual int	fireButton () const
	Accessor/mutator for myFireButton.
virtual void	setFireButton (int button)
	Accessor/mutator for myFireButton.
virtual int	changeAmmoButton () const
	Accessor/mutator for myChangeAmmoButton.
virtual void	setChangeAmmoButton (int button)
	Accessor/mutator for myChangeAmmoButton.
virtual int	elevationAxis () const
	Accessor/mutator for myElevationAxis.
virtual void	setElevationAxis (int axis)
	Accessor/mutator for myElevationAxis.
virtual bool	invertElevationAxis () const
	Accessor/mutator for myInvertElevationAxis.
virtual void	setInvertElevationAxis (bool invert)
	Accessor/mutator for myInvertElevationAxis.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtBallisticGunJoyControllerDescriptor &orig)
	Copy over the parameters.
	DtBallisticGunJoyControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myFireButton
	Parameter Name: joy-fire-button Parameter Description: Button used to fire the gun.
DtRwInt	myChangeAmmoButton
	Parameter Name: joy-change-ammo-button Parameter Description: Button used to change the ammo.
DtRwInt	myElevationAxis
	Parameter Name: joy-elevation-axis Parameter Description: Axis used to elevate the gun.
DtRwBoolean	myInvertElevationAxis
	Parameter Name: joy-invert-elevation-axis Parameter Description: Inversion of the axis used to elevate the gun.
Static Protected Attributes
static const char	theFireButtonName []
	Constants for reader-writer names.
static const char	theChangeAmmoButtonName []
	Constants for reader-writer names.
static const char	theElevationAxisName []
	Constants for reader-writer names.
static const char	theInvertElevationAxisName []
	Constants for reader-writer names.

---

Detailed Description

DtBallisticGunJoyControllerDescriptor; descriptor for the DtAutomotiveActuator component.

Instances of DtBallisticGunJoyControllerDescriptor allow the remapping of the buttons used for firing the gun. It also provides for changing the ammo and the axis used to elevate the barrel.

---

Constructor & Destructor Documentation

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

constructor

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

constructor

virtual DtBallisticGunJoyControllerDescriptor::~DtBallisticGunJoyControllerDescriptor

(

)

[virtual]

destructor

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

copy constructor

DtBallisticGunJoyControllerDescriptor::DtBallisticGunJoyControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtBallisticGunJoyControllerDescriptor& DtBallisticGunJoyControllerDescriptor::operator=

(

const DtBallisticGunJoyControllerDescriptor &

orig

)

assignment operator

virtual DtComponentDescriptor* DtBallisticGunJoyControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented from DtBallisticGunControllerDescriptor.

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

DtBallisticGunJoyControllerDescriptorType

Reimplemented from DtBallisticGunControllerDescriptor.

virtual int DtBallisticGunJoyControllerDescriptor::fireButton

(

)

const [virtual]

Accessor/mutator for myFireButton.

virtual void DtBallisticGunJoyControllerDescriptor::setFireButton

(

int

button

)

[virtual]

Accessor/mutator for myFireButton.

virtual int DtBallisticGunJoyControllerDescriptor::changeAmmoButton

(

)

const [virtual]

Accessor/mutator for myChangeAmmoButton.

virtual void DtBallisticGunJoyControllerDescriptor::setChangeAmmoButton

(

int

button

)

[virtual]

Accessor/mutator for myChangeAmmoButton.

virtual int DtBallisticGunJoyControllerDescriptor::elevationAxis

(

)

const [virtual]

Accessor/mutator for myElevationAxis.

virtual void DtBallisticGunJoyControllerDescriptor::setElevationAxis

(

int

axis

)

[virtual]

Accessor/mutator for myElevationAxis.

virtual bool DtBallisticGunJoyControllerDescriptor::invertElevationAxis

(

)

const [virtual]

Accessor/mutator for myInvertElevationAxis.

virtual void DtBallisticGunJoyControllerDescriptor::setInvertElevationAxis

(

bool

invert

)

[virtual]

Accessor/mutator for myInvertElevationAxis.

static DtComponentDescriptor* DtBallisticGunJoyControllerDescriptor::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 DtBallisticGunControllerDescriptor.

virtual void DtBallisticGunJoyControllerDescriptor::setDefaults

(

)

[protected, virtual]

set default values;

virtual void DtBallisticGunJoyControllerDescriptor::copyValues

(

const DtBallisticGunJoyControllerDescriptor &

orig

)

[protected, virtual]

Copy over the parameters.

---

Member Data Documentation

DtRwInt DtBallisticGunJoyControllerDescriptor::myFireButton [protected]

Parameter Name: joy-fire-button
Parameter Description: Button used to fire the gun.

Parameter Default Value: 1

DtRwInt DtBallisticGunJoyControllerDescriptor::myChangeAmmoButton [protected]

Parameter Name: joy-change-ammo-button
Parameter Description: Button used to change the ammo.

Parameter Default Value: 2

DtRwInt DtBallisticGunJoyControllerDescriptor::myElevationAxis [protected]

Parameter Name: joy-elevation-axis
Parameter Description: Axis used to elevate the gun.

Parameter Default Value: 1

DtRwBoolean DtBallisticGunJoyControllerDescriptor::myInvertElevationAxis [protected]

Parameter Name: joy-invert-elevation-axis
Parameter Description: Inversion of the axis used to elevate the gun.

Parameter Default Value: False

const char DtBallisticGunJoyControllerDescriptor::theFireButtonName[] [static, protected]

Constants for reader-writer names.

const char DtBallisticGunJoyControllerDescriptor::theChangeAmmoButtonName[] [static, protected]

Constants for reader-writer names.

const char DtBallisticGunJoyControllerDescriptor::theElevationAxisName[] [static, protected]

Constants for reader-writer names.

const char DtBallisticGunJoyControllerDescriptor::theInvertElevationAxisName[] [static, protected]

Constants for reader-writer names.

---

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

• include/vrfobjparam/balGunJoyCtlDesc.h