DtScriptedObjectsMovementManager Class Reference

The scripted objects movement manager contains a list of all scripted movement objects that can be used in scripted movement. Scripted movement (sometimes called "animated movement") consists of strictly planned entity movement relative to a starting position and heading. Please see the DtScriptedMovementObject for more details on what is specified in a scripted movement object.

Public Types
typedef std::map< std::string, DtScriptedMovementObject >	ScriptedMovementObjects

Public Member Functions
	DtScriptedObjectsMovementManager (DtSimulationServices *)
virtual	~DtScriptedObjectsMovementManager ()
virtual DtSimulationServices *	simulationServices () const
virtual void	removeAllScriptedMovementObjects ()
virtual bool	loadScriptedMovementObjects (const DtFilename &dir, bool append=false)
virtual void	addScriptedMovementObject (const DtScriptedMovementObject &)
virtual bool	removeScriptedMovementObject (const std::string &)
virtual const ScriptedMovementObjects &	scriptedMovementObjects () const
virtual void	setScriptedMovementObjects (const ScriptedMovementObjects &)
virtual bool	scriptedMovementObject (const std::string &objectToFind, DtScriptedMovementObject &object) const
virtual DtString	fileConfigurationFor (const std::string &uniqueId) const

Protected Types
typedef std::map< std::string, DtScriptedMovementFileConfiguration >	MovementFileConfigurations

Protected Member Functions
virtual void	processScriptedMovementObjectsRequest (DtSimMessage *msg)

Static Protected Member Functions
static void	scriptedMovementObjectsRequestCallback (DtSimMessage *msg, void *usr)

Protected Attributes
DtSimulationServices *	mySimulationServices
ScriptedMovementObjects	myScriptedMovementObjects
MovementFileConfigurations	myMovementFileConfigurations

Private Member Functions
	DtScriptedObjectsMovementManager (const DtScriptedObjectsMovementManager &orig)
DtScriptedObjectsMovementManager &	operator= (const DtScriptedObjectsMovementManager &orig)

Member Typedef Documentation

typedef std::map<std::string, DtScriptedMovementObject> DtScriptedObjectsMovementManager::ScriptedMovementObjects

typedef std::map<std::string, DtScriptedMovementFileConfiguration> DtScriptedObjectsMovementManager::MovementFileConfigurations

protected

Constructor & Destructor Documentation

DtScriptedObjectsMovementManager::DtScriptedObjectsMovementManager

(

DtSimulationServices *

)

CTOR.

virtual DtScriptedObjectsMovementManager::~DtScriptedObjectsMovementManager ( )

virtual

DTOR.

DtScriptedObjectsMovementManager::DtScriptedObjectsMovementManager ( const DtScriptedObjectsMovementManager &  orig )

private

copy constructor

Member Function Documentation

DtScriptedObjectsMovementManager& DtScriptedObjectsMovementManager::operator= ( const DtScriptedObjectsMovementManager &  orig )

private

assignment operator

virtual DtSimulationServices* DtScriptedObjectsMovementManager::simulationServices ( ) const

virtual

virtual void DtScriptedObjectsMovementManager::removeAllScriptedMovementObjects ( )

virtual

Removes all the current scripted movement objects from the manager.

virtual bool DtScriptedObjectsMovementManager::loadScriptedMovementObjects ( const DtFilename &  dir, bool  append = false  )

virtual

Reads all the mtl files from the given directory and adds any scripted movement objects it finds into the manager. The final flag being true will append items. Returns true if any objects were loaded from the directory.

virtual void DtScriptedObjectsMovementManager::addScriptedMovementObject ( const DtScriptedMovementObject &  )

virtual

Adds a new scripted movement object into the manager. If named object exists, replaces.

virtual bool DtScriptedObjectsMovementManager::removeScriptedMovementObject ( const std::string &  )

virtual

Removes the named scripted movement object.

virtual const ScriptedMovementObjects& DtScriptedObjectsMovementManager::scriptedMovementObjects ( ) const

virtual

Returns the list of scripted movement objects.

virtual void DtScriptedObjectsMovementManager::setScriptedMovementObjects ( const ScriptedMovementObjects &  )

virtual

Sets the scripted movement objects.

virtual bool DtScriptedObjectsMovementManager::scriptedMovementObject ( const std::string &  objectToFind, DtScriptedMovementObject &  object  ) const

virtual

Fills in the scripted movement object for the specified object an returns true if the object is found.

virtual DtString DtScriptedObjectsMovementManager::fileConfigurationFor ( const std::string &  uniqueId ) const

virtual

Given the file configuration unique id, looks up movement file configuration and then sees if that unique id exists. If it does, returns the string representation of the movement file configuration, else returns the id passed in.

static void DtScriptedObjectsMovementManager::scriptedMovementObjectsRequestCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Callback for request for fly out files.

virtual void DtScriptedObjectsMovementManager::processScriptedMovementObjectsRequest ( DtSimMessage *  msg )

protectedvirtual

Member Data Documentation

DtSimulationServices* DtScriptedObjectsMovementManager::mySimulationServices

protected

ScriptedMovementObjects DtScriptedObjectsMovementManager::myScriptedMovementObjects

protected

MovementFileConfigurations DtScriptedObjectsMovementManager::myMovementFileConfigurations

protected

---

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

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