DtActuatorComponentDescriptor Class Reference

End User Descriptoon: DtActuatorComponentDescriptor contains parameters common to all actuator component descriptors in VR-Forces. More...

Inheritance diagram for DtActuatorComponentDescriptor:

List of all members.

Public Member Functions
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
	assignment
virtual	~DtActuatorComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	setArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
	Accessor/mutator for myArtPartDescriptorList.
virtual const DtSimArtPartDescriptorList &	artPartDescriptorList () const
	Accessor/mutator for myArtPartDescriptorList.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtActuatorComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtSimArtPartDescriptorList	myArtPartDescriptorList
	Parameter Name: art-part-list Parameter Description: List of articulated parts associated with this actuator.

---

Detailed Description

End User Descriptoon: DtActuatorComponentDescriptor contains parameters common to all actuator component descriptors in VR-Forces.

Developer Description: DtActuatorComponentDescriptor is used to specify actuator components. It derives from DtComponentDescriptor. It adds a DtSimArtPartDescriptorList list of articulating parts that the actuator will model. The DtSimArtPartDescriptorList includes the information needed for VR-Link to represent articulated parts on the network. All actuators must use a DtActuatorComponentDescriptor, even if there are no articulating parts involved.

DtSimArtPartDescriptorList is a DtList of DtSimArtPartDescriptors. The DtSimArtPartDescriptor specifies a part type and a parent part type that are VR-Link articulated part types, a vector that represents where the articulating part is attached (in the parent part's coordinate system), and a DtSimArtPartParamList. The DtSimArtPartParamList is a DtList of the VR-Link articulated part parameter types the part should use. Enumerations for various types of articulated parts can be found in disEnums.h file. DtArtPartType is the type of articulated part that will be attached to the entity or another part like a turret or missile launcher. DtArtParamType describes the different types of parameters an articulated part has that will describe its motion. For example, a DtApAzimuth parameter will specify that the articulated part should rotate around the z axis of the part.

---

Constructor & Destructor Documentation

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor	(	const DtSymbolString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

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

copy constructor

virtual DtActuatorComponentDescriptor::~DtActuatorComponentDescriptor

(

)

[virtual]

destructor

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtActuatorComponentDescriptor& DtActuatorComponentDescriptor::operator=

(

const DtActuatorComponentDescriptor &

orig

)

assignment

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

DtActuatorComponentDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtBallisticGunDescriptor, DtDamageComponentDescriptor, DtAzimuthMountComponentDescriptor, DtDamageAdjudicationComponentDescriptor, DtSurfaceEntityActuatorDescriptor, DtFixedWingActuatorDescriptor, DtLauncherActuatorDescriptor, DtTurretComponentDescriptor, DtElevationMountComponentDescriptor, DtRotaryWingActuatorDescriptor, DtTacticalSmokeActuatorDescriptor, DtMultipleHitDamageActuatorDescriptor, DtWarheadDetonationActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtIndirectFireActuatorDescriptor, DtWeaponActuatorDescriptor, DtAutomotiveActuatorDescriptor, DtSwingingPartActuatorDescriptor, DtGlobalEnvironmentActuatorDescriptor, and DtFallingFromSkyActuatorDescriptor.

virtual DtComponentDescriptor* DtActuatorComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtBallisticGunDescriptor, DtAzimuthMountComponentDescriptor, DtDamageComponentDescriptor, DtDamageAdjudicationComponentDescriptor, DtSurfaceEntityActuatorDescriptor, DtFixedWingActuatorDescriptor, DtLauncherActuatorDescriptor, DtTurretComponentDescriptor, DtElevationMountComponentDescriptor, DtRotaryWingActuatorDescriptor, DtTacticalSmokeActuatorDescriptor, DtMultipleHitDamageActuatorDescriptor, DtWarheadDetonationActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtIndirectFireActuatorDescriptor, DtWeaponActuatorDescriptor, DtAutomotiveActuatorDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, and DtSwingingPartActuatorDescriptor.

virtual void DtActuatorComponentDescriptor::setArtPartDescriptorList

(

const DtSimArtPartDescriptorList &

artPartDescriptorList

)

[virtual]

Accessor/mutator for myArtPartDescriptorList.

virtual const DtSimArtPartDescriptorList& DtActuatorComponentDescriptor::artPartDescriptorList

(

)

const [virtual]

Accessor/mutator for myArtPartDescriptorList.

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

Reimplemented in DtBallisticGunDescriptor, DtDamageComponentDescriptor, DtDamageAdjudicationComponentDescriptor, DtRotaryWingActuatorDescriptor, DtWarheadDetonationActuatorDescriptor, DtAzimuthMountComponentDescriptor, DtElevationMountComponentDescriptor, DtLauncherActuatorDescriptor, DtFixedWingActuatorDescriptor, DtIndirectFireActuatorDescriptor, DtTurretComponentDescriptor, DtMultipleHitDamageActuatorDescriptor, DtWeaponActuatorDescriptor, DtTacticalSmokeActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, DtAutomotiveActuatorDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtSwingingPartActuatorDescriptor, and DtSurfaceEntityActuatorDescriptor.

---

Member Data Documentation

DtSimArtPartDescriptorList DtActuatorComponentDescriptor::myArtPartDescriptorList [protected]

Parameter Name: art-part-list
Parameter Description: List of articulated parts associated with this actuator.

Parameter Default Value:

---

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

• include/vrfobjparam/actCompDesc.h