VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtHumanCollisionAvoidanceController Class Reference

DtHumanCollisionAvoidanceController is a controller that helps entities to avoid running into other entities and/or feature obstructions. More...

Inheritance diagram for DtHumanCollisionAvoidanceController:
Inheritance graph
[legend]

Public Member Functions

 DtHumanCollisionAvoidanceController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtHumanCollisionAvoidanceController ()
 Destructor.
virtual bool init ()
 Initializes the follow controller name, the object ID, and the collisionBV (bounding volume)
virtual void tick ()
 Calculate new control values based on potential collisions.
virtual double distanceSquaredToDestination (DtVector offsetVector)
 Calculates the distance squared from the current location (in local coords) to the destination, minus the specified offset vector.
virtual void avoidCollision (const DtCollision &potentialCollision)
 Activates all control ports/groups and provides the necessary speed, direction, and heading values.
virtual const chartype () const
 Returns a string identifies the class type of component.
- Public Member Functions inherited from DtSingleTaskControllerComponent
 DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtSingleTaskControllerComponent ()
 destructor
virtual void postTick ()
 Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task.
virtual void taskNotify (const DtSimTask &task)
 This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void taskComplete (bool success=true)
 If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual void clearTask ()
 If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
virtual void suspendTask ()
 This method is called when the currently running task is being suspended.
virtual int sendSubtask (DtSimTask &task)
 Sends subtask to ourself.
virtual void clearSubtask (int subtaskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void addPendingSubtaskId (int subtaskId)
 Adds given subtask Id to list of pending subtasks.
virtual bool findPendingSubtaskId (int subtaskId)
 Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool isSubtasked () const
 Returns true if this controller is currently subtasked.
virtual void removePendingSubtaskId (int subtaskId)
 Removes pending subtask from list of subtasks for this component.
virtual void removeAllPendingSubtaskIds ()
 Clear all pending subtasks from our list of subtasks.
virtual std::vector< int > currentPendingSubstaskIds () const
 Returns the list of all currently pending subtask ids for this controller.
virtual void clearCurrentTaskMessage ()
 Returns the current subtask with the specified id.
virtual DtTaskMessagecurrentTaskMessage () const
 Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr currentTaskState () const
virtual bool decideToGiveUpTask () const
 This function is used to determine if the controller should give up trying to execute the current task.
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true.
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared.
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller.
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name.
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization.
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtTaskControllerComponent ()
 destructor
virtual bool showCurrentTaskInGui () const
virtual void setRadio (DtSimRadio *radio)
 Calls registerTaskMsgCallbacks.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback.
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback().
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback.
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks().
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message.
DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this controller.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
 The current tasked state of this controller.
- Public Member Functions inherited from DtControllerComponent
 DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtControllerComponent ()
 destructor
virtual DtSimRadioradio ()
 The radio this component is listening to.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (std::string &fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const
DtComponentDescriptor
componentDescriptor () const
virtual bool tickWhileDestroyed () const
 If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStream & objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream & objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream & objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream & objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream & objectConsoleError (const DtString &channel="") const
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
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)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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 DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

 DtHumanCollisionAvoidanceController ()
 Default constructor; should not be called.
 DtHumanCollisionAvoidanceController (const DtHumanCollisionAvoidanceController &orig)
 copy constructor
const
DtHumanCollisionAvoidanceController
operator= (const DtHumanCollisionAvoidanceController &orig)
 assignment operator
virtual bool shouldRun ()
 whether or not the controller should run this tick, and returns true if it should.
virtual void clearCollisionStateData ()
 This just cleans up some state variables when it's determined that an entity is no longer potentially colliding.
virtual void clearingCollision ()
 Moves the vehicle in a straight line for the defined clearingDistance after it is no longer at risk of colliding with the obstruction.
virtual bool isInsideObstruction (const DtCollision *potentialCollision, double &clearingDistance)
 Determine if the entity is inside the potential obstruction.
virtual void registerTaskMsgCallbacks ()
 Override for interest in task complete messages, we care about stopMoving tasks.
virtual void processTaskComplete (DtSimMessage *msg)
bool isAppreciablyMoving (DtVector velocity, double velocityTolerance) const
 If the magnitude of any component of the velocity is greater than the velocity tolerance, then the entity is considered appreciably moving.
bool setDefaultPortValuesForAvoidance ()
 Sets the ports to appropriate default values.
bool determineObstructionMovementDirection (DtDcm obstructionLocalOrientationMatrix, const DtVector &obstructionVelocity, int &obstructionDirectionSign) const
 Determines if the obstruction is moving forward or in reverse.
void avoidMovingObstruction (const DtCollision &potentialCollision)
 Calculates and sets control values for avoiding a moving obstruction based on obstruction's relative movement (head-on, in front of, etc.) If the obstruction is moving in roughly the same direction, and the entity is in front, it does nothing.
void avoidNonMovingObstruction (const DtCollision &potentialCollision)
 Calculates control values for avoiding a non-moving obstruction.
virtual void calculateAvoidanceByVertices (const DtVector &vertex1, const DtVector &vertex2, double entityBoundingVolumeRadius, DtVector &localVectorToDestination, DtVector &localVectorToObstruciton)
 Calculates control values for avoiding using the vertices that define the obstruction.
virtual void calculateAvoidanceUsingBoundingVolume (const DtCollision &potentialCollision, double entityBoundingVolumeRadius, DtVector &localVectorToDestination, DtVector &localVectorToObstruciton)
 Calculates very rough control values for avoiding using the bounding volume.
void startClearingCollision (double clearingDistance)
 Sets state as appropriate for clearing a collision and then starts clearing the collision.
bool calculateMyEntityCollisionBV ()
 Calculates a bounding volume representing the potential collision volume occupied by the entity.
bool createPortGroups ()
 Called by init.
bool createPorts ()
 Called by init.
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
virtual void computeClearingHeading (const DtVector &localVertex1, const DtVector &localVertex2, const DtVector &localObstaclePos, double &clearingHeading) const
virtual void getObstructionFootprint (const DtCollision &collision, DtLocalVertexList &localObstructionFootprint) const
- Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void clearPendingSubtasks ()
 Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType)
 Clear all subtasks of a given type.
- Protected Member Functions inherited from DtTaskControllerComponent
virtual void suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
 Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations.
double calculateNextTaskVisTickTime () const
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Static Protected Member Functions

static void taskCompleteReportCallback (DtSimMessage *msg, void *usr)
 Monitor taskReportComplete callback to see when entity stops moving during an embarkation task so we can stop collision avoiding.

Protected Attributes

double myClearingDistance
 This is only used when clearing.
bool myAvoidingCollision
Dt3dBoundingVolume * myCollisionBV
DtActiveBotNavInterfacemyNavInterface
bool myHavePortGroup
DtHumanStateRepositorymyLifeformState
DtHumanCollisionAvoidancePSRmyProcessState
 Container for state data associated with this component.
double myTimeToCollide
 The minimum time before a collision (in seconds) which the collision avoidance controller compares to its own estimate of the time before a rear end collision to determine when to apply the brakes.
double myLateralClearance
 The width (in meters) added to the length of the bounding volume which is checked for potential collisions.
double myStoppingDistanceFactor
 The factor by which the collision avoidance controller multiplies the current stopping distance to determine the length of the bounding volume which is checked for potential collisions.
DtVector myNonMvObstructionLocation
Ports and Port Groups
DtCollisionInputPortmyCollisionAvoidancePort
 Input Port Name: potential-collision-info
Input Port Description:
Input Port Range:
Input Port Default Value:
Input Group Parent: collision-avoidance-control.
DtVectorInputPortmyDestinationInputPort
 Output Port Name: destination
Output Port Description: Specifies the current destination of the entity in geocentric coordiantes.
DtInputPortGroupmyCollisionAvoidancePortGroup
 Input Port Group Name: collision-avoidance-control
Input Port Group Description:
DtHumanMovementControlOutputPortGroupmyHumanMovementControlOutputPortGroup
 Output Group Name: movement-control
