makVrv::DtScene Class Reference

An object that represents everything that is visible in the scene.

Public Member Functions
	DtScene (DtDe &de, DtAgentManagerInterface &agentManager)
virtual	~DtScene ()
void	getRecord (makArchives::DtSceneRecord &record) const
void	setFromRecord (const makArchives::DtSceneRecord &record)
bool	saveTerrain (const std::string &filePath, bool saveAs=true)
bool	loadTerrain (const DtUnicode &filePath)
bool	loadTerrain (const std::string &filePath)
bool	loadTerrain (const makArchives::DtTerrainRecord &terrainRecord)
void	reloadTerrain ()
bool	saveEnvironment (const std::string &filePath, bool saveAs=true)
bool	loadEnvironment (const std::string &filePath)
bool	loadEnvironment (const makArchives::DtEnvironmentRecord &envRecord)
bool	loadDateAndTime (const makArchives::DtDateTimeRecord &dateTimeRecord)
virtual void	resetScene ()
virtual void	resetTerrain ()
virtual DtFeature *	findFeature (DtElementID id)
virtual bool	destroyFeature (DtElementID id)
const std::string &	terrainFileName () const
const std::string &	enviromentFileName () const
DtStreamedFeatureManager *const	streamedFeatureManager () const
DtStreamedFeatureManager *	streamedFeatureManager ()
virtual const std::string &	description ()
virtual void	setDescription (const std::string &description)
DtTerrain &	terrain ()
const DtTerrain &	terrain () const
DtEnvironment &	environment ()
const DtEnvironment &	environment () const

Protected Member Functions
void	copyPropReferences (DtTerrainLayer *patch, DtScene::ScenePropReferences &spRefs)

Protected Attributes
DtDe &	myDe
DtTerrain *	myTerrain
DtEnvironment *	myEnvironment
DtSceneSignaler &	mySignaler
DtStreamedFeatureManager *	myStreamedFeatureManager
std::string	myTerrainFileName
std::string	myEnviromentFileName
std::string	myDescription
typedef std::vector< DtProp * >	ScenePropReferences
virtual void	getScenePropReferences (ScenePropReferences &props)
virtual DtProp *	findProp (DtElementID id)
virtual bool	destroyProp (DtElementID id)

Member Typedef Documentation

typedef std::vector<DtProp*> makVrv::DtScene::ScenePropReferences

Prop functions.

A list of references to scene props

Constructor & Destructor Documentation

makVrv::DtScene::DtScene	(	DtDe &	de,
		DtAgentManagerInterface &	agentManager
	)

CTOR.

virtual makVrv::DtScene::~DtScene ( )

virtual

DTOR.

Member Function Documentation

DtTerrain& makVrv::DtScene::terrain ( )

inline

accessor for the DtTerrain object

const DtTerrain& makVrv::DtScene::terrain ( ) const

inline

accessor for the DtTerrain object

void makVrv::DtScene::getRecord

(

makArchives::DtSceneRecord &

record

)

const

Get the record for the scene.

void makVrv::DtScene::setFromRecord

(

const makArchives::DtSceneRecord &

record

)

Set the scene via the record.

bool makVrv::DtScene::saveTerrain	(	const std::string &	filePath,
		bool	saveAs = true
	)

Save the terrain to a file.

Parameters

Input
filePath	the location of the file to save.
saveAs	whether the Scene should save the filePath as the filename of the current terrain.

bool makVrv::DtScene::loadTerrain

(

const DtUnicode &

filePath

)

Load the terrain from a file.

bool makVrv::DtScene::loadTerrain

(

const std::string &

filePath

)

Load the terrain from a file.

bool makVrv::DtScene::loadTerrain

(

const makArchives::DtTerrainRecord &

terrainRecord

)

load the terrain from a terrain record.

void makVrv::DtScene::reloadTerrain

(

)

reload the terrain from the current terrain record.

DtEnvironment& makVrv::DtScene::environment ( )

inline

accessor for the DtEnvironment object

const DtEnvironment& makVrv::DtScene::environment ( ) const

inline

accessor for the DtEnvironment object

bool makVrv::DtScene::saveEnvironment	(	const std::string &	filePath,
		bool	saveAs = true
	)

Save the environment to a file.

Parameters

Input
filePath	the location of the file to save.
saveAs	whether the Scene should save the filePath as the filename of the current environment.

bool makVrv::DtScene::loadEnvironment

(

const std::string &

filePath

)

Load the environment from a file.

bool makVrv::DtScene::loadEnvironment

(

const makArchives::DtEnvironmentRecord &

envRecord

)

Load the environment from an environment record.

bool makVrv::DtScene::loadDateAndTime

(

const makArchives::DtDateTimeRecord &

dateTimeRecord

)

Load the date and time from a date/time record.

virtual void makVrv::DtScene::resetScene ( )

virtual

Reset both the terrain and the environment.

virtual void makVrv::DtScene::resetTerrain ( )

virtual

Reset just the terrain.

virtual void makVrv::DtScene::getScenePropReferences ( ScenePropReferences &  props )

virtual

Gets the list of references to scene props.

virtual DtProp* makVrv::DtScene::findProp ( DtElementID  id )

virtual

Gets a pointer to the scene prop matching the passed in prop object.

Warning

Do not delete this pointer. Use destroyProp instead.

virtual bool makVrv::DtScene::destroyProp ( DtElementID  id )

virtual

Destroys the prop. Returns true if the prop was destroyed, false otherwise.

virtual DtFeature* makVrv::DtScene::findFeature ( DtElementID  id )

virtual

Gets a pointer to the feature matching with the given element id.

virtual bool makVrv::DtScene::destroyFeature ( DtElementID  id )

virtual

Destroys the feature. Returns true if the prop was destroyed, false otherwise.

const std::string& makVrv::DtScene::terrainFileName

(

)

const

Get the loaded terrain filename.

const std::string& makVrv::DtScene::enviromentFileName

(

)

const

Get the loaded environment filename.

DtStreamedFeatureManager* const makVrv::DtScene::streamedFeatureManager

(

)

const

DtStreamedFeatureManager* makVrv::DtScene::streamedFeatureManager

(

)

virtual const std::string& makVrv::DtScene::description ( )

virtual

Get the scene's description.

virtual void makVrv::DtScene::setDescription ( const std::string &  description )

virtual

Set the scene's description.

void makVrv::DtScene::copyPropReferences ( DtTerrainLayer *  patch, DtScene::ScenePropReferences &  spRefs  )

protected

Member Data Documentation

DtDe& makVrv::DtScene::myDe

protected

DtTerrain* makVrv::DtScene::myTerrain

protected

DtEnvironment* makVrv::DtScene::myEnvironment

protected

DtSceneSignaler& makVrv::DtScene::mySignaler

protected

DtStreamedFeatureManager* makVrv::DtScene::myStreamedFeatureManager

protected

std::string makVrv::DtScene::myTerrainFileName

protected

std::string makVrv::DtScene::myEnviromentFileName

protected

std::string makVrv::DtScene::myDescription

protected

---

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

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