DtAutomotiveActuatorDescriptor Class Reference

DtAutomotiveActuatorDescriptor; descriptor for the DtAutomotiveActuatorComponent component. More...

Inheritance diagram for DtAutomotiveActuatorDescriptor:

List of all members.

Public Member Functions
	DtAutomotiveActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtAutomotiveActuatorDescriptor (const DtAutomotiveActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAutomotiveActuatorDescriptor ()
DtAutomotiveActuatorDescriptor &	operator= (const DtAutomotiveActuatorDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	checkForTerrainCollisions () const
	Accessor/mutator for myCheckForTerrainCollisions.
virtual void	setCheckForTerrainCollisions (bool yesOrNo)
	Accessor/mutator for myCheckForTerrainCollisions.
virtual bool	useHighFidelityGroundClamping () const
	Accessor/mutator for myUseHighFidelityGroundClamping.
virtual void	setUseHighFidelityGroundClamping (bool yesOrNo)
	Accessor/mutator for myUseHighFidelityGroundClamping.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtAutomotiveActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myCheckForTerrainCollisions
	Parameter Name: check-terrain-collisions Parameter Description: Specifies whether or not the actuator will check for terrain collisions when moving the entity.
DtRwBoolean	myUseHighFidelityGroundClamping
	Parameter Name: use-high-fidelity-ground-clamping Parameter Description: Specifies whether or not to use all four of the entity's support points when determining the orientation/placement of the entities, or to use just the center support point.

---

Detailed Description

DtAutomotiveActuatorDescriptor; descriptor for the DtAutomotiveActuatorComponent component.

Instances of DtAutomotiveActuatorDescriptor are used to specify the parameters for a DtAutomotiveActuatorComponent object.

---

Constructor & Destructor Documentation

DtAutomotiveActuatorDescriptor::DtAutomotiveActuatorDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

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

copy constructor

virtual DtAutomotiveActuatorDescriptor::~DtAutomotiveActuatorDescriptor

(

)

[virtual]

DtAutomotiveActuatorDescriptor::DtAutomotiveActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtAutomotiveActuatorDescriptor& DtAutomotiveActuatorDescriptor::operator=

(

const DtAutomotiveActuatorDescriptor &

orig

)

assignment

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

DtAutomotiveActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtAutomotiveActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

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

virtual bool DtAutomotiveActuatorDescriptor::checkForTerrainCollisions

(

)

const [virtual]

Accessor/mutator for myCheckForTerrainCollisions.

virtual void DtAutomotiveActuatorDescriptor::setCheckForTerrainCollisions

(

bool

yesOrNo

)

[virtual]

Accessor/mutator for myCheckForTerrainCollisions.

virtual bool DtAutomotiveActuatorDescriptor::useHighFidelityGroundClamping

(

)

const [virtual]

Accessor/mutator for myUseHighFidelityGroundClamping.

virtual void DtAutomotiveActuatorDescriptor::setUseHighFidelityGroundClamping

(

bool

yesOrNo

)

[virtual]

Accessor/mutator for myUseHighFidelityGroundClamping.

---

Member Data Documentation

DtRwBoolean DtAutomotiveActuatorDescriptor::myCheckForTerrainCollisions [protected]

Parameter Name: check-terrain-collisions
Parameter Description: Specifies whether or not the actuator will check for terrain collisions when moving the entity.

If this returns true, then the actuator will not move the entity through terrain.
Parameter Default Value: False

DtRwBoolean DtAutomotiveActuatorDescriptor::myUseHighFidelityGroundClamping [protected]

Parameter Name: use-high-fidelity-ground-clamping
Parameter Description: Specifies whether or not to use all four of the entity's support points when determining the orientation/placement of the entities, or to use just the center support point.

For most entities on most terrains, the single support point is an acceptable trade-off, but the default value is true to ensure more correct behavior in general. For complex terrains, large numbers of ground entities (especially individual platform entities), this can be a noticeable performance improvement.
Parameter Default Value: True

Note:

Implementation Detail: This only affects the placement of entities in the automotive tick() function, when calculating orientation, and does not affect general placement, which is done through the entity state repository.

---

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

• include/vrfobjparam/autoActDesc.h