.
DtBooleanOutputPortmyCollisionPort
 Output Port Name: collision
Output Port Description: Specifies if there's a collision occurring Output Port Range:
Output Group Parent:
.
DtBooleanOutputPortmyIsMovingPort
 Output Port Name: is-moving
Output Port Description: Indicates the entity is being actively moved by this controller.

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 Types inherited from DtTaskControllerComponent
typedef std::pair
< DtTaskMessageCallbackFcn,
void * > 
DtTaskCallbackMapPair
 This map stores callbacks that have been registered to processes various tasks.
typedef std::map
< DtSimTaskMessageType,
DtTaskCallbackMapPair
DtTaskCallbackMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtHumanCollisionAvoidanceController is a controller that helps entities to avoid running into other entities and/or feature obstructions.

Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

DtHumanCollisionAvoidanceController::DtHumanCollisionAvoidanceController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtHumanCollisionAvoidanceController::~DtHumanCollisionAvoidanceController ( )
virtual

Destructor.

Cleans up any allocated ports/port groups, and bounding volumes.

DtHumanCollisionAvoidanceController::DtHumanCollisionAvoidanceController ( )
protected

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtHumanCollisionAvoidanceController::DtHumanCollisionAvoidanceController ( const DtHumanCollisionAvoidanceController orig)
protected

copy constructor

Member Function Documentation

virtual bool DtHumanCollisionAvoidanceController::init ( )
virtual

Initializes the follow controller name, the object ID, and the collisionBV (bounding volume)

Returns
A boolean indicating success or failure.

Reimplemented from DtControllerComponent.

virtual void DtHumanCollisionAvoidanceController::tick ( )
virtual

Calculate new control values based on potential collisions.

If the controller has received potential collision data, then it acts to avoid a collision. If it does not receive collision data, but has on the previous tick, then the controller starts clearing the collision.

See Also
avoidCollision()
clearingCollision()

Reimplemented from DtSimComponent.

virtual double DtHumanCollisionAvoidanceController::distanceSquaredToDestination ( DtVector  offsetVector)
virtual

Calculates the distance squared from the current location (in local coords) to the destination, minus the specified offset vector.

Returns
a double set to the distance squared.
virtual void DtHumanCollisionAvoidanceController::avoidCollision ( const DtCollision potentialCollision)
virtual

Activates all control ports/groups and provides the necessary speed, direction, and heading values.

Parameters
potentialCollisionA collision object to avoid.
See Also
avoidMovingObstruction()
avoidNonMovingObstruction()
virtual const char* DtHumanCollisionAvoidanceController::type ( ) const
virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns
DtHumanCollisionAvoidanceControllerType

Implements DtTaskControllerComponent.

static DtSimComponent* DtHumanCollisionAvoidanceController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.
const DtHumanCollisionAvoidanceController& DtHumanCollisionAvoidanceController::operator= ( const DtHumanCollisionAvoidanceController orig)
protected

assignment operator

virtual bool DtHumanCollisionAvoidanceController::shouldRun ( )
protectedvirtual

whether or not the controller should run this tick, and returns true if it should.

virtual void DtHumanCollisionAvoidanceController::clearCollisionStateData ( )
protectedvirtual

This just cleans up some state variables when it's determined that an entity is no longer potentially colliding.

virtual void DtHumanCollisionAvoidanceController::clearingCollision ( )
protectedvirtual

Moves the vehicle in a straight line for the defined clearingDistance after it is no longer at risk of colliding with the obstruction.

This is done to keep the vehicle from turning back to the goal too soon, which would cause a jitter as the vehicle went in and out of the collision state.

virtual bool DtHumanCollisionAvoidanceController::isInsideObstruction ( const DtCollision potentialCollision,
double &  clearingDistance 
)
protectedvirtual

Determine if the entity is inside the potential obstruction.

Returns the necessary clearing distance if we are inside the obstruction.

virtual void DtHumanCollisionAvoidanceController::registerTaskMsgCallbacks ( )
protectedvirtual

Override for interest in task complete messages, we care about stopMoving tasks.

