DtAutomotivePSR Class Reference

Instances of DtAutomotivePSR are used to hold the shared/checkpointable data for an automotive system.

Inheritance diagram for DtAutomotivePSR:

Public Member Functions
	DtAutomotivePSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtAutomotivePSR (const DtAutomotivePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtAutomotivePSR () override
DtAutomotivePSR &	operator= (const DtAutomotivePSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
virtual void	setTurnRadiusForTask (const double r)
virtual double	turnRadiusForTask () const
virtual void	setFinalSpeed (const double s)
virtual double	finalSpeed () const
virtual void	emptyRouteVertices ()
virtual DtLocalVectorIterator *	routeState () const
virtual void	setAccelerationLevel (const DtAutoAccelerationLevel l)
virtual enum DtAutoAccelerationLevel	accelerationLevel () const
virtual void	setFinalSpeedNotSpecified ()
virtual bool	isFinalSpeedSpecified () const
virtual void	setTaskAtDistance (const double d)
virtual double	taskAtDistance () const
virtual void	setTaskAtDistanceUnspecified ()
virtual bool	isTaskAtDistanceSpecified () const
virtual int	currentVertex () const
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) override
virtual void	setGroundMoveToSubtaskId (int id)
virtual int	groundMoveToSubtaskId () const
virtual void	setCurrentGear (DtAutoTransmissionGear gear)
virtual DtAutoTransmissionGear	currentGear () const
virtual void	setHeadingToTurnTo (double headingToTurnTo)
virtual double	headingToTurnTo () const
virtual void	setTurnToMode (int)
virtual int	turnToMode () const
virtual void	setKTurnReverseGoalHeading (double kTurnReverseGoalHeading)
virtual double	kTurnReverseGoalHeading () const
void	setCurrentRouteIndex (int currentRouteIndex)
int	currentRouteIndex () const
virtual void	setKTurnReverseComplete (bool kTurnReverseComplete)
virtual bool	kTurnReverseComplete () const
virtual void	setControlObject (const DtUUID &object)
virtual DtSimObjectReference	controlObject () const
virtual void	setContinueFlag (bool flag)
virtual bool	continueFlag () const
virtual void	setWorldDestination (const DtVector &destination)
virtual const DtVector &	worldDestination () const
virtual void	setEntityToFollow (const DtUUID &objectName)
virtual DtSimObjectReference	entityToFollow () const
virtual void	setFollowingOffsetVector (const DtVector &offsetVector)
virtual const DtVector &	followingOffsetVector () const
virtual void	setRoute (const DtUUID &route)
virtual DtSimObjectReference	route () const
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)
virtual const DtLocalVertexList &	routeVertices () const
virtual void	setReversePatrol (bool flag)
virtual bool	reversePatrol () const
virtual void	setFirstWaypoint (const DtUUID &waypoint)
virtual DtSimObjectReference	firstWaypoint () const
virtual void	setSecondWaypoint (const DtUUID &waypoint)
virtual DtSimObjectReference	secondWaypoint () const
virtual void	setCheckForTerrainCollisions (bool checkForCollisions)
virtual bool	checkForTerrainCollisions () const
virtual void	setUseHighFidelityGroundClamping (bool yesOrNo)
virtual bool	useHighFidelityGroundClamping () const
virtual void	setUseTaskSpeed (const bool value)
virtual bool	useTaskSpeed () const
virtual void	setTaskSpeed (const double value)
virtual double	taskSpeed () const
Used Only in groundCollisionAvoidanceController.
This controller is not used any longer, so these functions are essentially deprecated.
virtual void	setIsCollisionAvoidanceEnabled (bool enabled)
virtual bool	isCollisionAvoidanceEnabled () const
virtual void	setIsColliding (bool colliding)
virtual bool	isColliding () const
virtual void	setIsClearing (bool clearing)
virtual bool	isClearing () const
virtual void	setAvoidingLeft (bool avoidingLeft)
virtual bool	avoidingLeft () const
Deprecated
These functions are no longer used.
virtual bool	intermediateWorldDestinationValid () const
virtual void	invalidateIntermediateWorldDestination ()
virtual void	setIntermediateWorldDestination (const DtVector &destination)
virtual const DtVector &	intermediateWorldDestination () const
virtual void	setRouteIsDiscovered (bool value)
virtual bool	routeIsDiscovered () const
virtual void	setIsUsingBotSteering (const bool b)
virtual bool	isUsingBotSteering () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository () override
virtual bool	init ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwInt	myCurrentRouteIndex
DtRwInt	myCurrentGear
DtRwReal	myHeadingToTurnTo
DtRwReal	myKTurnReverseGoalHeading
DtRwBoolean	myKTurnReverseComplete
DtRwSimObjectReference	myControlObject
DtRwSimObjectReference	myEntityToFollow
DtRwVector	myOffsetVector
DtRwSimObjectReference	myRoute
DtLocalVectorIterator *	myRouteState
DtLocalVertexList	myVertices
DtRwInt	myCurrentVertex
DtRwBoolean	myReverseFlag
DtRwSimObjectReference	myFirstWaypoint
DtRwSimObjectReference	mySecondWaypoint
DtRwBoolean	myIsColliding
DtRwBoolean	myIsClearing
DtRwBoolean	myAvoidingLeft
DtRwVector	myWorldDestination
DtRwVector	myIntermediateWorldDestination
DtRwBoolean	myCheckForTerrainCollisions
DtRwBoolean	myUseHighFidelityGroundClamping
DtRwBoolean	myIsCollisionAvoidanceEnabled
DtRwBoolean	myContinueFlag
DtRwReal	myFinalSpeed
DtRwReal	myTaskAtDistance
DtRwInt	myTurnToMode
DtRwReal	myTurnRadiusForTask
DtRwInt	myAccelerationLevel
DtRwBoolean	myIsUsingBotSteering
DtRwInt	myGroundMoveToSubtaskId
DtRwBoolean	myRouteIsDiscovered
DtRwReal	myTaskSpeed
DtRwBoolean	myUseTaskSpeed
Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtAutomotivePSR::DtAutomotivePSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtAutomotivePSR::~DtAutomotivePSR ( )

overridevirtual

destructor

Member Function Documentation

DtAutomotivePSR& DtAutomotivePSR::operator=

(

const DtAutomotivePSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtAutomotivePSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

overridevirtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAutomotivePSR::type ( ) const

overridevirtual

Returns the string type of the repository, as defined in psrTypes.h. (DtVrfAutomotiveProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtAutomotivePSR::setCurrentGear ( DtAutoTransmissionGear  gear )

virtual

Set/get current gear.

virtual DtAutoTransmissionGear DtAutomotivePSR::currentGear ( ) const

virtual

Set/get current gear.

virtual void DtAutomotivePSR::setHeadingToTurnTo ( double  headingToTurnTo )

virtual

Set/get heading to turn to.

virtual double DtAutomotivePSR::headingToTurnTo ( ) const

virtual

Set/get heading to turn to.

virtual void DtAutomotivePSR::setTurnToMode ( int  )

virtual

Set/get heading turn to mode. See setHeadingRequest.h for modes.

virtual int DtAutomotivePSR::turnToMode ( ) const

virtual

Set/get heading turn to mode. See setHeadingRequest.h for modes.

virtual void DtAutomotivePSR::setTurnRadiusForTask ( const double  r )

virtual

Set/get desired turn radius. This is used only when turning along a prescribed arc, i.e. not doing a K turn. This is either the value set in a task message, or the minimum turn radius of the entity.
The value can be negative, which means that the turn circle is to the left of the entity.

virtual double DtAutomotivePSR::turnRadiusForTask ( ) const

virtual

virtual void DtAutomotivePSR::setKTurnReverseGoalHeading ( double  kTurnReverseGoalHeading )

virtual

Get/Set the heading that is halfway between the original heading and the heading to turn to. This is only used for entities that are not pivot capable.

virtual double DtAutomotivePSR::kTurnReverseGoalHeading ( ) const

virtual

Get/Set the heading that is halfway between the original heading and the heading to turn to. This is only used for entities that are not pivot capable.

void DtAutomotivePSR::setCurrentRouteIndex

(

int

currentRouteIndex

)

Get/Set the index of the route the entity is currently on.

int DtAutomotivePSR::currentRouteIndex

(

)

const

Get/Set the index of the route the entity is currently on.

virtual void DtAutomotivePSR::setKTurnReverseComplete ( bool  kTurnReverseComplete )

virtual

Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading())

virtual bool DtAutomotivePSR::kTurnReverseComplete ( ) const

virtual

Get/set the flag that indicates whether or not the entity has completed first half of the turn maneuver (backing up until at kTurnReverseGoalHeading())

virtual void DtAutomotivePSR::setControlObject ( const DtUUID &  object )

virtual

Get/set the name of the control object to move to (waypoint).Was: setControlObjectName.

virtual DtSimObjectReference DtAutomotivePSR::controlObject ( ) const

virtual

Was: controlObject.

virtual void DtAutomotivePSR::setContinueFlag ( bool  flag )

virtual

Get/set the continue moving flag. If this flag is true the entity will not slow down to the approach speed when it nears the destination. This flag signifies that the entity will continue moving once it's at the destination, presumably the move task was just a subtask part of a more complex movement task like convoying.

virtual bool DtAutomotivePSR::continueFlag ( ) const

virtual

Get/set the continue moving flag. If this flag is true the entity will not slow down to the approach speed when it nears the destination. This flag signifies that the entity will continue moving once it's at the destination, presumably the move task was just a subtask part of a more complex movement task like convoying.

virtual void DtAutomotivePSR::setFinalSpeed ( const double  s )

virtual

If continuing at the end of the move, the desired speed at the end.

virtual double DtAutomotivePSR::finalSpeed ( ) const

virtual

virtual void DtAutomotivePSR::setWorldDestination ( const DtVector &  destination )

virtual

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task. This point is only valid for that task and is set in world (geocentric) coordinates.

virtual const DtVector& DtAutomotivePSR::worldDestination ( ) const

virtual

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task. This point is only valid for that task and is set in world (geocentric) coordinates.

virtual void DtAutomotivePSR::setEntityToFollow ( const DtUUID &  objectName )

virtual

Get/set the name of the entity to follow.

virtual DtSimObjectReference DtAutomotivePSR::entityToFollow ( ) const

virtual

Get/set the name of the entity to follow.

virtual void DtAutomotivePSR::setFollowingOffsetVector ( const DtVector &  offsetVector )

virtual

Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).

virtual const DtVector& DtAutomotivePSR::followingOffsetVector ( ) const

virtual

Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).

virtual void DtAutomotivePSR::setRoute ( const DtUUID &  route )

virtual

Get/set the name of the route to follow.Was: setRouteName.

virtual DtSimObjectReference DtAutomotivePSR::route ( ) const

virtual

Was: routeName.

virtual void DtAutomotivePSR::setRouteVertices ( const DtLocalVectorIterator &  routeIterator )

virtual

Set/get route vertices (local coordinates). Once route is set, can access routeState() to query and set current position along route.

virtual const DtLocalVertexList& DtAutomotivePSR::routeVertices ( ) const

virtual

Set/get route vertices (local coordinates). Once route is set, can access routeState() to query and set current position along route.

virtual void DtAutomotivePSR::emptyRouteVertices ( )

virtual

Empty route vertices.

virtual DtLocalVectorIterator* DtAutomotivePSR::routeState ( ) const

virtual

Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).

virtual void DtAutomotivePSR::setReversePatrol ( bool  flag )

virtual

Get/set the reverse flag for patrolling (along route or between points).

virtual bool DtAutomotivePSR::reversePatrol ( ) const

virtual

Get/set the reverse flag for patrolling (along route or between points).

virtual void DtAutomotivePSR::setFirstWaypoint ( const DtUUID &  waypoint )

virtual

Get/set the first waypoint to move to when patrolling between points.

virtual DtSimObjectReference DtAutomotivePSR::firstWaypoint ( ) const

virtual

Get/set the first waypoint to move to when patrolling between points.

virtual void DtAutomotivePSR::setSecondWaypoint ( const DtUUID &  waypoint )

virtual

Get/set the second waypoint to move to when patrolling between points.

virtual DtSimObjectReference DtAutomotivePSR::secondWaypoint ( ) const

virtual

Get/set the second waypoint to move to when patrolling between points.

virtual void DtAutomotivePSR::setCheckForTerrainCollisions ( bool  checkForCollisions )

virtual

Check the terrain while moving to ensure that the entity does not move through any terrain polygons.

virtual bool DtAutomotivePSR::checkForTerrainCollisions ( ) const

virtual

Check the terrain while moving to ensure that the entity does not move through any terrain polygons.

virtual void DtAutomotivePSR::setUseHighFidelityGroundClamping ( bool  yesOrNo )

virtual

When clamping the entity to the ground, using high fidelity ground clamping will cause the entity to use all four support points when determining the plane on which the entity is positioned. When not using high fidelity, the entity will only use a single support point, the center, to determine the normal. Defaults to true, as that is the safer initial value.

Note

