DtSurfaceEntityActuatorDescriptor Class Reference

Contains class declaration for DtSurfaceEntityActuatorDescriptor, descriptor for the DtSurfaceEntityActuator component. More...

Inheritance diagram for DtSurfaceEntityActuatorDescriptor:

List of all members.

Public Member Functions
	DtSurfaceEntityActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtSurfaceEntityActuatorDescriptor (const DtSurfaceEntityActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSurfaceEntityActuatorDescriptor &	operator= (const DtSurfaceEntityActuatorDescriptor &orig)
	assignment
virtual	~DtSurfaceEntityActuatorDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	maxYawRate () const
	Accessor/mutator for myMaxYawRate.
virtual void	setMaxYawRate (DtReal maxYawRate)
	Accessor/mutator for myMaxYawRate.
virtual DtReal	maxYawAcceleration () const
	Accessor/mutator for myMaxYawAcceleration.
virtual void	setMaxYawAcceleration (DtReal maxYawAcceleration)
	Accessor/mutator for myMaxYawAcceleration.
virtual bool	checkSoilType () const
	Accessor/mutator for myCheckSoilType.
virtual void	setCheckSoilType (bool check)
	Accessor/mutator for myCheckSoilType.
virtual double	stoppingSpeed () const
	Accessor/mutator for myStoppingSpeed.
virtual void	setStoppingSpeed (DtReal stoppingSpeed)
	Accessor/mutator for myStoppingSpeed.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtSurfaceEntityActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxYawAcceleration
	Parameter Name: max-yaw-acceleration Parameter Description: This is the maximum rotational acceleration around the entity's body Z axis.
DtRwReal	myMaxYawRate
	Parameter Name: max-yaw-rate Parameter Description: The maximum rate at which the entity can rotate about its body Z axis.
DtRwBoolean	myCheckSoilType
	Parameter Name: check-soil-type Parameter Description: Specifies whether or not the surface entity sould check to see if it is on a water soil type when moving.
DtRwReal	myStoppingSpeed
	Parameter Name: stopping-speed Parameter Description:Returns the speed used by clampSmallVelocityToZero() to determine when to stop drifting ships.

---

Detailed Description

Contains class declaration for DtSurfaceEntityActuatorDescriptor, descriptor for the DtSurfaceEntityActuator component.

A DtActuatorComponentDescriptor that has additional information needed for providing parameters to the kinematics-based ship model.
Used to hold parameters for the DtSurfaceEntityActuator class.

---

Constructor & Destructor Documentation

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

real constructor

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

copy constructor

virtual DtSurfaceEntityActuatorDescriptor::~DtSurfaceEntityActuatorDescriptor

(

)

[virtual]

DtSurfaceEntityActuatorDescriptor::DtSurfaceEntityActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

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

const DtSurfaceEntityActuatorDescriptor& DtSurfaceEntityActuatorDescriptor::operator=

(

const DtSurfaceEntityActuatorDescriptor &

orig

)

assignment

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

DtSurfaceEntityActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtSurfaceEntityActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtSurfaceEntityActuatorDescriptor::maxYawRate

(

)

const [virtual]

Accessor/mutator for myMaxYawRate.

\

virtual void DtSurfaceEntityActuatorDescriptor::setMaxYawRate

(

DtReal

maxYawRate

)

[virtual]

Accessor/mutator for myMaxYawRate.

\

virtual DtReal DtSurfaceEntityActuatorDescriptor::maxYawAcceleration

(

)

const [virtual]

Accessor/mutator for myMaxYawAcceleration.

virtual void DtSurfaceEntityActuatorDescriptor::setMaxYawAcceleration

(

DtReal

maxYawAcceleration

)

[virtual]

Accessor/mutator for myMaxYawAcceleration.

virtual bool DtSurfaceEntityActuatorDescriptor::checkSoilType

(

)

const [virtual]

Accessor/mutator for myCheckSoilType.

virtual void DtSurfaceEntityActuatorDescriptor::setCheckSoilType

(

bool

check

)

[virtual]

Accessor/mutator for myCheckSoilType.

virtual double DtSurfaceEntityActuatorDescriptor::stoppingSpeed

(

)

const [virtual]

Accessor/mutator for myStoppingSpeed.

virtual void DtSurfaceEntityActuatorDescriptor::setStoppingSpeed

(

DtReal

stoppingSpeed

)

[virtual]

Accessor/mutator for myStoppingSpeed.

---

Member Data Documentation

DtRwReal DtSurfaceEntityActuatorDescriptor::myMaxYawAcceleration [protected]

Parameter Name: max-yaw-acceleration
Parameter Description: This is the maximum rotational acceleration around the entity's body Z axis.

Parameter Default Value: 0.
Parameter Units: radians/second/second

DtRwReal DtSurfaceEntityActuatorDescriptor::myMaxYawRate [protected]

Parameter Name: max-yaw-rate
Parameter Description: The maximum rate at which the entity can rotate about its body Z axis.

Parameter Default Value: 0.
Parameter Units: radians/second

DtRwBoolean DtSurfaceEntityActuatorDescriptor::myCheckSoilType [protected]

Parameter Name: check-soil-type
Parameter Description: Specifies whether or not the surface entity sould check to see if it is on a water soil type when moving.

If true, it will not move when it is placed on a non-water polygon on the terrain.
Parameter Default Value: true

DtRwReal DtSurfaceEntityActuatorDescriptor::myStoppingSpeed [protected]

Parameter Name: stopping-speed
Parameter Description:Returns the speed used by clampSmallVelocityToZero() to determine when to stop drifting ships.

The default value is 1.0.
Parameter Default Value: 1.0

---

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

• include/vrfobjparam/surfEntActDesc.h