Reimplemented from DtTaskControllerComponent.

static void DtHumanCollisionAvoidanceController::taskCompleteReportCallback ( DtSimMessage msg,
void *  usr 
)
staticprotected

Monitor taskReportComplete callback to see when entity stops moving during an embarkation task so we can stop collision avoiding.

virtual void DtHumanCollisionAvoidanceController::processTaskComplete ( DtSimMessage msg)
protectedvirtual
bool DtHumanCollisionAvoidanceController::isAppreciablyMoving ( DtVector  velocity,
double  velocityTolerance 
) const
protected

If the magnitude of any component of the velocity is greater than the velocity tolerance, then the entity is considered appreciably moving.

Returns
A boolean signifying whether or not the entity is appreciably moving.
bool DtHumanCollisionAvoidanceController::setDefaultPortValuesForAvoidance ( )
protected

Sets the ports to appropriate default values.

  • Throttle is set to the approximate throttle for the ordered speed.
  • Break is set to either 0 or .5 depending on dif. between current and ordered speed
  • Steering is set to 0.
  • ParkingBrake is set to false
    Returns
    A boolean signifying success or failure.
bool DtHumanCollisionAvoidanceController::determineObstructionMovementDirection ( DtDcm  obstructionLocalOrientationMatrix,
const DtVector obstructionVelocity,
int &  obstructionDirectionSign 
) const
protected

Determines if the obstruction is moving forward or in reverse.

Parameters
obstructionDirectionSignA reference to an integer representing the direction of movement: 1 for forward, -1 for reverse.
Returns
a boolean signifying success or failure in the calculation.
void DtHumanCollisionAvoidanceController::avoidMovingObstruction ( const DtCollision potentialCollision)
protected

Calculates and sets control values for avoiding a moving obstruction based on obstruction's relative movement (head-on, in front of, etc.) If the obstruction is moving in roughly the same direction, and the entity is in front, it does nothing.

If it is behind, and following the entity, then it lets the follow entity controller take over. If not following the entity, then it slows down to avoid a collision.

If the obstruction is coming head on, then the entity attempts to turn out of the way as if the obstruction was a non-moving entity.

Note
Assumes that the obstruction is an entity, since it is moving. If the potential collision is not an entity, this function will have to be
void DtHumanCollisionAvoidanceController::avoidNonMovingObstruction ( const DtCollision potentialCollision)
protected

Calculates control values for avoiding a non-moving obstruction.

If the entity is not following the obstruction, and the entity can turn, it turns to the opposite direction of the obstruction's location to the entity. (i.e. if the obstruction is on the right, the entity turns to the left.) Otherwise, the entity stops, since either the leader has stopped or it is unable to turn.

virtual void DtHumanCollisionAvoidanceController::calculateAvoidanceByVertices ( const DtVector vertex1,
const DtVector vertex2,
double  entityBoundingVolumeRadius,
DtVector localVectorToDestination,
DtVector localVectorToObstruciton 
)
protectedvirtual

Calculates control values for avoiding using the vertices that define the obstruction.

This is used with objects that have at least 2 vertices

virtual void DtHumanCollisionAvoidanceController::calculateAvoidanceUsingBoundingVolume ( const DtCollision potentialCollision,
double  entityBoundingVolumeRadius,
DtVector localVectorToDestination,
DtVector localVectorToObstruciton 
)
protectedvirtual

Calculates very rough control values for avoiding using the bounding volume.

void DtHumanCollisionAvoidanceController::startClearingCollision ( double  clearingDistance)
protected

Sets state as appropriate for clearing a collision and then starts clearing the collision.

Parameters
clearingDistanceThe distance the entity will move before it considers itself of having fully avoided the collision. This is to prevent entities from immediately turning back into the path of the potential collision once initially avoided it.
See Also
clearingCollision()
bool DtHumanCollisionAvoidanceController::calculateMyEntityCollisionBV ( )
protected

Calculates a bounding volume representing the potential collision volume occupied by the entity.

The entities oriented bounding volume is extended in the direction of travel. It represents a prediction of the entity's future movement for some period of time.

