DtAutomotivePSR Class Reference

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

Inheritance diagram for DtAutomotivePSR:

Public Member Functions
	DtAutomotivePSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAutomotivePSR (const DtAutomotivePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAutomotivePSR ()
	destructor
DtAutomotivePSR &	operator= (const DtAutomotivePSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	emptyRouteVertices ()
	Empty route vertices.
virtual DtLocalVectorIterator *	routeState () const
	Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
virtual void	unspecifyRoadPoints ()
	Sets the valueSpecified flag of both myRoadStartPoint and myRoadEndPoint to false.
virtual bool	roadPointsSpecified () const
	Returns true only if both myRoadStartPoint and myRoadEndPoint are specified.
virtual int	currentVertex () const
	Get the current vertex we are moving toward when executuing move-along behavior.
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to set myCurrentVertex from route state before writing.
virtual void	setCurrentGear (DtAutoTransmissionGear gear)
	Set/get current gear.
virtual DtAutoTransmissionGear	currentGear () const
virtual void	setHeadingToTurnTo (double headingToTurnTo)
	Set/get heading to turn to.
virtual double	headingToTurnTo () const
virtual void	setTurnToMode (int)
	Set/get heading turn to mode.
virtual int	turnToMode () const
virtual void	setKTurnReverseGoalHeading (double kTurnReverseGoalHeading)
	Get/Set the heading that is halfway between the original heading and the heading to turn to.
virtual double	kTurnReverseGoalHeading () const
virtual void	setKTurnReverseComplete (bool kTurnReverseComplete)
	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	kTurnReverseComplete () const
virtual void	setControlObject (const DtUUID &object)
	Get/set the name of the control object to move to (waypoint).
virtual const DtRwVrfObjectReference &	controlObject () const
	Was: controlObject.
virtual DtRwVrfObjectReference &	controlObject ()
virtual void	setContinueFlag (bool flag)
	Get/set the contiue moving flag.
virtual bool	continueFlag () const
virtual void	setWorldDestination (const DtVector &destination)
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
virtual const DtVector &	worldDestination () const
virtual void	setEntityToFollow (const DtUUID &objectName)
	Get/set the name of the entity to follow.
virtual const DtRwVrfObjectReference &	entityToFollow () const
virtual DtRwVrfObjectReference &	entityToFollow ()
virtual void	setFollowingOffsetVector (const DtVector &offsetVector)
	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 &	followingOffsetVector () const
virtual void	setEntityToInterceptAndDestroy (const DtUUID &)
	Get/set the name of the entity to intercept and destroy.
virtual const DtRwVrfObjectReference &	entityToInterceptAndDestroy () const
virtual DtRwVrfObjectReference &	entityToInterceptAndDestroy ()
virtual void	setStandOffDistance (const double distance)
	Get/set distance away from target to stop.
virtual const double	standOffDistance () const
virtual void	setRoute (const DtUUID &route)
	Get/set the name of the route to follow.
virtual const DtRwVrfObjectReference &	route () const
	Was: routeName.
virtual DtRwVrfObjectReference &	route ()
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)
	Set/get route vertices (local coordinates).
virtual const DtLocalVertexList &	routeVertices () const
virtual void	setReversePatrol (bool flag)
	Get/set the reverse flag for patrolling (along route or between points).
virtual bool	reversePatrol () const
virtual void	setFirstWaypoint (const DtUUID &waypoint)
	Get/set the first waypoint to move to when patrolling between points.
virtual const DtRwVrfObjectReference &	firstWaypoint () const
virtual DtRwVrfObjectReference &	firstWaypoint ()
virtual void	setSecondWaypoint (const DtUUID &waypoint)
	Get/set the second waypoint to move to when patrolling between points.
virtual const DtRwVrfObjectReference &	secondWaypoint () const
virtual DtRwVrfObjectReference &	secondWaypoint ()
virtual void	setIsColliding (bool colliding)
	Get/set flag indicating if we are currently in a colliding state.
virtual bool	isColliding () const
virtual void	setIsClearing (bool clearing)
	Get/set flag indicating if we are currently clearing a collision.
virtual bool	isClearing () const
virtual void	setAvoidingLeft (bool avoidingLeft)
	Get/set flag indicating if we are turning to left to avoid collision.
virtual bool	avoidingLeft () const
virtual void	setCheckForTerrainCollisions (bool checkForCollisions)
	Check the terrain while moving to ensure that the entity does not move through any terrain polygons.
virtual bool	checkForTerrainCollisions () const
virtual void	setUseHighFidelityGroundClamping (bool yesOrNo)
	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.
virtual bool	useHighFidelityGroundClamping () const
virtual void	setRoadStartPoint (const DtVector &point)
virtual DtVector	roadStartPoint () const
virtual void	setRoadEndPoint (const DtVector &point)
virtual DtVector	roadEndPoint () const
virtual void	setRouteIsDiscovered (bool value)
virtual bool	routeIsDiscovered () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *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 ()
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
DtRwInt	myCurrentGear
	From DtGroundAutoController (gndAutoCntlr.h) (enum DtAutoTransmissionGear)
DtRwReal	myHeadingToTurnTo
DtRwReal	myKTurnReverseGoalHeading
DtRwBoolean	myKTurnReverseComplete
DtRwVrfObjectReference	myControlObject
	From DtGroundMoveToControllerComponent (gndMvToCntlr.h)
DtRwVrfObjectReference	myEntityToFollow
	From DtGroundFollowEntityController (gndFollwCtl.h)
DtRwVector	myOffsetVector
DtRwVrfObjectReference	myRoute
	From DtGroundMoveAlongController (gndMvAlgCtl.h)
DtLocalVectorIterator *	myRouteState
	Route state used to get info about the current route we're trying to follow (e.g.
DtLocalVertexList	myVertices
	my copy of the current route
DtRwInt	myCurrentVertex
	Read/write variables to capture route state.
DtRwBoolean	myReverseFlag
	From DtGroundPatrolRouteController (gndPtrlRtCtl.h)
DtRwVrfObjectReference	myFirstWaypoint
	From DtGroundPatrolBetweenController.
DtRwVrfObjectReference	mySecondWaypoint
DtRwReal	myStandOffInterceptDistance
	Reuse above myReverseFlag from DtGroundPatrolRouteController bool myReverseFlag;.
DtRwVrfObjectReference	myEntityToInterceptAndDestroy
DtRwBoolean	myIsColliding
	From DtGroundCollisionAvoidanceController (gndColAvoid.h)
DtRwBoolean	myIsClearing
DtRwBoolean	myAvoidingLeft
DtRwVector	myWorldDestination
	World point for move to location tasks.
DtRwBoolean	myCheckForTerrainCollisions
DtRwBoolean	myUseHighFidelityGroundClamping
	Used by the automotive actuator when determining the orientation of the entity.
DtRwBoolean	myContinueFlag
DtRwInt	myTurnToMode
DtRwVector	myRoadStartPoint
DtRwVector	myRoadEndPoint
DtRwBoolean	myRouteIsDiscovered
	Determines whether we will keep moving after this task is done and hence shouldn't slow down.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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 ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

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

Constructor & Destructor Documentation

DtAutomotivePSR::DtAutomotivePSR	(	DtVrfObject *	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 ( )

virtual

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAutomotivePSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.h.

(DtVrfAutomotiveProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtAutomotivePSR::setCurrentGear ( DtAutoTransmissionGear  gear )

virtual

Set/get current gear.

virtual DtAutoTransmissionGear DtAutomotivePSR::currentGear ( ) const

virtual

virtual void DtAutomotivePSR::setHeadingToTurnTo ( double  headingToTurnTo )

virtual

Set/get heading to turn to.

virtual double DtAutomotivePSR::headingToTurnTo ( ) const

virtual

virtual void DtAutomotivePSR::setTurnToMode ( int  )

virtual

Set/get heading turn to mode.

See setHeadingRequest.h for modes

virtual int DtAutomotivePSR::turnToMode ( ) 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 fore entities that are not pivot capable.

virtual double DtAutomotivePSR::kTurnReverseGoalHeading ( ) const

virtual

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

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

virtual

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

Was: setControlObjectName

virtual const DtRwVrfObjectReference& DtAutomotivePSR::controlObject ( ) const

virtual

Was: controlObject.

virtual DtRwVrfObjectReference& DtAutomotivePSR::controlObject ( )

virtual

virtual void DtAutomotivePSR::setContinueFlag ( bool  flag )

virtual

Get/set the contiue 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, presumabley the move task was just a subtask part of a more complex movement task like convoying.

virtual bool DtAutomotivePSR::continueFlag ( ) 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

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

virtual

Get/set the name of the entity to follow.

virtual const DtRwVrfObjectReference& DtAutomotivePSR::entityToFollow ( ) const

virtual

virtual DtRwVrfObjectReference& DtAutomotivePSR::entityToFollow ( )

virtual

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

virtual void DtAutomotivePSR::setEntityToInterceptAndDestroy ( const DtUUID &  )

virtual

Get/set the name of the entity to intercept and destroy.

virtual const DtRwVrfObjectReference& DtAutomotivePSR::entityToInterceptAndDestroy ( ) const

virtual

virtual DtRwVrfObjectReference& DtAutomotivePSR::entityToInterceptAndDestroy ( )

virtual

virtual void DtAutomotivePSR::setStandOffDistance ( const double  distance )

virtual

Get/set distance away from target to stop.

virtual const double DtAutomotivePSR::standOffDistance ( ) const

virtual

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

virtual

Get/set the name of the route to follow.

Was: setRouteName

virtual const DtRwVrfObjectReference& DtAutomotivePSR::route ( ) const

virtual

Was: routeName.

virtual DtRwVrfObjectReference& DtAutomotivePSR::route ( )

virtual

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

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

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

virtual

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

virtual const DtRwVrfObjectReference& DtAutomotivePSR::firstWaypoint ( ) const

virtual

virtual DtRwVrfObjectReference& DtAutomotivePSR::firstWaypoint ( )

virtual

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

virtual

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

virtual const DtRwVrfObjectReference& DtAutomotivePSR::secondWaypoint ( ) const

virtual

virtual DtRwVrfObjectReference& DtAutomotivePSR::secondWaypoint ( )

virtual

virtual void DtAutomotivePSR::setIsColliding ( bool  colliding )

virtual

Get/set flag indicating if we are currently in a colliding state.

virtual bool DtAutomotivePSR::isColliding ( ) const

virtual

virtual void DtAutomotivePSR::setIsClearing ( bool  clearing )

virtual

Get/set flag indicating if we are currently clearing a collision.

virtual bool DtAutomotivePSR::isClearing ( ) const

virtual

virtual void DtAutomotivePSR::setAvoidingLeft ( bool  avoidingLeft )

virtual

Get/set flag indicating if we are turning to left to avoid collision.

virtual bool DtAutomotivePSR::avoidingLeft ( ) const

virtual

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

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

virtual void DtAutomotivePSR::setRoadStartPoint ( const DtVector &  point )

virtual

Points which define the road that the vehicle is moving with respect to. Setting value causes valueSpecified flag to be set true.

virtual DtVector DtAutomotivePSR::roadStartPoint ( ) const

virtual

virtual void DtAutomotivePSR::setRoadEndPoint ( const DtVector &  point )

virtual

virtual DtVector DtAutomotivePSR::roadEndPoint ( ) const

virtual

virtual void DtAutomotivePSR::unspecifyRoadPoints ( )

virtual

Sets the valueSpecified flag of both myRoadStartPoint and myRoadEndPoint to false.

virtual bool DtAutomotivePSR::roadPointsSpecified ( ) const

virtual

Returns true only if both myRoadStartPoint and myRoadEndPoint are specified.

virtual void DtAutomotivePSR::setRouteIsDiscovered ( bool  value )

virtual

Sets whether the current task has been successfully initialized

virtual bool DtAutomotivePSR::routeIsDiscovered ( ) const

virtual

virtual int DtAutomotivePSR::currentVertex ( ) const

virtual

Get the current vertex we are moving toward when executuing 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()  )

virtual

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwInt DtAutomotivePSR::myCurrentGear

protected

From DtGroundAutoController (gndAutoCntlr.h) (enum DtAutoTransmissionGear)

DtRwReal DtAutomotivePSR::myHeadingToTurnTo

protected

DtRwReal DtAutomotivePSR::myKTurnReverseGoalHeading

protected

DtRwBoolean DtAutomotivePSR::myKTurnReverseComplete

protected

DtRwVrfObjectReference DtAutomotivePSR::myControlObject

protected

From DtGroundMoveToControllerComponent (gndMvToCntlr.h)

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

DtRwVrfObjectReference DtAutomotivePSR::myEntityToFollow

protected

From DtGroundFollowEntityController (gndFollwCtl.h)

Set when a follow entity task is received.

DtRwVector DtAutomotivePSR::myOffsetVector

protected

DtRwVrfObjectReference 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)

DtRwVrfObjectReference DtAutomotivePSR::myFirstWaypoint

protected

From DtGroundPatrolBetweenController.

Set when a patrol between task is received.

DtRwVrfObjectReference DtAutomotivePSR::mySecondWaypoint

protected

DtRwReal DtAutomotivePSR::myStandOffInterceptDistance

protected

Reuse above myReverseFlag from DtGroundPatrolRouteController bool myReverseFlag;.

DtRwVrfObjectReference DtAutomotivePSR::myEntityToInterceptAndDestroy

protected

DtRwBoolean DtAutomotivePSR::myIsColliding

protected

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.

DtRwBoolean DtAutomotivePSR::myCheckForTerrainCollisions

protected

DtRwBoolean DtAutomotivePSR::myUseHighFidelityGroundClamping

protected

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

DtRwVector DtAutomotivePSR::myRoadStartPoint

protected

Road currently being used by DtGroundMoveToDestinationControllerComponent.

DtRwVector DtAutomotivePSR::myRoadEndPoint

protected

DtRwBoolean DtAutomotivePSR::myContinueFlag

protected

DtRwBoolean DtAutomotivePSR::myRouteIsDiscovered

protected

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

From DtGroundMoveAlongController (gndMvAlgCtl.h)

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

DtRwInt DtAutomotivePSR::myTurnToMode

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/automotivePSR.h