This can lead to errors if the support points lie on different polygons, as the entity will appear to be clamped to the polygon on which the center lies.

virtual bool DtAutomotivePSR::useHighFidelityGroundClamping ( ) const

virtual

When clamping the entity to the ground, using high fidelity ground clamping will cause the entity to use all four support points when determining the plane on which the entity is positioned. When not using high fidelity, the entity will only use a single support point, the center, to determine the normal. Defaults to true, as that is the safer initial value.

Note

This can lead to errors if the support points lie on different polygons, as the entity will appear to be clamped to the polygon on which the center lies.

virtual void DtAutomotivePSR::setUseTaskSpeed ( const bool  value )

virtual

Sets whether to use task speed, sets value.

virtual bool DtAutomotivePSR::useTaskSpeed ( ) const

virtual

Sets whether to use task speed, sets value.

virtual void DtAutomotivePSR::setTaskSpeed ( const double  value )

virtual

Sets whether to use task speed, sets value.

virtual double DtAutomotivePSR::taskSpeed ( ) const

virtual

Sets whether to use task speed, sets value.

virtual void DtAutomotivePSR::setAccelerationLevel ( const DtAutoAccelerationLevel  l )

virtual

Acceleration level to use for controlling maneuvers.

virtual enum DtAutoAccelerationLevel DtAutomotivePSR::accelerationLevel ( ) const

virtual

virtual void DtAutomotivePSR::setFinalSpeedNotSpecified ( )

virtual

Indicate that the final speed is not specified. If not specified, and the continue flag is set, then the ordered or task speed will be used at the end.

virtual bool DtAutomotivePSR::isFinalSpeedSpecified ( ) const

virtual

virtual void DtAutomotivePSR::setTaskAtDistance ( const double  d )

virtual

Sets at distance for task.

virtual double DtAutomotivePSR::taskAtDistance ( ) const

virtual

virtual void DtAutomotivePSR::setTaskAtDistanceUnspecified ( )

virtual

virtual bool DtAutomotivePSR::isTaskAtDistanceSpecified ( ) const

virtual

virtual int DtAutomotivePSR::currentVertex ( ) const

virtual

Get the current vertex we are moving toward when executing move-along behavior. Vertices are numbered starting from 0.

virtual void DtAutomotivePSR::putSelf ( std::string &  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtReaderWriter::appPath()  )

overridevirtual

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

static DtVrfProcessStateRepository* DtAutomotivePSR::creator ( const DtString &  rwName, DtLocalObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

virtual void DtAutomotivePSR::setIsCollisionAvoidanceEnabled ( bool  enabled )

virtual

virtual bool DtAutomotivePSR::isCollisionAvoidanceEnabled ( ) const

virtual

virtual void DtAutomotivePSR::setIsColliding ( bool  colliding )

virtual

virtual bool DtAutomotivePSR::isColliding ( ) const

virtual

virtual void DtAutomotivePSR::setIsClearing ( bool  clearing )

virtual

virtual bool DtAutomotivePSR::isClearing ( ) const

virtual

virtual void DtAutomotivePSR::setAvoidingLeft ( bool  avoidingLeft )

virtual

virtual bool DtAutomotivePSR::avoidingLeft ( ) const

virtual

virtual void DtAutomotivePSR::setGroundMoveToSubtaskId ( int  id )

virtual

virtual int DtAutomotivePSR::groundMoveToSubtaskId ( ) const

virtual

virtual bool DtAutomotivePSR::intermediateWorldDestinationValid ( ) const

virtual

These functions were used with gameware navigation.

virtual void DtAutomotivePSR::invalidateIntermediateWorldDestination ( )

virtual

These functions were used with gameware navigation.

virtual void DtAutomotivePSR::setIntermediateWorldDestination ( const DtVector &  destination )

virtual

These functions were used with gameware navigation.

virtual const DtVector& DtAutomotivePSR::intermediateWorldDestination ( ) const

virtual

These functions were used with gameware navigation.

virtual void DtAutomotivePSR::setRouteIsDiscovered ( bool  value )

virtual

These functions were used with gameware navigation.

virtual bool DtAutomotivePSR::routeIsDiscovered ( ) const

virtual

These functions were used with gameware navigation.

virtual void DtAutomotivePSR::setIsUsingBotSteering ( const bool  b )

virtual

Flag to indicate that the entity is using Gameware bot steering to follow a path on the nav mesh. This provides a back-channel communication from the groundMoveToDestination controller and the automotiveActuatorComponent so the latter can provide a work around for an instability in bot steering when backing up.

virtual bool DtAutomotivePSR::isUsingBotSteering ( ) const

virtual

These functions were used with gameware navigation.

Member Data Documentation

DtRwInt DtAutomotivePSR::myCurrentRouteIndex

protected

From DtGroundAutoController (gndAutoCntlr.h) (enum DtAutoTransmissionGear)

DtRwInt DtAutomotivePSR::myCurrentGear

protected

DtRwReal DtAutomotivePSR::myHeadingToTurnTo

protected

DtRwReal DtAutomotivePSR::myKTurnReverseGoalHeading

protected

DtRwBoolean DtAutomotivePSR::myKTurnReverseComplete

protected

DtRwSimObjectReference DtAutomotivePSR::myControlObject

protected

From DtGroundMoveToControllerComponent (gndMvToCntlr.h)

If tasked() is true, this is the name of the control object we're moving to.

DtRwSimObjectReference DtAutomotivePSR::myEntityToFollow

protected

From DtGroundFollowEntityController (gndFollwCtl.h)

Set when a follow entity task is received.

DtRwVector DtAutomotivePSR::myOffsetVector

protected

DtRwSimObjectReference DtAutomotivePSR::myRoute

protected

From DtGroundMoveAlongController (gndMvAlgCtl.h)

If tasked() is true, this is the name of the control object we're moving to.

DtLocalVectorIterator* DtAutomotivePSR::myRouteState

protected

Route state used to get info about the current route we're trying to follow (e.g. which vertex to move toward).

DtLocalVertexList DtAutomotivePSR::myVertices

protected

my copy of the current route

DtRwInt DtAutomotivePSR::myCurrentVertex

protected

Read/write variables to capture route state.

DtRwBoolean DtAutomotivePSR::myReverseFlag

protected

From DtGroundPatrolRouteController (gndPtrlRtCtl.h)

DtRwSimObjectReference DtAutomotivePSR::myFirstWaypoint

protected

From DtGroundPatrolBetweenController.

Set when a patrol between task is received.

DtRwSimObjectReference DtAutomotivePSR::mySecondWaypoint

protected

DtRwBoolean DtAutomotivePSR::myIsColliding

protected

Reuse above myReverseFlag from DtGroundPatrolRouteController bool myReverseFlag;.

From DtGroundCollisionAvoidanceController (gndColAvoid.h)

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

DtRwBoolean DtAutomotivePSR::myIsClearing

protected

DtRwBoolean DtAutomotivePSR::myAvoidingLeft

protected

DtRwVector DtAutomotivePSR::myWorldDestination

protected

World point for move to location tasks.

DtRwVector DtAutomotivePSR::myIntermediateWorldDestination

protected

Intermediate world point for move to location tasks.

DtRwBoolean DtAutomotivePSR::myCheckForTerrainCollisions

protected

DtRwBoolean DtAutomotivePSR::myUseHighFidelityGroundClamping

protected

Used by the automotive actuator when determining the orientation of the entity.

DtRwBoolean DtAutomotivePSR::myIsCollisionAvoidanceEnabled

protected

Used by the collision avoidance controller to determine if it should perform avoidance.

DtRwBoolean DtAutomotivePSR::myContinueFlag

protected

DtRwReal DtAutomotivePSR::myFinalSpeed

protected

Determines whether we will keep moving after this task is done and hence shouldn't slow down.

DtRwBoolean DtAutomotivePSR::myRouteIsDiscovered

protected

If continuing, what is the desired speed at the end of the move.

From DtGroundMoveAlongController (gndMvAlgCtl.h)

Flag indicating whether route to follow has been discovered or not.

DtRwReal DtAutomotivePSR::myTaskSpeed

protected

Are we using speed from task message, or default ordered speed?

DtRwBoolean DtAutomotivePSR::myUseTaskSpeed

protected

Are we using speed from task message, or default ordered speed?

DtRwReal DtAutomotivePSR::myTaskAtDistance

protected

At distance specified by task.

DtRwInt DtAutomotivePSR::myTurnToMode

protected

DtRwReal DtAutomotivePSR::myTurnRadiusForTask

protected

DtRwInt DtAutomotivePSR::myAccelerationLevel

protected

DtRwBoolean DtAutomotivePSR::myIsUsingBotSteering

protected

DtRwInt DtAutomotivePSR::myGroundMoveToSubtaskId

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/automotivePSR.h