DtMovingObjectParameters; holds all of the configurable parameters for the DtVrfMovingObjectStateRepository class. More...

Inheritance diagram for DtMovingObjectParameters:

[legend]

List of all members.

Public Member Functions
	DtMovingObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtMovingObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtMovingObjectParameters ()
	destructor
const DtMovingObjectParameters &	operator= (const DtMovingObjectParameters &orig)
	assignment operator
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Should return the type of object this is a parameter block for.
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor)
	Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual void	inheritValuesFromThisType (const DtMovingObjectParameters *benefactor)

virtual bool	canPivot () const
	Accessor/mutator for myCanPivot.
virtual void	setCanPivot (bool newValue)
	Accessor/mutator for myCanPivot.

virtual DtReal	maxPivotSpeed () const
	Accessor/mutator for myMaxPivotSpeed.
virtual void	setMaxPivotSpeed (DtReal maxSpeed)
	Accessor/mutator for myMaxPivotSpeed.

virtual const DtVector &	leftSupport () const
	Accessor/mutator for myLeftSupport.
virtual void	setLeftSupport (const DtVector &newLeftSupport)
	Accessor/mutator for myLeftSupport.

virtual const DtVector &	rightSupport () const
	Accessor/mutator for myRightSupport.
virtual void	setRightSupport (const DtVector &newRightSupport)
	Accessor/mutator for myRightSupport.

virtual const DtVector &	otherSupport () const
	Accessor/mutator for myOtherSupport.
virtual void	setOtherSupport (const DtVector &newOtherSupport)
	Accessor/mutator for myOtherSupport.

virtual DtReal	maxSpeed () const
	Accessor/mutator for myMaxSpeed.
virtual void	setMaxSpeed (DtReal speed)
	Accessor/mutator for myMaxSpeed.

virtual DtReal	maxReverseSpeed () const
	Accessor/mutator for myMaxReverseSpeed.
virtual void	setMaxReverseSpeed (DtReal speed)
	Accessor/mutator for myMaxReverseSpeed.

virtual DtReal	turningRadius () const
	Accessor/mutator for myTurningRadius.
virtual void	setTurningRadius (DtReal turningRadius)
	Accessor/mutator for myTurningRadius.

virtual DtReal	maxSlope () const
	Accessor/mutator for myMaxSlope.
virtual void	setMaxSlope (DtReal slope)
	Accessor/mutator for myMaxSlope.

virtual DtReal	orderedSpeed () const
	Accessor/mutator for myOrderedSpeed.
virtual void	setOrderedSpeed (DtReal speed)
	Accessor/mutator for myOrderedSpeed.

virtual DtReal	maxAcceleration () const
	Accessor/mutator for myMaxAcceleration.
virtual void	setMaxAcceleration (const DtReal maxAcceleration)
	Accessor/mutator for myMaxAcceleration.

virtual DtReal	maxStoppingDeceleration () const
	Accessor/mutator for myMaxStoppingDeceleration.
virtual void	setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
	Accessor/mutator for myMaxStoppingDeceleration.

virtual DtReal	fuelEfficiency () const
	Accessor/mutator for myFuelEfficiency.
virtual void	setFuelEfficiency (const DtReal efficiency)
	Accessor/mutator for myFuelEfficiency.

virtual const DtString &	objectGeometryFile () const
	Accessor/mutator for myObjectGeometryFile.
virtual void	setObjectGeometryFile (const DtFilename &)
	Accessor/mutator for myObjectGeometryFile.

virtual void	setDIGuyCharacterInfo (const DtRwDIGuyCharacterInfo &info)
	Accessor/mutator for #myDIGuyCharacter.
virtual const DtRwDIGuyCharacterInfo &	diGuyCharacterInfo () const
	Accessor/mutator for #myDIGuyCharacter.

virtual void	setMaxDisaggregationDistance (DtReal distance)
	Maximum disaggregation distance in meters.
virtual DtReal	maxDisaggregationDistance () const
	Maximum disaggregation distance in meters.

virtual void	setUsingRailMovement (bool rails)
	Accessor/mutator for myUsingRailMovement.
virtual bool	usingRailMovement () const
	Accessor/mutator for myUsingRailMovement.
Static Public Member Functions
static DtVrfObjectParameters *	creator ()

Protected Member Functions
	DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor. Use clone instead...
	DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
Protected Attributes
DtRwBoolean	myUsingRailMovement
	Parameter Name: using-rail-movement Parameter Description: If true entity will clamp to a route segment using the segment's heading as it's heading and will use the rail movement system to to provide smoother driving.
parameters
These parameters are available for setting in the OPD files. {@
DtRwBoolean	myCanPivot
	Parameter Name: can-pivot Parameter Description: Indicates whether not the entity can pivot to turn.
DtRwReal	myMaxPivotSpeed
	Parameter Name: max-pivot-speed Parameter Description: The maximum rate at which a ground entity can turn in place.
DtRwVector	myLeftSupport
	Parameter Name: left-support Parameter Description: Support contact point in body coordinates.
DtRwVector	myRightSupport
	Parameter Name: right-support Parameter Description: Support contact point in body coordinates.
DtRwVector	myOtherSupport
	Parameter Name: other-support Parameter Description: Support contact point in body coordinates.
DtRwReal	myMaxSpeed
	Parameter Name: max-speed Parameter Description: The top speed of the entity.
DtRwReal	myMaxReverseSpeed
	Parameter Name: max-reverse-speed Parameter Description: The maximum speed at which an entity can move in reverse.
DtRwReal	myTurningRadius
	Parameter Name: turning-radius Parameter Description: Maximum turning radius.
DtRwReal	myMaxSlope
	Parameter Name: max-slope Parameter Description: The maximum slope, at which the entity can still have acceleration >= 0 in its direction of motion.
DtRwReal	myOrderedSpeed
	Parameter Name: ordered-speed Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message.
DtRwReal	myMaxAcceleration
	Parameter Name: max-acceleration Parameter Description: The maximum acceleration rate for the entity.
DtRwReal	myMaxStoppingDeceleration
	Parameter Name: max-deceleration Parameter Description: The maximum (braking) deceleration for the entity.
DtRwReal	myFuelEfficiency
	Parameter Name: fuel-efficiency Parameter Description: The number of meters the entity goes on one liter of fuel.
DtReaderWriterFile	myObjectGeometryFile
	Parameter Name: object-geometry-file Parameter Description: If the object geometry is defined (a polygonal model for the entity comparable to a terrain database), it will be used when entities are embarked to task them to move on the embarked item.
DtRwDIGuyCharacterInfo	myDIGuyCharacterInfo
	Parameter Name: di-guy-character Parameter Description: DI-Guy representation of the entity if any.
DtRwReal	myDisaggregationRange
	Parameter Name: disaggregation-range Parameter Description: Maximimum distance from this type of entity that will trigger a aggregate to disaggregate.

Detailed Description

DtMovingObjectParameters; holds all of the configurable parameters for the DtVrfMovingObjectStateRepository class.

The moving-object-param parameter type is used for objects that are capable of movement, such as individual entities and aggregates.
Parameters include support points, maximum speed, maximum reverse speed, turning radius, maximum slope, ordered speed, maximum acceleration, maximum deceleration, and fuel efficiency. Aggregates are moving objects and have this parameter type. All of the platform-specific parameter types derive from this one.

Examples

Space Entity Repository

Constructor & Destructor Documentation

DtMovingObjectParameters::DtMovingObjectParameters	(	const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

constructor with parameters to set up read/writability correctly

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

virtual DtMovingObjectParameters::~DtMovingObjectParameters ( ) [virtual]

destructor

DtMovingObjectParameters::DtMovingObjectParameters	(	const DtMovingObjectParameters &	orig,
		const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		`[protected]`

copy constructor. Use clone instead...

DtMovingObjectParameters::DtMovingObjectParameters	(	const DtMovingObjectParameters &	orig,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		`[protected]`

Member Function Documentation

const DtMovingObjectParameters& DtMovingObjectParameters::operator= ( const DtMovingObjectParameters & orig )

assignment operator

virtual DtVrfObjectParameters* DtMovingObjectParameters::clone	(	const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const `[virtual]`

Reimplemented from DtVrfObjectParameters.

Reimplemented in DtFixedWingEntityParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtGroundVehicleParameters, DtHumanParameters, DtCulturalFeatureParameters, DtSpaceEntityParameters, DtIndividualLifeFormParameters, DtSubsurfaceEntityParameters, DtSurfaceEntityParameters, and DtMissileParameters.

virtual DtVrfObjectParameters* DtMovingObjectParameters::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const `[virtual]`

Reimplemented from DtVrfObjectParameters.

Reimplemented in DtFixedWingEntityParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtRotaryWingEntityParameters, DtSurfaceEntityParameters, DtHumanParameters, DtMissileParameters, and DtSubsurfaceEntityParameters.

virtual DtString DtMovingObjectParameters::type ( ) const [virtual]

Should return the type of object this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtVrfObjectParameters.

Reimplemented in DtMissileParameters, DtFixedWingEntityParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtSpaceEntityParameters, DtIndividualLifeFormParameters, DtSurfaceEntityParameters, and DtSubsurfaceEntityParameters.

static DtVrfObjectParameters* DtMovingObjectParameters::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 DtVrfObjectParameters.

Reimplemented in DtFixedWingEntityParameters, DtRotaryWingEntityParameters, DtMissileParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtSpaceEntityParameters, DtHumanParameters, DtIndividualLifeFormParameters, DtSubsurfaceEntityParameters, and DtSurfaceEntityParameters.

virtual bool DtMovingObjectParameters::inheritValues ( const DtVrfObjectParameters * benefactor ) [virtual]

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtVrfObjectParameters.

Reimplemented in DtFixedWingEntityParameters, DtHumanParameters, DtRotaryWingEntityParameters, DtAggregateObjectParameters, DtIndividualLifeFormParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtSurfaceEntityParameters, and DtMissileParameters.

virtual void DtMovingObjectParameters::inheritValuesFromThisType ( const DtMovingObjectParameters * benefactor ) [virtual]

virtual bool DtMovingObjectParameters::canPivot ( ) const [virtual]

Accessor/mutator for myCanPivot.

virtual void DtMovingObjectParameters::setCanPivot ( bool newValue ) [virtual]

Accessor/mutator for myCanPivot.

virtual DtReal DtMovingObjectParameters::maxPivotSpeed ( ) const [virtual]

Accessor/mutator for myMaxPivotSpeed.

virtual void DtMovingObjectParameters::setMaxPivotSpeed ( DtReal maxSpeed ) [virtual]

Accessor/mutator for myMaxPivotSpeed.

virtual const DtVector& DtMovingObjectParameters::leftSupport ( ) const [virtual]

Accessor/mutator for myLeftSupport.

virtual void DtMovingObjectParameters::setLeftSupport ( const DtVector & newLeftSupport ) [virtual]

Accessor/mutator for myLeftSupport.

virtual const DtVector& DtMovingObjectParameters::rightSupport ( ) const [virtual]

Accessor/mutator for myRightSupport.

virtual void DtMovingObjectParameters::setRightSupport ( const DtVector & newRightSupport ) [virtual]

Accessor/mutator for myRightSupport.

virtual const DtVector& DtMovingObjectParameters::otherSupport ( ) const [virtual]

Accessor/mutator for myOtherSupport.

virtual void DtMovingObjectParameters::setOtherSupport ( const DtVector & newOtherSupport ) [virtual]

Accessor/mutator for myOtherSupport.

virtual DtReal DtMovingObjectParameters::maxSpeed ( ) const [virtual]

Accessor/mutator for myMaxSpeed.

virtual void DtMovingObjectParameters::setMaxSpeed ( DtReal speed ) [virtual]

Accessor/mutator for myMaxSpeed.

virtual DtReal DtMovingObjectParameters::maxReverseSpeed ( ) const [virtual]

Accessor/mutator for myMaxReverseSpeed.

virtual void DtMovingObjectParameters::setMaxReverseSpeed ( DtReal speed ) [virtual]

Accessor/mutator for myMaxReverseSpeed.

virtual DtReal DtMovingObjectParameters::turningRadius ( ) const [virtual]

Accessor/mutator for myTurningRadius.

virtual void DtMovingObjectParameters::setTurningRadius ( DtReal turningRadius ) [virtual]

Accessor/mutator for myTurningRadius.

virtual DtReal DtMovingObjectParameters::maxSlope ( ) const [virtual]

Accessor/mutator for myMaxSlope.

virtual void DtMovingObjectParameters::setMaxSlope ( DtReal slope ) [virtual]

Accessor/mutator for myMaxSlope.

virtual DtReal DtMovingObjectParameters::orderedSpeed ( ) const [virtual]

Accessor/mutator for myOrderedSpeed.

virtual void DtMovingObjectParameters::setOrderedSpeed ( DtReal speed ) [virtual]

Accessor/mutator for myOrderedSpeed.

virtual DtReal DtMovingObjectParameters::maxAcceleration ( ) const [virtual]

Accessor/mutator for myMaxAcceleration.

virtual void DtMovingObjectParameters::setMaxAcceleration ( const DtReal maxAcceleration ) [virtual]

Accessor/mutator for myMaxAcceleration.

virtual DtReal DtMovingObjectParameters::maxStoppingDeceleration ( ) const [virtual]

Accessor/mutator for myMaxStoppingDeceleration.

virtual void DtMovingObjectParameters::setMaxStoppingDeceleration ( const DtReal maxStoppingDeceleration ) [virtual]

Accessor/mutator for myMaxStoppingDeceleration.

virtual DtReal DtMovingObjectParameters::fuelEfficiency ( ) const [virtual]

Accessor/mutator for myFuelEfficiency.

virtual void DtMovingObjectParameters::setFuelEfficiency ( const DtReal efficiency ) [virtual]

Accessor/mutator for myFuelEfficiency.

virtual const DtString& DtMovingObjectParameters::objectGeometryFile ( ) const [virtual]

Accessor/mutator for myObjectGeometryFile.

virtual void DtMovingObjectParameters::setObjectGeometryFile ( const DtFilename & ) [virtual]

Accessor/mutator for myObjectGeometryFile.

virtual void DtMovingObjectParameters::setDIGuyCharacterInfo ( const DtRwDIGuyCharacterInfo & info ) [virtual]

Accessor/mutator for #myDIGuyCharacter.

virtual const DtRwDIGuyCharacterInfo& DtMovingObjectParameters::diGuyCharacterInfo ( ) const [virtual]

Accessor/mutator for #myDIGuyCharacter.

virtual void DtMovingObjectParameters::setMaxDisaggregationDistance ( DtReal distance ) [virtual]

Maximum disaggregation distance in meters.

virtual DtReal DtMovingObjectParameters::maxDisaggregationDistance ( ) const [virtual]

Maximum disaggregation distance in meters.

virtual void DtMovingObjectParameters::setUsingRailMovement ( bool rails ) [virtual]

Accessor/mutator for myUsingRailMovement.

virtual bool DtMovingObjectParameters::usingRailMovement ( ) const [virtual]

Accessor/mutator for myUsingRailMovement.

Member Data Documentation

DtRwBoolean DtMovingObjectParameters::myCanPivot [protected]

Parameter Name: can-pivot
Parameter Description: Indicates whether not the entity can pivot to turn.

Parameter Default: False

DtRwReal DtMovingObjectParameters::myMaxPivotSpeed [protected]

Parameter Name: max-pivot-speed
Parameter Description: The maximum rate at which a ground entity can turn in place.

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

DtRwVector DtMovingObjectParameters::myLeftSupport [protected]

Parameter Name: left-support
Parameter Description: Support contact point in body coordinates.

Sub-parameter:

offset: Offset, in body coordinates, from the base of the entity for the left support point used to create the support plane. The plane is used to orient the entity with respect to the terrain.
Parameter Default Value: <0.5 -1.0 0.0>
Parameter Units: meters

DtRwVector DtMovingObjectParameters::myRightSupport [protected]

Parameter Name: right-support
Parameter Description: Support contact point in body coordinates.

Sub-parameter:

offset: Offset, in body coordinates, from the base of the entity for the right support point used to create the support plane. The plane is used to orient the entity with respect to the terrain.
Parameter Default Value: <0.5 1.0 0.0>
Parameter Units: meters

DtRwVector DtMovingObjectParameters::myOtherSupport [protected]

Parameter Name: other-support
Parameter Description: Support contact point in body coordinates.

Sub-parameter:

offset: Offset, in body coordinates, from the base of the entity for the third support point used to create the support plane. The plane is used to orient the entity with respect to the terrain.
Parameter Default Value: <-0.2, 0.0 0.0>
Parameter Units: meters

DtRwReal DtMovingObjectParameters::myMaxSpeed [protected]

Parameter Name: max-speed
Parameter Description: The top speed of the entity.

Parameter Default Value: 15.
Parameter Units: meters/second

DtRwReal DtMovingObjectParameters::myMaxReverseSpeed [protected]

Parameter Name: max-reverse-speed
Parameter Description: The maximum speed at which an entity can move in reverse.

Parameter Default Value: 10.
Parameter Units: meters/second

DtRwReal DtMovingObjectParameters::myTurningRadius [protected]

Parameter Name: turning-radius
Parameter Description: Maximum turning radius.

This will be used differently by different movement models, and does not apply to all of them (such as missiles).
Parameter Default Value: 5.
Parameter Units: meters

DtRwReal DtMovingObjectParameters::myMaxSlope [protected]

Parameter Name: max-slope
Parameter Description: The maximum slope, at which the entity can still have acceleration >= 0 in its direction of motion.

Therefore, if a ground vehicle is heading up a hill, as soon as the slope of the hill is greater than the max-slope, it will no longer be able to accelerate up the slope. At best, without any friction or other source of negative acceleration, it will remain at its current speed. If the slope increases, it will start decelerating and even start rolling backwards. If the entity is moving down a hill, the opposite is true.
Parameter Default Value: 1. Parameter Units: radians

DtRwReal DtMovingObjectParameters::myOrderedSpeed [protected]

Parameter Name: ordered-speed
Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message.

Parameter Default Value: 10.
Parameter Units: meters/second

DtRwReal DtMovingObjectParameters::myMaxAcceleration [protected]

Parameter Name: max-acceleration
Parameter Description: The maximum acceleration rate for the entity.

Parameter Default Value: 4.5
Parameter Units: meters/second/second

DtRwReal DtMovingObjectParameters::myMaxStoppingDeceleration [protected]

Parameter Name: max-deceleration
Parameter Description: The maximum (braking) deceleration for the entity.

Parameter Default Value: 4.5
Parameter Units: meters/second/second

DtRwReal DtMovingObjectParameters::myFuelEfficiency [protected]

Parameter Name: fuel-efficiency
Parameter Description: The number of meters the entity goes on one liter of fuel.

A value of 0. indicates we are not modeling fuel consumption (i.e. we will never run out of fuel).
Parameter Default Value: 1000.
Parameter Units: meters/liter

DtReaderWriterFile DtMovingObjectParameters::myObjectGeometryFile [protected]

Parameter Name: object-geometry-file
Parameter Description: If the object geometry is defined (a polygonal model for the entity comparable to a terrain database), it will be used when entities are embarked to task them to move on the embarked item.

If this item is not defined (or cannot be loaded) then entities cannot be tasked once embarked on this item.
Parameter Default Value:

DtRwDIGuyCharacterInfo DtMovingObjectParameters::myDIGuyCharacterInfo [protected]

Parameter Name: di-guy-character
Parameter Description: DI-Guy representation of the entity if any.

Set the DI Guy Character, it's default appearance and animation
Parameter Default Value:

DtRwReal DtMovingObjectParameters::myDisaggregationRange [protected]

Parameter Name: disaggregation-range
Parameter Description: Maximimum distance from this type of entity that will trigger a aggregate to disaggregate.

Parameter Units: meters Parameter Default Value: 1000.0

DtRwBoolean DtMovingObjectParameters::myUsingRailMovement [protected]

Parameter Name: using-rail-movement
Parameter Description: If true entity will clamp to a route segment using the segment's heading as it's heading and will use the rail movement system to to provide smoother driving.

If no segments are available to follow will default to regular movement system. Parameter Units: Parameter Default Value: false

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

include/vrfobjparam/mvObjParams.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation