Description: This repository holds all information that is common to all the forms of all objects within VR-Forces that can move. More...

Inheritance diagram for DtVrfMovingObjectStateRepository:

[legend]

List of all members.

Public Member Functions
	DtVrfMovingObjectStateRepository (DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtVrfMovingObjectStateRepository (const DtVrfMovingObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
DtVrfMovingObjectStateRepository &	operator= (const DtVrfMovingObjectStateRepository &orig)
	Assignment Operator.
virtual	~DtVrfMovingObjectStateRepository ()
	Destructor.
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual DtString	type () const
	returns DtSimObjectStateRepositoryType
virtual const int	vrfObjectStateRepositorySubType () const
	Returns DtVrfObjectStateRepositorySubTypeMoving.
virtual const int	vrfMovingObjectStateRepositorySubType () const
	Returns DtVrfMovingObjectStateRepositorySubTypeBase.
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtMovingObjectParameters *	movingObjectParameters () const
virtual bool	canPivot () const
virtual void	setCanPivot (const bool canPivot)
virtual DtReal	maxPivotSpeed () const
virtual void	setMaxPivotSpeed (DtReal maxPivotSpeed)
virtual const DtGroundInteractionPt *	rightSupport () const
	ground contact points
virtual DtGroundInteractionPt *	rightSupport ()
virtual void	setRightSupport (const DtVector &vec)
virtual const DtGroundInteractionPt *	leftSupport () const
virtual DtGroundInteractionPt *	leftSupport ()
virtual void	setLeftSupport (const DtVector &vec)
virtual const DtGroundInteractionPt *	otherSupport () const
virtual DtGroundInteractionPt *	otherSupport ()
virtual void	setOtherSupport (const DtVector &vec)
virtual DtReal	maxSpeed () const
virtual void	setMaxSpeed (const DtReal speed)
virtual DtReal	maxReverseSpeed () const
virtual void	setMaxReverseSpeed (const DtReal speed)
virtual DtReal	turningRadius () const
virtual void	setTurningRadius (const DtReal turningRadius)
virtual DtReal	maxSlope () const
virtual void	setMaxSlope (const DtReal slope)
virtual DtReal	orderedSpeed () const
	Can be set from a parameter file or by the user with a set speed command.
virtual void	setOrderedSpeed (const DtReal speed)
virtual DtReal	maxAcceleration () const
virtual void	setMaxAcceleration (const DtReal maxAcceleration)
virtual DtReal	maxStoppingDeceleration () const
virtual void	setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
virtual DtReal	fuelEfficiency () const
virtual void	setFuelEfficiency (const DtReal fuelEfficiency)
virtual DtReal	inverseStoppingDeceleration () const
	Set by setting maxStoppingDeceleration.
virtual bool	forward () const
virtual void	setForward (const bool forward)
virtual bool	amClampedToGround () const
	Specifies whether we're clamped to the ground or not.
virtual void	setAmClampedToGround (const bool clamp)
virtual bool	usingRailMovement () const
	Specifies the entity's desired movement strategy.
virtual void	setUsingRailMovement (const bool rails)
virtual void	clampToGround (const DtVector &location, const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
	Place entity on ground at location and heading.
virtual void	clampToGround (const DtVector &location, const DtReal heading, bool gravityAligned, bool *dataAvailable=0, bool requireAllData=false)
	Clamps to ground with/without being aligned to gravity.
virtual void	updateSupportPoints (const DtVector &newPosition, const DtReal newHeading)
	When reading in a scenario, want to make sure the support points get set up properly.
virtual DtVector	parentPosition ()
	Returns parentPosition in kinematic state.
virtual void	place (const DtVector &location, bool *dataAvailable=0, bool requireAllData=false)
	Place entity at 'location', on the ground, keeping its current heading.
virtual void	place (const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
	Give entity the specified 'heading', but stay at its current location.
virtual void	place (const DtVector &location, const DtReal heading, bool clampToGroundFlag=true, bool *dataAvailable=0, bool requireAllData=false)
	Place entity at specified 'location' and 'heading'.
virtual void	placeAtAltitude (const DtVector &location, const DtReal heading)
	Places entity at altitude regardless of terrain.
virtual void	setDIGuyCharacterInfo (DtRwDIGuyCharacterInfo *info)
	Current DI-Guy character data--Our character type, current appearance and.
virtual DtRwDIGuyCharacterInfo *	diGuyCharacterInfo ()

virtual void	setDIGuyCharacter (const DtString &character)
	The DI-Guy Character string for this entity.
virtual const DtString &	dIGuyCharacter () const
	The DI-Guy Character string for this entity.

virtual void	setDIGuyAnimation (const DtString &animation)
	The current DI-Guy animation the entity is displaying.
virtual const DtString &	dIGuyAnimation () const
	The current DI-Guy animation the entity is displaying.

virtual void	setDIGuyAppearance (const DtString &app)
	The current Di-Guy character appearance of the entity.
virtual const DtString &	dIGuyAppearance () const
	The current Di-Guy character appearance of the entity.
Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, DtReaderWriterRegistry *parentRegistry)
static DtVrfMovingObjectStateRepository *	isVrfMovingObjectStateRepository (DtSimObjectStateRepository *repository)
static const DtVrfMovingObjectStateRepository *	isVrfMovingObjectStateRepository (const DtSimObjectStateRepository *repository)
Protected Member Functions
	DtVrfMovingObjectStateRepository ()
	Default Constructor. Do not use.
Protected Attributes
DtGroundInteractionPt	myLeftSupport
DtGroundInteractionPt	myRightSupport
DtGroundInteractionPt	myOtherSupport
DtRwReal	myOrderedSpeed
DtRwReal	myMaxSpeed
DtRwReal	myMaxReverseSpeed
DtRwReal	myTurningRadius
DtRwReal	myMaxSlope
DtRwBoolean	myForward
DtRwReal	myMaxAcceleration
DtRwReal	myMaxStoppingDeceleration
DtRwReal	myFuelEfficiency
DtRwBoolean	myCanPivot
DtRwBoolean	myClampToGround
DtRwBoolean	myUsingRailMovement
	If true keeps the entity clamped to the route segment it is on, no steering just follows the segment.
DtRwReal	myMaxPivotSpeed
DtRwDIGuyCharacterInfo *	myDIGuyCharacterInfo
DtReal	myInverseStoppingDeceleration
	Derived quantity (1/myMaxStoppingDeceleration) - no need to make it read-write.

Detailed Description

Description: This repository holds all information that is common to all the forms of all objects within VR-Forces that can move.

Examples

Space Entity Repository

Constructor & Destructor Documentation

DtVrfMovingObjectStateRepository::DtVrfMovingObjectStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Constructor.

DtVrfMovingObjectStateRepository::DtVrfMovingObjectStateRepository	(	const DtVrfMovingObjectStateRepository &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Copy Constructor.

virtual DtVrfMovingObjectStateRepository::~DtVrfMovingObjectStateRepository ( ) [virtual]

Destructor.

DtVrfMovingObjectStateRepository::DtVrfMovingObjectStateRepository ( ) [protected]

Default Constructor. Do not use.

Member Function Documentation

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

Assignment Operator.

static DtVrfObjectStateRepository* DtVrfMovingObjectStateRepository::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		DtReaderWriterRegistry *	parentRegistry
	)		`[static]`

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtMissileStateRepository, DtFixedWingEntityStateRepository, DtHumanStateRepository, DtVrfAggregateStateRepository, DtGroundVehicleStateRepository, DtSpaceEntityStateRepository, DtIndividualLifeFormStateRepository, DtCulturalFeatureStateRepository, DtRotaryWingEntityStateRepository, and DtSurfaceEntityStateRepository.

static DtVrfMovingObjectStateRepository* DtVrfMovingObjectStateRepository::isVrfMovingObjectStateRepository ( DtSimObjectStateRepository * repository ) [static]

static const DtVrfMovingObjectStateRepository* DtVrfMovingObjectStateRepository::isVrfMovingObjectStateRepository ( const DtSimObjectStateRepository * repository ) [static]

virtual DtSimObjectStateRepository* DtVrfMovingObjectStateRepository::clone	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const `[virtual]`

Clone.

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtMissileStateRepository, DtGroundVehicleStateRepository, DtHumanStateRepository, DtCulturalFeatureStateRepository, DtIndividualLifeFormStateRepository, DtVrfAggregateStateRepository, and DtRotaryWingEntityStateRepository.

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

returns DtSimObjectStateRepositoryType

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtMissileStateRepository, DtFixedWingEntityStateRepository, DtGroundVehicleStateRepository, DtSurfaceEntityStateRepository, DtSpaceEntityStateRepository, DtHumanStateRepository, DtCulturalFeatureStateRepository, DtIndividualLifeFormStateRepository, DtVrfAggregateStateRepository, and DtRotaryWingEntityStateRepository.

virtual const int DtVrfMovingObjectStateRepository::vrfObjectStateRepositorySubType ( ) const [virtual]

Returns DtVrfObjectStateRepositorySubTypeMoving.

Reimplemented from DtVrfObjectStateRepository.

virtual const int DtVrfMovingObjectStateRepository::vrfMovingObjectStateRepositorySubType ( ) const [virtual]

Returns DtVrfMovingObjectStateRepositorySubTypeBase.

Reimplemented in DtVrfAggregateStateRepository, DtSurfaceEntityStateRepository, DtMissileStateRepository, DtFixedWingEntityStateRepository, DtGroundVehicleStateRepository, DtHumanStateRepository, DtCulturalFeatureStateRepository, and DtRotaryWingEntityStateRepository.

virtual bool DtVrfMovingObjectStateRepository::createParameters ( ) [virtual]

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtSurfaceEntityStateRepository, DtMissileStateRepository, DtFixedWingEntityStateRepository, DtRotaryWingEntityStateRepository, DtGroundVehicleStateRepository, DtHumanStateRepository, DtSpaceEntityStateRepository, DtCulturalFeatureStateRepository, and DtIndividualLifeFormStateRepository.

virtual void DtVrfMovingObjectStateRepository::initializeFromParameters ( ) [virtual]

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtMissileStateRepository, DtSurfaceEntityStateRepository, DtRotaryWingEntityStateRepository, DtFixedWingEntityStateRepository, DtGroundVehicleStateRepository, DtSpaceEntityStateRepository, DtHumanStateRepository, DtCulturalFeatureStateRepository, and DtIndividualLifeFormStateRepository.

virtual const DtMovingObjectParameters* DtVrfMovingObjectStateRepository::movingObjectParameters ( ) const [virtual]

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

virtual void DtVrfMovingObjectStateRepository::setCanPivot ( const bool canPivot ) [virtual]

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

virtual void DtVrfMovingObjectStateRepository::setMaxPivotSpeed ( DtReal maxPivotSpeed ) [virtual]

virtual const DtGroundInteractionPt* DtVrfMovingObjectStateRepository::rightSupport ( ) const [virtual]

ground contact points

virtual DtGroundInteractionPt* DtVrfMovingObjectStateRepository::rightSupport ( ) [virtual]

virtual void DtVrfMovingObjectStateRepository::setRightSupport ( const DtVector & vec ) [virtual]

virtual const DtGroundInteractionPt* DtVrfMovingObjectStateRepository::leftSupport ( ) const [virtual]

virtual DtGroundInteractionPt* DtVrfMovingObjectStateRepository::leftSupport ( ) [virtual]

virtual void DtVrfMovingObjectStateRepository::setLeftSupport ( const DtVector & vec ) [virtual]

virtual const DtGroundInteractionPt* DtVrfMovingObjectStateRepository::otherSupport ( ) const [virtual]

virtual DtGroundInteractionPt* DtVrfMovingObjectStateRepository::otherSupport ( ) [virtual]

virtual void DtVrfMovingObjectStateRepository::setOtherSupport ( const DtVector & vec ) [virtual]

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

virtual void DtVrfMovingObjectStateRepository::setMaxSpeed ( const DtReal speed ) [virtual]

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

virtual void DtVrfMovingObjectStateRepository::setMaxReverseSpeed ( const DtReal speed ) [virtual]

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

virtual void DtVrfMovingObjectStateRepository::setTurningRadius ( const DtReal turningRadius ) [virtual]

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

virtual void DtVrfMovingObjectStateRepository::setMaxSlope ( const DtReal slope ) [virtual]

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

Can be set from a parameter file or by the user with a set speed command.

virtual void DtVrfMovingObjectStateRepository::setOrderedSpeed ( const DtReal speed ) [virtual]

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

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

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

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

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

virtual void DtVrfMovingObjectStateRepository::setFuelEfficiency ( const DtReal fuelEfficiency ) [virtual]

virtual DtReal DtVrfMovingObjectStateRepository::inverseStoppingDeceleration ( ) const [virtual]

Set by setting maxStoppingDeceleration.

virtual bool DtVrfMovingObjectStateRepository::forward ( ) const [virtual]

virtual void DtVrfMovingObjectStateRepository::setForward ( const bool forward ) [virtual]

virtual bool DtVrfMovingObjectStateRepository::amClampedToGround ( ) const [virtual]

Specifies whether we're clamped to the ground or not.

virtual void DtVrfMovingObjectStateRepository::setAmClampedToGround ( const bool clamp ) [virtual]

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

Specifies the entity's desired movement strategy.

If using rails will keep the entity clamped to the route segment with it's heading parallel to the segment. If the segment has lanes will respect rules of the road.

virtual void DtVrfMovingObjectStateRepository::setUsingRailMovement ( const bool rails ) [virtual]

virtual void DtVrfMovingObjectStateRepository::clampToGround	(	const DtVector &	location,
		const DtReal	heading,
		bool *	dataAvailable = `0`,
		bool	requireAllData = `false`
	)		`[virtual]`

Place entity on ground at location and heading.

Calls clampToGround with gravity of false. The dataAvailable flag will be passed on to DtVrfObjectStateRepository::placePoints and will prevent the call from blocking but will return a fake result based on the entity's current altitude. See DtVrfObjectStateRepository::placePoints for more information. If dataAvailable is set and requireAllData is true, when the result of any terrain intersection causes dataAvailable to be set to false no changes will be made to the object.

Reimplemented in DtRotaryWingEntityStateRepository, and DtHumanStateRepository.

virtual void DtVrfMovingObjectStateRepository::clampToGround	(	const DtVector &	location,
		const DtReal	heading,
		bool	gravityAligned,
		bool *	dataAvailable = `0`,
		bool	requireAllData = `false`
	)		`[virtual]`

Clamps to ground with/without being aligned to gravity.

If aligned with gravity, does not clamp to terrain The dataAvailable flag will be passed on to DtVrfObjectStateRepository::placePoints and will prevent the call from blocking but will return a fake result based on the entity's current altitude. See DtVrfObjectStateRepository::placePoints for more information. If dataAvailable is set and requireAllData is true, when the result of any terrain intersection causes dataAvailable to be set to false no changes will be made to the object.

virtual void DtVrfMovingObjectStateRepository::updateSupportPoints	(	const DtVector &	newPosition,
		const DtReal	newHeading
	)		`[virtual]`

When reading in a scenario, want to make sure the support points get set up properly.

Note that this will make a blocking call to DtVrfObjectStateRepository::placePoints to allow all the necessary parts of the terrain to page in before the scenario load is complete.

Reimplemented from DtVrfObjectStateRepository.

virtual DtVector DtVrfMovingObjectStateRepository::parentPosition ( ) [virtual]

Returns parentPosition in kinematic state.

virtual void DtVrfMovingObjectStateRepository::place	(	const DtVector &	location,
		bool *	dataAvailable = `0`,
		bool	requireAllData = `false`
	)		`[virtual]`

Place entity at 'location', on the ground, keeping its current heading.

The dataAvailable flag will be passed to clampToGround and then on to DtVrfObjectStateRepository::placePoints and will prevent the call from blocking but will return a fake result based on the entity's current altitude. See DtVrfObjectStateRepository::placePoints for more information. If dataAvailable is set and requireAllData is true, when the result of any terrain intersection causes dataAvailable to be set to false no changes will be made to the object.

Reimplemented from DtVrfObjectStateRepository.

virtual void DtVrfMovingObjectStateRepository::place	(	const DtReal	heading,
		bool *	dataAvailable = `0`,
		bool	requireAllData = `false`
	)		`[virtual]`

Give entity the specified 'heading', but stay at its current location.

The dataAvailable flag will be passed to clampToGround and then on to DtVrfObjectStateRepository::placePoints and will prevent the call from blocking but will return a fake result based on the entity's current altitude. See DtVrfObjectStateRepository::placePoints for more information. If dataAvailable is set and requireAllData is true, when the result of any terrain intersection causes dataAvailable to be set to false no changes will be made to the object.

Reimplemented from DtVrfObjectStateRepository.

virtual void DtVrfMovingObjectStateRepository::place	(	const DtVector &	location,
		const DtReal	heading,
		bool	clampToGroundFlag = `true`,
		bool *	dataAvailable = `0`,
		bool	requireAllData = `false`
	)		`[virtual]`

Place entity at specified 'location' and 'heading'.

If clampToGround is true the entity will be clamped to the nearest polygon by calling clampToGround, otherwise placeAtAltitude will be called. The dataAvailable flag will be passed to clampToGround and then on to DtVrfObjectStateRepository::placePoints and will prevent the call from blocking but will return a fake result based on the entity's current altitude. See DtVrfObjectStateRepository::placePoints for more information. If clampToGround is false and placeAtAltitude is called, dataAvailable will be set to true. If dataAvailable is set and requireAllData is true, when the result of any terrain intersection causes dataAvailable to be set to false no changes will be made to the object.

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtFixedWingEntityStateRepository, and DtRotaryWingEntityStateRepository.

virtual void DtVrfMovingObjectStateRepository::placeAtAltitude	(	const DtVector &	location,
		const DtReal	heading
	)		`[virtual]`

Places entity at altitude regardless of terrain.

Reimplemented in DtFixedWingEntityStateRepository.

virtual void DtVrfMovingObjectStateRepository::setDIGuyCharacterInfo ( DtRwDIGuyCharacterInfo * info ) [virtual]

Current DI-Guy character data--Our character type, current appearance and.

current animation the character is performing.

virtual DtRwDIGuyCharacterInfo* DtVrfMovingObjectStateRepository::diGuyCharacterInfo ( ) [virtual]

virtual void DtVrfMovingObjectStateRepository::setDIGuyCharacter ( const DtString & character ) [virtual]

The DI-Guy Character string for this entity.

virtual const DtString& DtVrfMovingObjectStateRepository::dIGuyCharacter ( ) const [virtual]

The DI-Guy Character string for this entity.

virtual void DtVrfMovingObjectStateRepository::setDIGuyAnimation ( const DtString & animation ) [virtual]

The current DI-Guy animation the entity is displaying.

virtual const DtString& DtVrfMovingObjectStateRepository::dIGuyAnimation ( ) const [virtual]

The current DI-Guy animation the entity is displaying.

virtual void DtVrfMovingObjectStateRepository::setDIGuyAppearance ( const DtString & app ) [virtual]

The current Di-Guy character appearance of the entity.

virtual const DtString& DtVrfMovingObjectStateRepository::dIGuyAppearance ( ) const [virtual]

The current Di-Guy character appearance of the entity.

Member Data Documentation

DtGroundInteractionPt DtVrfMovingObjectStateRepository::myLeftSupport [protected]

DtGroundInteractionPt DtVrfMovingObjectStateRepository::myRightSupport [protected]

DtGroundInteractionPt DtVrfMovingObjectStateRepository::myOtherSupport [protected]

DtRwReal DtVrfMovingObjectStateRepository::myOrderedSpeed [protected]

DtRwReal DtVrfMovingObjectStateRepository::myMaxSpeed [protected]

DtRwReal DtVrfMovingObjectStateRepository::myMaxReverseSpeed [protected]

DtRwReal DtVrfMovingObjectStateRepository::myTurningRadius [protected]

DtRwReal DtVrfMovingObjectStateRepository::myMaxSlope [protected]

DtRwBoolean DtVrfMovingObjectStateRepository::myForward [protected]

DtRwReal DtVrfMovingObjectStateRepository::myMaxAcceleration [protected]

DtRwReal DtVrfMovingObjectStateRepository::myMaxStoppingDeceleration [protected]

DtRwReal DtVrfMovingObjectStateRepository::myFuelEfficiency [protected]

DtRwBoolean DtVrfMovingObjectStateRepository::myCanPivot [protected]

DtRwBoolean DtVrfMovingObjectStateRepository::myClampToGround [protected]

DtRwBoolean DtVrfMovingObjectStateRepository::myUsingRailMovement [protected]

If true keeps the entity clamped to the route segment it is on, no steering just follows the segment.

DtRwReal DtVrfMovingObjectStateRepository::myMaxPivotSpeed [protected]

DtRwDIGuyCharacterInfo* DtVrfMovingObjectStateRepository::myDIGuyCharacterInfo [protected]

DtReal DtVrfMovingObjectStateRepository::myInverseStoppingDeceleration [protected]

Derived quantity (1/myMaxStoppingDeceleration) - no need to make it read-write.

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

include/vrfobjcore/vrfMvObjSR.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation