makArchives::DtSceneRecord Class Reference

A record for describing a scene.

Public Member Functions
	DtSceneRecord ()
	DtSceneRecord (const DtSceneRecord &)
DtSceneRecord &	operator= (const DtSceneRecord &)
virtual	~DtSceneRecord ()
const DtTerrainRecord &	terrainRecord () const
const std::string &	terrainFilename () const
void	setTerrainFilename (const std::string &filename)
const DtEnvironmentRecord &	environmentRecord () const
void	setEnvironmentRecord (const DtEnvironmentRecord &record)
const DtDateTimeRecord &	dateTimeRecord () const
void	setDateTimeRecord (const DtDateTimeRecord &record)
virtual void	setDescription (const std::string &description)
virtual const std::string &	description () const

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Protected Attributes
DtTerrainRecord	myEmbeddedTerrainRecord
DtEnvironmentRecord	myEmbeddedEnvironmentRecord
DtDateTimeRecord	myEmbeddedDateTimeRecord
std::string	myTerrainFilename
std::string	myDescription

Friends
class	boost::serialization::access

Constructor & Destructor Documentation

makArchives::DtSceneRecord::DtSceneRecord

(

)

CTOR.

makArchives::DtSceneRecord::DtSceneRecord

(

const DtSceneRecord &

)

CCTOR.

virtual makArchives::DtSceneRecord::~DtSceneRecord ( )

virtual

DTOR.

Member Function Documentation

DtSceneRecord& makArchives::DtSceneRecord::operator=

(

const DtSceneRecord &

)

Assignment Op.

const DtTerrainRecord& makArchives::DtSceneRecord::terrainRecord

(

)

const

Attempt to get the embedded terrain record. Will be empty for version 2 and higher.

const std::string& makArchives::DtSceneRecord::terrainFilename

(

)

const

Get the terrain filename (this will be "" if the scene record is not version 2 or higher). In that case, use terrainRecord()

void makArchives::DtSceneRecord::setTerrainFilename

(

const std::string &

filename

)

Sets the embedded terrain record.

const DtEnvironmentRecord& makArchives::DtSceneRecord::environmentRecord

(

)

const

Attempt to get the embedded terrain record.

void makArchives::DtSceneRecord::setEnvironmentRecord

(

const DtEnvironmentRecord &

record

)

Sets the embedded terrain record.

const DtDateTimeRecord& makArchives::DtSceneRecord::dateTimeRecord

(

)

const

Attempt to get the embedded date and time record.

void makArchives::DtSceneRecord::setDateTimeRecord

(

const DtDateTimeRecord &

record

)

Sets the embedded date and time record.

virtual void makArchives::DtSceneRecord::setDescription ( const std::string &  description )

virtual

Set the scene description.

virtual const std::string& makArchives::DtSceneRecord::description ( ) const

virtual

Get the scene description.

template<class Archive >

void makArchives::DtSceneRecord::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

Member Data Documentation

DtTerrainRecord makArchives::DtSceneRecord::myEmbeddedTerrainRecord

mutableprotected

DtEnvironmentRecord makArchives::DtSceneRecord::myEmbeddedEnvironmentRecord

mutableprotected

DtDateTimeRecord makArchives::DtSceneRecord::myEmbeddedDateTimeRecord

protected

std::string makArchives::DtSceneRecord::myTerrainFilename

protected

std::string makArchives::DtSceneRecord::myDescription

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/makArchives/DtSceneRecord.h