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 | Private Member Functions
DtScriptedMovementController Class Reference

This controller will process the scripted movement message to move the object along the scripted path. More...

Inheritance diagram for DtScriptedMovementController:
Inheritance graph
[legend]

Public Member Functions

 DtScriptedMovementController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtScriptedMovementController ()
virtual bool init ()
 Calls setRadio()
virtual bool createPSR ()
virtual const chartype () const
 Returns a string identifies the class type of component.
virtual void tick ()
 This gives the thread of control to the component.
virtual void setDesiredLocation (const DtVector &)
 Sets the desired location for the entity. By default sets in kinematic state. Vector is in geocentric.
virtual void setDesiredSpeed (const DtVector &velocity, const DtVector &acceleration)
 Both values are local.
virtual void setDesiredRotationalVelocity (const DtVector &)
virtual void setDesiredOrientation (const DtTaitBryan &)
 Orientation in local.
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
DtScriptedMovementControllerPSR
getPSR ()
 Gets the process state repository for purposes of providing attributes.
- 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 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 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 (FILE *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
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 (FILE *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 (FILE *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.
virtual 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)
static DtReaderWriterprovideAnimationFrame (void *controller)
 Attribute access functions.

Protected Member Functions

virtual void registerTaskMsgCallbacks ()
virtual void processScriptedMovementTask (DtSimMessage *msg)
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time.
virtual bool setup ()
virtual DtFireInteraction * createFireInteraction () const
 Creates and returns a fire interaction at the launch point.
virtual void finishUp ()
virtual void sendDetonation ()
virtual int detonationResultFromDistance (double d, const DtVector &detonationPosition) const
 Given the distance to the target and the detonation position, return the detonation result.
virtual bool createPortGroups ()
 Called by init.
virtual bool tickWhileDestroyed () const
 If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
virtual void setupInitialState ()
 Sets up initial anchor values if not set. Will only be set if there is no target point.
- 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
virtual bool createPorts ()
 Called by init.
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 scriptedMovementTaskCallback (DtSimMessage *msg, void *usr)

Protected Attributes

DtScriptedMovementControllerPSRmyProcessState
DtVrfObjectmyTargetPoint
bool myInitialized
DtUpdateRepositoryOutputPortGroupmyUpdateRepositoryOutputPortGroup
 Used to update repository with any movement data.
bool myCompleteNextTick

Private Member Functions

 DtScriptedMovementController ()
 DtScriptedMovementController (const DtScriptedMovementController &orig)
DtScriptedMovementControlleroperator= (const DtScriptedMovementController &orig)
virtual void processObjectAboutToBeRemoved (DtVrfObject *object)
 Processes object removal; if the object being removed matches myTargetPoint, myTargetPoint is set to 0.
static void objectAboutToBeRemovedCallback (DtVrfObject *object, void *usr)
 Processes object removal; if the object being removed matches myTargetPoint, myTargetPoint is set to 0.
virtual void processAnimatedMovementTask (DtSimMessage *msg)
 Process scripted task version of this task.
static void animatedMovementTaskCallback (DtSimMessage *msg, void *usr)
 Process scripted task version of this task.

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

This controller will process the scripted movement message to move the object along the scripted path.

Constructor & Destructor Documentation

DtScriptedMovementController::DtScriptedMovementController ( )
private
DtScriptedMovementController::DtScriptedMovementController ( const DtScriptedMovementController orig)
private
DtScriptedMovementController::DtScriptedMovementController ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = NULL,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtScriptedMovementController::~DtScriptedMovementController ( )
virtual

Member Function Documentation

DtScriptedMovementController& DtScriptedMovementController::operator= ( const DtScriptedMovementController orig)
private
virtual bool DtScriptedMovementController::init ( )
virtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual bool DtScriptedMovementController::createPSR ( )
virtual
virtual const char* DtScriptedMovementController::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.

Implements DtTaskControllerComponent.

virtual void DtScriptedMovementController::tick ( )
virtual

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual void DtScriptedMovementController::setDesiredLocation ( const DtVector )
virtual

Sets the desired location for the entity. By default sets in kinematic state. Vector is in geocentric.

virtual void DtScriptedMovementController::setDesiredSpeed ( const DtVector velocity,
const DtVector acceleration 
)
virtual

Both values are local.

virtual void DtScriptedMovementController::setDesiredRotationalVelocity ( const DtVector )
virtual
virtual void DtScriptedMovementController::setDesiredOrientation ( const DtTaitBryan &  )
virtual

Orientation in local.

virtual void DtScriptedMovementController::clearTask ( )
virtual

If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.

Reimplemented from DtSingleTaskControllerComponent.

virtual DtScriptedMovementControllerPSR* DtScriptedMovementController::getPSR ( )
inlinevirtual

Gets the process state repository for purposes of providing attributes.

static DtReaderWriter* DtScriptedMovementController::provideAnimationFrame ( void *  controller)
static

Attribute access functions.

These functions are registered with the parent system in init().

Provides the current animation frame of the animation.

virtual void DtScriptedMovementController::registerTaskMsgCallbacks ( )
protectedvirtual

Reimplemented from DtTaskControllerComponent.

static void DtScriptedMovementController::scriptedMovementTaskCallback ( DtSimMessage msg,
void *  usr 
)
staticprotected
virtual void DtScriptedMovementController::processScriptedMovementTask ( DtSimMessage msg)
protectedvirtual
virtual void DtScriptedMovementController::preFirstTickInit ( )
protectedvirtual

This function can be overridden to initialize a component before it is ticked for the first time.

The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

virtual bool DtScriptedMovementController::setup ( )
protectedvirtual
virtual DtFireInteraction* DtScriptedMovementController::createFireInteraction ( ) const
protectedvirtual

Creates and returns a fire interaction at the launch point.

virtual void DtScriptedMovementController::finishUp ( )
protectedvirtual
virtual void DtScriptedMovementController::sendDetonation ( )
protectedvirtual
static void DtScriptedMovementController::objectAboutToBeRemovedCallback ( DtVrfObject object,
void *  usr 
)
staticprotected

Processes object removal; if the object being removed matches myTargetPoint, myTargetPoint is set to 0.

virtual void DtScriptedMovementController::processObjectAboutToBeRemoved ( DtVrfObject object)
protectedvirtual

Processes object removal; if the object being removed matches myTargetPoint, myTargetPoint is set to 0.

static void DtScriptedMovementController::animatedMovementTaskCallback ( DtSimMessage msg,
void *  usr 
)
staticprotected

Process scripted task version of this task.

Variables allowed for definition reference_point - Geocentric point or object name. This point will either be the start point of the animation that all the animation points are based from or the end point of the animation, with the points in the animation file leading to this end point. reference_orientation - Starting geocentric orientation supplied as topographic orientation. Will be converted to geocentric orientation. If not supplied the initial orientation will be used. reference_heading - Starting heading. reference_theta - "Tilt" of the reference frame with respect to the earth tangent line. time_scale - If defined the scale used to advance the frames. Default is 1.0 force_automatic_orientation - If defined and true, orientation as defined by the animation model selected will be ignored, and an automatic orientation will be used based on current heading and inclination. (Notably, roll is not approximated.) animation_model - Can be either a string representing an existing animation model defined in the entity editor or an animation model class which will contain all the information necessary to animate the entity clamp_type - If defined overrides the clamp type specified in the animation model. This can have the value of: 1 - Clamp high fidelity (includes orientation clamp) 2 - Clamp low fidelity 3 - Z value in data file is height above terrain 4 - No change, w/height interpreted as geodetic offset 5 - Conditional ground clamping (clamp when altitude is unchanged, otherwise use altitude as an offset) 6 - Use phased radar face-cartesian coordinate system (topographic height w/no altitude clamping) 7 - No change, w/height interpreted as a topographic (e.g. cartesian) offset completion_rule - What to do with the entity when the animation is complete. If defined overrides what is in animation model. Values can be 0 - Detonate 1 - Detonate and remove 2 - Remove 3 - Stay around

virtual void DtScriptedMovementController::processAnimatedMovementTask ( DtSimMessage msg)
protectedvirtual

Process scripted task version of this task.

Variables allowed for definition reference_point - Geocentric point or object name. This point will either be the start point of the animation that all the animation points are based from or the end point of the animation, with the points in the animation file leading to this end point. reference_orientation - Starting geocentric orientation supplied as topographic orientation. Will be converted to geocentric orientation. If not supplied the initial orientation will be used. reference_heading - Starting heading. reference_theta - "Tilt" of the reference frame with respect to the earth tangent line. time_scale - If defined the scale used to advance the frames. Default is 1.0 force_automatic_orientation - If defined and true, orientation as defined by the animation model selected will be ignored, and an automatic orientation will be used based on current heading and inclination. (Notably, roll is not approximated.) animation_model - Can be either a string representing an existing animation model defined in the entity editor or an animation model class which will contain all the information necessary to animate the entity clamp_type - If defined overrides the clamp type specified in the animation model. This can have the value of: 1 - Clamp high fidelity (includes orientation clamp) 2 - Clamp low fidelity 3 - Z value in data file is height above terrain 4 - No change, w/height interpreted as geodetic offset 5 - Conditional ground clamping (clamp when altitude is unchanged, otherwise use altitude as an offset) 6 - Use phased radar face-cartesian coordinate system (topographic height w/no altitude clamping) 7 - No change, w/height interpreted as a topographic (e.g. cartesian) offset completion_rule - What to do with the entity when the animation is complete. If defined overrides what is in animation model. Values can be 0 - Detonate 1 - Detonate and remove 2 - Remove 3 - Stay around

virtual int DtScriptedMovementController::detonationResultFromDistance ( double  d,
const DtVector detonationPosition 
) const
protectedvirtual

Given the distance to the target and the detonation position, return the detonation result.

virtual bool DtScriptedMovementController::createPortGroups ( )
protectedvirtual

Called by init.

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

Reimplemented from DtSimComponent.

virtual bool DtScriptedMovementController::tickWhileDestroyed ( ) const
protectedvirtual

If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.

Otherwise, tick will only be called when the entity is alive.

Returns
false.

Reimplemented from DtSimComponent.

virtual void DtScriptedMovementController::setupInitialState ( )
protectedvirtual

Sets up initial anchor values if not set. Will only be set if there is no target point.

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

Member Data Documentation

DtScriptedMovementControllerPSR* DtScriptedMovementController::myProcessState
protected
DtVrfObject* DtScriptedMovementController::myTargetPoint
protected
bool DtScriptedMovementController::myInitialized
protected
DtUpdateRepositoryOutputPortGroup* DtScriptedMovementController::myUpdateRepositoryOutputPortGroup
protected

Used to update repository with any movement data.

As long as this controller has control of this port group no other controllers/actuators will be allowed to write to it

bool DtScriptedMovementController::myCompleteNextTick
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)