Returns
A boolean signifying success or failure. If the function fails, the bounding volume is not defined to be valid.
Note
Almost exact same function as in the DtObstructionSensor class.
This function assumes simplified movement, and only works for movement "forward/backward" in body coordinates (x direction). For more complicated collision bounding volumes, this function must be overridden.
bool DtHumanCollisionAvoidanceController::createPortGroups ( )
protectedvirtual

Called by init.

Derived classes should override this method to create all their input/output port groups.

Reimplemented from DtSimComponent.

bool DtHumanCollisionAvoidanceController::createPorts ( )
protectedvirtual

Called by init.

Derived classes should override this method to create all their input/output ports and port groups.

Reimplemented from DtSimComponent.

virtual bool DtHumanCollisionAvoidanceController::createPSR ( )
protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual void DtHumanCollisionAvoidanceController::computeClearingHeading ( const DtVector localVertex1,
const DtVector localVertex2,
const DtVector localObstaclePos,
double &  clearingHeading 
) const
protectedvirtual
virtual void DtHumanCollisionAvoidanceController::getObstructionFootprint ( const DtCollision collision,
DtLocalVertexList localObstructionFootprint 
) const
protectedvirtual

Member Data Documentation

double DtHumanCollisionAvoidanceController::myClearingDistance
protected

This is only used when clearing.

bool DtHumanCollisionAvoidanceController::myAvoidingCollision
protected
Dt3dBoundingVolume* DtHumanCollisionAvoidanceController::myCollisionBV
protected
DtActiveBotNavInterface* DtHumanCollisionAvoidanceController::myNavInterface
protected
bool DtHumanCollisionAvoidanceController::myHavePortGroup
protected
DtHumanStateRepository* DtHumanCollisionAvoidanceController::myLifeformState
protected
DtHumanCollisionAvoidancePSR* DtHumanCollisionAvoidanceController::myProcessState
protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

DtCollisionInputPort* DtHumanCollisionAvoidanceController::myCollisionAvoidancePort
protected

Input Port Name: potential-collision-info
Input Port Description:
Input Port Range:
Input Port Default Value:
Input Group Parent: collision-avoidance-control.

DtVectorInputPort* DtHumanCollisionAvoidanceController::myDestinationInputPort
protected

Output Port Name: destination
Output Port Description: Specifies the current destination of the entity in geocentric coordiantes.

Output Port Range:
Output Group Parent:

DtInputPortGroup* DtHumanCollisionAvoidanceController::myCollisionAvoidancePortGroup
protected

Input Port Group Name: collision-avoidance-control
Input Port Group Description:

DtHumanMovementControlOutputPortGroup* DtHumanCollisionAvoidanceController::myHumanMovementControlOutputPortGroup
protected

Output Group Name: movement-control
.

DtBooleanOutputPort* DtHumanCollisionAvoidanceController::myCollisionPort
protected

Output Port Name: collision
Output Port Description: Specifies if there's a collision occurring Output Port Range:
Output Group Parent:
.

DtBooleanOutputPort* DtHumanCollisionAvoidanceController::myIsMovingPort
protected

Output Port Name: is-moving
Output Port Description: Indicates the entity is being actively moved by this controller.


Output Port Range:
Output Group Parent:

double DtHumanCollisionAvoidanceController::myTimeToCollide
protected

The minimum time before a collision (in seconds) which the collision avoidance controller compares to its own estimate of the time before a rear end collision to determine when to apply the brakes.


Parameter Default Value: 0.0
Parameter Units: seconds

double DtHumanCollisionAvoidanceController::myLateralClearance
protected

The width (in meters) added to the length of the bounding volume which is checked for potential collisions.


Parameter Default Value: 0.25
Parameter Units: meters

double DtHumanCollisionAvoidanceController::myStoppingDistanceFactor
protected

The factor by which the collision avoidance controller multiplies the current stopping distance to determine the length of the bounding volume which is checked for potential collisions.


Parameter Default Value: 1.0

DtVector DtHumanCollisionAvoidanceController::myNonMvObstructionLocation
protected

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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)