VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Types | Protected Attributes
DtMovementFile Class Reference

This class will load in and return data from a movement file. More...

Public Member Functions

 DtMovementFile ()
 CTOR.
virtual ~DtMovementFile ()
 DTOR.
 DtMovementFile (const DtMovementFile &)
 Copy constructor.
DtMovementFileoperator= (const DtMovementFile &)
 Assignemtn operator.
virtual double simTime (int) const
 Returns the simTime at the given offset, or 0 if greater than current number of rows loaded or there is no configuration.
virtual int numRows () const
 Returns the number of rows currently read in.
virtual DtVector bodyOffsetVector (int row) const
 Returns the body offset at the given row, or zero if the row is greater than the number of rows read or there is no configuration.
virtual bool isLoaded () const
 Returns true if there are more than 0 rows read in.
virtual bool load (const DtFilename &file, const DtScriptedMovementFileConfiguration &configuration, int rowsToLoad=-1)
 Loads from the specified file, given the configuration and the number of rows to load.
virtual int movementRow (double) const
 Returns the row that matches the given sim time. If not loaded returns -1.

Protected Types

typedef std::vector< double > MovementRow
typedef std::vector< MovementRowMovementFileData

Protected Attributes

DtScriptedMovementFileConfiguration myConfiguration
MovementFileData myMovementFileData

Detailed Description

This class will load in and return data from a movement file.

Member Typedef Documentation

typedef std::vector<double> DtMovementFile::MovementRow
protected
typedef std::vector<MovementRow> DtMovementFile::MovementFileData
protected

Constructor & Destructor Documentation

DtMovementFile::DtMovementFile ( )

CTOR.

virtual DtMovementFile::~DtMovementFile ( )
virtual

DTOR.

DtMovementFile::DtMovementFile ( const DtMovementFile )

Copy constructor.

Member Function Documentation

DtMovementFile& DtMovementFile::operator= ( const DtMovementFile )

Assignemtn operator.

virtual double DtMovementFile::simTime ( int  ) const
virtual

Returns the simTime at the given offset, or 0 if greater than current number of rows loaded or there is no configuration.

virtual int DtMovementFile::numRows ( ) const
virtual

Returns the number of rows currently read in.

virtual DtVector DtMovementFile::bodyOffsetVector ( int  row) const
virtual

Returns the body offset at the given row, or zero if the row is greater than the number of rows read or there is no configuration.

virtual bool DtMovementFile::isLoaded ( ) const
virtual

Returns true if there are more than 0 rows read in.

virtual bool DtMovementFile::load ( const DtFilename &  file,
const DtScriptedMovementFileConfiguration configuration,
int  rowsToLoad = -1 
)
virtual

Loads from the specified file, given the configuration and the number of rows to load.

If -1 reads all available rows

virtual int DtMovementFile::movementRow ( double  ) const
virtual

Returns the row that matches the given sim time. If not loaded returns -1.

Member Data Documentation

DtScriptedMovementFileConfiguration DtMovementFile::myConfiguration
protected
MovementFileData DtMovementFile::myMovementFileData
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)