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

DtDynamicTerrainMunitionDamageController is a controller that calculates and publishes terrain changes due to damage from munition detonations. More...

Inheritance diagram for DtDynamicTerrainController:
Inheritance graph
[legend]

Classes

struct  PendingDynamicTerrainInformation
 If there are dynamic terrain information requests pending, this stores the request and its current state. More...
struct  QueuedTerrainSwitch

Public Member Functions

 DtDynamicTerrainController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 Constructor.
virtual ~DtDynamicTerrainController ()
 Destructor.
virtual bool init ()
 Init. Called immediately after construction.
virtual void registerCallbacks ()
 Called by init to register any callbacks.
virtual void deregisterCallbacks ()
 Called by destructor to deregister any callbacks.
virtual void preFirstTickInit ()
 Publishes any dynamic terrain changes saved in PSR.
virtual const chartype () const
virtual void tick ()
 This component's simulation tick.
virtual bool processDynamicTerrainSwitch (const DtTerrainGeometry &geometry, const DtKeyValuePair &change, unsigned priority, double delay=0.0, bool shouldQueue=true)
 Processes a command to add new changes to the dynamic terrain as individual switches.
virtual void processDynamicTerrainArea (const DtTerrainGeometry &geometry, const DtKeyValuePairList &changes, unsigned priority, double delay=0.0)
 Processes a command to add new changes to the dynamic terrain as one big change that stacks on top of any other changes in the area.
virtual DtRwDynamicTerrainItemfindDynamicTerrainSwitch (const DtTerrainGeometry &geometry, double tolerance, const DtString &key, unsigned *index=0)
 Finds an existing switch change that matches the given geometry within the given tolerance and the given key.
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
virtual void processQueuedTerrainChanges (double dt)
virtual std::list< DtVectorfindDynamicTerrainElements (const DtVector &localLocation, double radius, const DtString &filterKey=DtString::nullString(), std::list< DtRwDynamicTerrainInformation > *fullInfo=0, bool *dataAvailable=0)
 Finds all dynamic terrain nodes within the specified area and returns their location.
virtual std::list< DtVectorfindDynamicTerrainElements (const DtVector &localStartLocation, const DtVector &localEndLocation, const DtString &filterKey=DtString::nullString(), std::list< DtRwDynamicTerrainInformation > *fullInfo=0, bool *dataAvailable=0)
 Finds all dynamic terrain nodes along the specified chord and returns their locations and keys.
virtual void setDynamicTerrainInformationRecheckPeriod (double)
 The recheck period for checking dynamic terrain info requests.
virtual double dynamicTerrainInformationRecheckPeriod () const
- 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< intcurrentPendingSubstaskIds () 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
 
- 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 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.
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
- 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 (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 DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component.
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component.
virtual bool isThreadSafe () const
 Returns true if this component is marked as being thread safe.
virtual void addVRLinkDeferredJob (const boost::function< void()> &callback)
 Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe.
virtual bool isEnabled ()
virtual void setIsEnabled (bool yesNo)
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 original 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 bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called.
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual DtRwVariableBindingsgenerateVariableBindings () const
 Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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 &)
 Restores 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 creator function for factory registration.

Protected Types

typedef DtBoost::shared_ptr
< PendingDynamicTerrainInformation
PendingDynamicTerrainInformationPtr
typedef std::vector
< PendingDynamicTerrainInformationPtr
PendingDynamicTerrainRequests
typedef tbb::spin_mutex Mutex

Protected Member Functions

virtual void updateSingleSwitch (const DtTerrainGeometry &geometry, const DtKeyValuePair &change, unsigned priority)
 Searches for an existing switch that matches, and if found, updates it with the new value.
virtual bool isRequestValidForArea (const DtIfRequestDynamicTerrainInformation &req)
 Returns true if the geometry for the request is within our area of control.
virtual bool isCommandValidForArea (const DtDynamicTerrainCommand &cmd)
 Returns true if the geometry for the command is within our area of control.
virtual bool isInCommandGeometry (const DtDynamicTerrainCommand &cmd, const DtTerrainGeometry &terrainGeometry)
 Returns true if the terrain change lies within the area specified in the command.
virtual bool processPendingDynamicTerrainInformation (PendingDynamicTerrainInformationPtr &)
 Processes a pending dynamic terrain information request.
virtual DtDynamicTerrainPublishercreatePublisher ()
 Creates a publisher.
virtual
DtDynamicTerrainControllerPSR
createPSR ()
 Create the PSR.
virtual void addPublishedChange (std::vector< DtDynamicTerrainPublisher * > &publishers, const DtTerrainGeometryAndData &change)
 Adds a new change geometry to the publisher list. Creates a new publisher if necessary.
