DtScriptedMovementPhase Class Reference

The DtScriptedMovementPhase class defines a deployment phase for this scripted object. More...

Public Types
enum	CompletionRule { Detonate = 0, DetonateAndRemove, Remove, StayAround }

Public Member Functions
	DtScriptedMovementPhase ()
	CTOR.
virtual	~DtScriptedMovementPhase ()
	DTOR.
	DtScriptedMovementPhase (const DtScriptedMovementPhase &)
	Copy constructor.
DtScriptedMovementPhase &	operator= (const DtScriptedMovementPhase &)
	Assignment operator.
virtual void	setMovementFile (const std::string &)
	Sets the movement file to use.
virtual const std::string &	movementFile () const
virtual void	setCompletionRule (CompletionRule)
	Sets what to do with the object when the movement is complete.
virtual CompletionRule	completionRule () const
virtual void	setGroundClamp (bool)
	Sets whether or not to ground clamp the object while moving. Default is false.
virtual bool	groundClamp () const
virtual void	setEntityType (const DtEntityType &)
	Sets the type of object to create as part of this phase.
virtual DtEntityType	entityType () const
virtual bool	canBePerformed (double deltaTime) const
	Returns true if the phase can be performed at this simTime.
virtual bool	canStillBePerformed (double deltatTime) const
	Returns true if the phase can still be performed, even though it might not be able to be performed yet.
virtual bool	loadMovementFile (const DtFilename &rootPath, const DtScriptedMovementFileConfiguration &, int rowsToLoad=-1)
	Load the movement file and return true if loaded.
virtual bool	isLoaded () const
	Returns whether or not file is loaded.
virtual double	simTime (int row) const
	Returns the sim time (in seconds) at the specified row. File must be loaded, else will return 0.
virtual DtVector	bodyOffsetVector (int row) const
	Returns the body offset vector at the specified row. If file is not loaded will return NULL vector.
virtual void	setSimulationStartTimeOffset (double t)
	Offset time to add to the simTime in the given row. Default is 0.
virtual double	simulationStartTimeOffset () const
	Offset time.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
std::string	myMovementFile
CompletionRule	myCompletionRule
bool	myGroundClamp
std::string	myEntityType
DtMovementFile	myMovementFileData
double	mySimulationStartTimeOffset

Friends
class	boost::serialization::access
	Serialization/Deserialization //.

Detailed Description

The DtScriptedMovementPhase class defines a deployment phase for this scripted object.

Each phase will create a new object and assign a movement file to it. The phase will be considered to be started at the first rows time in the movement file, offset from when the scripted movement began. The times are considered simulation time offsets

Member Enumeration Documentation

enum DtScriptedMovementPhase::CompletionRule

Enumerator:

Detonate
DetonateAndRemove
Remove
StayAround

Constructor & Destructor Documentation

DtScriptedMovementPhase::DtScriptedMovementPhase

(

)

CTOR.

virtual DtScriptedMovementPhase::~DtScriptedMovementPhase ( )

virtual

DTOR.

DtScriptedMovementPhase::DtScriptedMovementPhase

(

const DtScriptedMovementPhase &

)

Copy constructor.

Member Function Documentation

DtScriptedMovementPhase& DtScriptedMovementPhase::operator=

(

const DtScriptedMovementPhase &

)

Assignment operator.

virtual void DtScriptedMovementPhase::setMovementFile ( const std::string &  )

virtual

Sets the movement file to use.

The file is considered relative to where the original scripted movement object was loaded from. If there is no path for the original scripted movement object the applications start path will be used

virtual const std::string& DtScriptedMovementPhase::movementFile ( ) const

virtual

virtual void DtScriptedMovementPhase::setCompletionRule ( CompletionRule  )

virtual

Sets what to do with the object when the movement is complete.

Default is DetonateAndRemove

virtual CompletionRule DtScriptedMovementPhase::completionRule ( ) const

virtual

virtual void DtScriptedMovementPhase::setGroundClamp ( bool  )

virtual

Sets whether or not to ground clamp the object while moving. Default is false.

virtual bool DtScriptedMovementPhase::groundClamp ( ) const

virtual

virtual void DtScriptedMovementPhase::setEntityType ( const DtEntityType &  )

virtual

Sets the type of object to create as part of this phase.

virtual DtEntityType DtScriptedMovementPhase::entityType ( ) const

virtual

virtual bool DtScriptedMovementPhase::canBePerformed ( double  deltaTime ) const

virtual

Returns true if the phase can be performed at this simTime.

Movement file must be loaded for this check to succeed

virtual bool DtScriptedMovementPhase::canStillBePerformed ( double  deltatTime ) const

virtual

Returns true if the phase can still be performed, even though it might not be able to be performed yet.

virtual bool DtScriptedMovementPhase::loadMovementFile ( const DtFilename &  rootPath, const DtScriptedMovementFileConfiguration &  , int  rowsToLoad = -1  )

virtual

Load the movement file and return true if loaded.

If rowsToLoad is -1 loads all rows, else just loads up the number of specified rows

virtual bool DtScriptedMovementPhase::isLoaded ( ) const

virtual

Returns whether or not file is loaded.

virtual double DtScriptedMovementPhase::simTime ( int  row ) const

virtual

Returns the sim time (in seconds) at the specified row. File must be loaded, else will return 0.

virtual DtVector DtScriptedMovementPhase::bodyOffsetVector ( int  row ) const

virtual

Returns the body offset vector at the specified row. If file is not loaded will return NULL vector.

virtual void DtScriptedMovementPhase::setSimulationStartTimeOffset ( double  t )

virtual

Offset time to add to the simTime in the given row. Default is 0.

virtual double DtScriptedMovementPhase::simulationStartTimeOffset ( ) const

virtual

Offset time.

template<class Archive >

void DtScriptedMovementPhase::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Serialization/Deserialization //.

Member Data Documentation

std::string DtScriptedMovementPhase::myMovementFile

protected

CompletionRule DtScriptedMovementPhase::myCompletionRule

protected

bool DtScriptedMovementPhase::myGroundClamp

protected

std::string DtScriptedMovementPhase::myEntityType

protected

DtMovementFile DtScriptedMovementPhase::myMovementFileData

protected

double DtScriptedMovementPhase::mySimulationStartTimeOffset

protected

---

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

• include/vrfutil/scriptedMovementObject.h