virtual void updatePublishedChange (std::vector< DtDynamicTerrainPublisher * > &publishers, unsigned index, const DtKeyValuePairList &changeData, unsigned priority, unsigned eventNumber)
 Updates an existing published change, finding the item in the correct publisher in the list based on the index.
virtual const
DtTerrainGeometryAndData
publishedChange (const std::vector< DtDynamicTerrainPublisher * > &publishers, unsigned index) const
 Returns the geometry and data for the published change at the given index.
DtVector averageLocation (const DtRwVectorList &vectorList) const
 Computes the average location from a list of locations.
DtVector averageLocation (const DtWorldLocationStructArray &vectorList) 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.
virtual void cleanupInactiveSubtaskStatus ()
 Clears out subtask status entries that are either completed or canceled which were started by this controller.
- 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 DtSimTaskMessageType remapScriptId (const DtSimTaskMessageType &) const
 In case this is aliased, return the actual script id.
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
virtual void onRestore ()
 Override to iterate over the descriptor to see if there are any targetting control tables.
virtual void initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
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.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component.
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization.
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.
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

DtDynamicTerrainControllerDescriptormyDynamicTerrainDescriptor
DtDynamicTerrainControllerPSRmyProcessState
 Container for state data associated with this component.
std::vector
< DtDynamicTerrainPublisher * > 
myIndividualSwitchPublishers
 Publishes the dynamic terrain changes for individual switches to the network.
std::vector
< DtDynamicTerrainPublisher * > 
myAreaPublishers
 Publishes the dynamic terrain changes for a whole area to the network.
PendingDynamicTerrainRequests myPendingDynamicTerrainRequests
double myDynamicTerrainRecheckPeriod
double myLastTickRealTime
Mutex myTerrainFeatureMutex
std::list< QueuedTerrainSwitchmyTerrainSwitchQueue
std::list
< DtSwitchDynamicTerrainAtPointCommand
myTerrainSwitchAtPointQueue

Private Member Functions

 DtDynamicTerrainController ()
 Not Implemented.
 DtDynamicTerrainController (const DtDynamicTerrainController &orig)
 Not Implemented.
DtDynamicTerrainControlleroperator= (const DtDynamicTerrainController &orig)
 Not Implemented.
virtual void processAddDynamicTerrainChangesCommand (const DtAddDynamicTerrainChangesCommand &cmd)
static void addDynamicTerrainChangesCallback (const DtSimCommand &cmd, void *usr)
 Processes commands to add new changes to dynamic terrain.
virtual bool processSwitchDynamicTerrainCommand (const DtSwitchDynamicTerrainAtPointCommand &cmd, bool shouldQueue=true)
 Returns true if data was available to process this switch.
static void switchDynamicTerrainCallback (const DtSimCommand &cmd, void *usr)
 Processes commands to add new changes to dynamic terrain.
virtual void processResetDynamicTerrainChangesCommand (const DtResetDynamicTerrainChangesCommand &cmd)
static void resetDynamicTerrainChangesCallback (const DtSimCommand &cmd, void *usr)
 Processes commands to reset changes to dynamic terrain.
virtual void processDynamicTerrainInformationRequest (DtIfRequestDynamicTerrainInformation *)
static void dynamicTerrainInformationRequestCallback (DtSimMessage *, void *usr)
 Processes requests for dynamic terrain information.
virtual void processDrawDynamicTerrainTask (DtSimMessage *msg)
static void drawDynamicTerrainCallback (DtSimMessage *msg, void *usr)
 Processes the draw dynamic terrain 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 )()
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtDynamicTerrainMunitionDamageController is a controller that calculates and publishes terrain changes due to damage from munition detonations.

Uses Descriptor Type: DtDynamicTerrainMunitionDamageControllerDescriptor

Member Typedef Documentation

typedef tbb::spin_mutex DtDynamicTerrainController::Mutex
protected

Constructor & Destructor Documentation

DtDynamicTerrainController::DtDynamicTerrainController ( )
private

Not Implemented.

DtDynamicTerrainController::DtDynamicTerrainController ( const DtDynamicTerrainController orig)
private

Not Implemented.

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

Constructor.

virtual DtDynamicTerrainController::~DtDynamicTerrainController ( )
virtual

Destructor.

Member Function Documentation

DtDynamicTerrainController& DtDynamicTerrainController::operator= ( const DtDynamicTerrainController orig)
private

Not Implemented.

virtual bool DtDynamicTerrainController::init ( )
virtual

Init. Called immediately after construction.

Reimplemented from DtControllerComponent.

virtual void DtDynamicTerrainController::registerCallbacks ( )
virtual

Called by init to register any callbacks.

Reimplemented in DtDynamicTerrainMunitionDamageController.

virtual void DtDynamicTerrainController::deregisterCallbacks ( )
virtual

Called by destructor to deregister any callbacks.

Reimplemented in DtDynamicTerrainMunitionDamageController.

virtual void DtDynamicTerrainController::preFirstTickInit ( )
virtual

Publishes any dynamic terrain changes saved in PSR.

Reimplemented from DtSimComponent.

virtual const char* DtDynamicTerrainController::type ( ) const
virtual
Returns
DtDynamicTerrainMunitionDamageControllerType

Implements DtTaskControllerComponent.

Reimplemented in DtDynamicTerrainMunitionDamageController.

virtual void DtDynamicTerrainController::tick ( )
virtual

This component's simulation tick.

Reimplemented from DtSimComponent.

Reimplemented in DtDynamicTerrainMunitionDamageController.

virtual bool DtDynamicTerrainController::processDynamicTerrainSwitch ( const DtTerrainGeometry geometry,
const DtKeyValuePair change,
unsigned  priority,
double  delay = 0.0,
bool  shouldQueue = true 
)
virtual

Processes a command to add new changes to the dynamic terrain as individual switches.

If delay is greater than 0, the changes will not occur until the delay has elapsed. Returns true if data was available to process this switch.

virtual void DtDynamicTerrainController::processDynamicTerrainArea ( const DtTerrainGeometry geometry,
const DtKeyValuePairList changes,
unsigned  priority,
double  delay = 0.0 
)
virtual

Processes a command to add new changes to the dynamic terrain as one big change that stacks on top of any other changes in the area.

If delay is greater than 0, the changes will not occur until the delay has elapsed.

virtual DtRwDynamicTerrainItem* DtDynamicTerrainController::findDynamicTerrainSwitch ( const DtTerrainGeometry geometry,
double  tolerance,
const DtString key,
unsigned index = 0 
)
virtual

Finds an existing switch change that matches the given geometry within the given tolerance and the given key.

If not found, returns a null pointer. If specified, the index parameter will be set with the index of this item for faster access to updating publishers.

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

Static creator function for factory registration.

Reimplemented in DtDynamicTerrainMunitionDamageController.

virtual void DtDynamicTerrainController::updateTaskVisualizations ( )
virtual

Called to update task visualizations after every tick.

Implemented by subclasses.

Reimplemented from DtSimComponent.

virtual void DtDynamicTerrainController::processQueuedTerrainChanges ( double  dt)
virtual
virtual void DtDynamicTerrainController::setDynamicTerrainInformationRecheckPeriod ( double  )
virtual

The recheck period for checking dynamic terrain info requests.

Default is 0.5 seconds

virtual double DtDynamicTerrainController::dynamicTerrainInformationRecheckPeriod ( ) const
inlinevirtual
virtual std::list<DtVector> DtDynamicTerrainController::findDynamicTerrainElements ( const DtVector localLocation,
double  radius,
const DtString filterKey = DtString::nullString(),
std::list< DtRwDynamicTerrainInformation > *  fullInfo = 0,
bool dataAvailable = 0 
)
virtual

Finds all dynamic terrain nodes within the specified area and returns their location.

If filterKey is not null, only elements with that key will be returned. If fullInfo is provided, the full DtRwDynamicTerrainInformation is provided for each element.

virtual std::list<DtVector> DtDynamicTerrainController::findDynamicTerrainElements ( const DtVector localStartLocation,
const DtVector localEndLocation,
const DtString filterKey = DtString::nullString(),
std::list< DtRwDynamicTerrainInformation > *  fullInfo = 0,
bool dataAvailable = 0 
)
virtual

Finds all dynamic terrain nodes along the specified chord and returns their locations and keys.

If filterKey is not null, only elements with that key will be returned. If fullInfo is provided, the full DtRwDynamicTerrainInformation is provided for each element.

virtual void DtDynamicTerrainController::updateSingleSwitch ( const DtTerrainGeometry geometry,
const DtKeyValuePair change,
unsigned  priority 
)
protectedvirtual

Searches for an existing switch that matches, and if found, updates it with the new value.

If not found, a new switch is added.

static void DtDynamicTerrainController::addDynamicTerrainChangesCallback ( const DtSimCommand cmd,
void *  usr 
)
staticprotected

Processes commands to add new changes to dynamic terrain.

virtual void DtDynamicTerrainController::processAddDynamicTerrainChangesCommand ( const DtAddDynamicTerrainChangesCommand cmd)
protectedvirtual
static void DtDynamicTerrainController::switchDynamicTerrainCallback ( const DtSimCommand cmd,
void *  usr 
)
staticprotected

Processes commands to add new changes to dynamic terrain.

virtual bool DtDynamicTerrainController::processSwitchDynamicTerrainCommand ( const DtSwitchDynamicTerrainAtPointCommand cmd,
bool  shouldQueue = true 
)
protectedvirtual

Returns true if data was available to process this switch.

static void DtDynamicTerrainController::resetDynamicTerrainChangesCallback ( const DtSimCommand cmd,
void *  usr 
)
staticprotected

Processes commands to reset changes to dynamic terrain.

virtual void DtDynamicTerrainController::processResetDynamicTerrainChangesCommand ( const DtResetDynamicTerrainChangesCommand cmd)
protectedvirtual
virtual bool DtDynamicTerrainController::isRequestValidForArea ( const DtIfRequestDynamicTerrainInformation req)
protectedvirtual

Returns true if the geometry for the request is within our area of control.

virtual bool DtDynamicTerrainController::isCommandValidForArea ( const DtDynamicTerrainCommand cmd)
protectedvirtual

Returns true if the geometry for the command is within our area of control.

virtual bool DtDynamicTerrainController::isInCommandGeometry ( const DtDynamicTerrainCommand cmd,
const DtTerrainGeometry terrainGeometry 
)
protectedvirtual

Returns true if the terrain change lies within the area specified in the command.

DtVector DtDynamicTerrainController::averageLocation ( const DtRwVectorList vectorList) const
protected

Computes the average location from a list of locations.

DtVector DtDynamicTerrainController::averageLocation ( const DtWorldLocationStructArray vectorList) const
protected
static void DtDynamicTerrainController::dynamicTerrainInformationRequestCallback ( DtSimMessage ,
void *  usr 
)
staticprotected

Processes requests for dynamic terrain information.

virtual void DtDynamicTerrainController::processDynamicTerrainInformationRequest ( DtIfRequestDynamicTerrainInformation )
protectedvirtual
virtual bool DtDynamicTerrainController::processPendingDynamicTerrainInformation ( PendingDynamicTerrainInformationPtr )
protectedvirtual

Processes a pending dynamic terrain information request.

If results are discovered, sends a response. If not sent returns false.

Reimplemented in DtDynamicTerrainMunitionDamageController.

static void DtDynamicTerrainController::drawDynamicTerrainCallback ( DtSimMessage msg,
void *  usr 
)
staticprotected

Processes the draw dynamic terrain task.

virtual void DtDynamicTerrainController::processDrawDynamicTerrainTask ( DtSimMessage msg)
protectedvirtual
virtual DtDynamicTerrainPublisher* DtDynamicTerrainController::createPublisher ( )
protectedvirtual

Creates a publisher.

virtual DtDynamicTerrainControllerPSR* DtDynamicTerrainController::createPSR ( )
protectedvirtual

Create the PSR.

virtual void DtDynamicTerrainController::addPublishedChange ( std::vector< DtDynamicTerrainPublisher * > &  publishers,
const DtTerrainGeometryAndData change 
)
protectedvirtual

Adds a new change geometry to the publisher list. Creates a new publisher if necessary.

virtual void DtDynamicTerrainController::updatePublishedChange ( std::vector< DtDynamicTerrainPublisher * > &  publishers,
unsigned  index,
const DtKeyValuePairList changeData,
unsigned  priority,
unsigned  eventNumber 
)
protectedvirtual

Updates an existing published change, finding the item in the correct publisher in the list based on the index.

virtual const DtTerrainGeometryAndData& DtDynamicTerrainController::publishedChange ( const std::vector< DtDynamicTerrainPublisher * > &  publishers,
unsigned  index 
) const
protectedvirtual

Returns the geometry and data for the published change at the given index.

Member Data Documentation

DtDynamicTerrainControllerDescriptor* DtDynamicTerrainController::myDynamicTerrainDescriptor
protected
DtDynamicTerrainControllerPSR* DtDynamicTerrainController::myProcessState
protected

Container for state data associated with this component.

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

std::vector<DtDynamicTerrainPublisher*> DtDynamicTerrainController::myIndividualSwitchPublishers
protected

Publishes the dynamic terrain changes for individual switches to the network.

std::vector<DtDynamicTerrainPublisher*> DtDynamicTerrainController::myAreaPublishers
protected

Publishes the dynamic terrain changes for a whole area to the network.

PendingDynamicTerrainRequests DtDynamicTerrainController::myPendingDynamicTerrainRequests
protected
double DtDynamicTerrainController::myDynamicTerrainRecheckPeriod
protected
double DtDynamicTerrainController::myLastTickRealTime
protected
Mutex DtDynamicTerrainController::myTerrainFeatureMutex
mutableprotected
std::list<QueuedTerrainSwitch> DtDynamicTerrainController::myTerrainSwitchQueue
protected
std::list<DtSwitchDynamicTerrainAtPointCommand> DtDynamicTerrainController::myTerrainSwitchAtPointQueue
protected

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)