makVrv::DtScene Class Reference

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

List of all members.

Public Member Functions
	DtScene (DtDe &de, DtAgentManagerInterface &agentManager)
	CTOR.
virtual	~DtScene ()
	DTOR.
void	getRecord (makArchives::DtSceneRecord &record) const
	Get the record for the scene.
void	setFromRecord (const makArchives::DtSceneRecord &record)
	Set the scene via the record.
bool	saveTerrain (const std::string &filePath, bool saveAs=true)
	Save the terrain to a file.
bool	loadTerrain (const std::string &filePath)
	Load the terrain from a file.
bool	saveEnvironment (const std::string &filePath, bool saveAs=true)
	Save the environment to a file.
bool	loadEnvironment (const std::string &filePath)
	Load the environment to a file.
virtual void	resetScene ()
	Reset both the terrain and the environment.
virtual void	resetTerrain ()
	Reset just the terrain.
virtual DtFeature *	findFeature (DtElementID id)
	Gets a pointer to the feature matching with the given element id.
virtual bool	destroyFeature (DtElementID id)
	Destroys the feature.
const std::string &	terrainFileName () const
	Get the loaded terrain filename.
const std::string &	enviromentFileName () const
	Get the loaded environment filename.
DtTerrain &	terrain ()
	accessor for the DtTerrain object
const DtTerrain &	terrain () const
	accessor for the DtTerrain object
DtEnvironment &	environment ()
	accessor for the DtEnvironment object
const DtEnvironment &	environment () const
	accessor for the DtEnvironment object
Protected Member Functions
void	copyPropReferences (DtTerrainLayer *patch, DtScene::ScenePropReferences &spRefs)
Protected Attributes
DtDe &	myDe
DtTerrain *	myTerrain
DtEnvironment *	myEnvironment
DtSceneSignaler &	mySignaler
std::string	myTerrainFileName
std::string	myEnviromentFileName
typedef std::vector< DtProp * >	ScenePropReferences
	Prop functions.
virtual void	getScenePropReferences (ScenePropReferences &props)
	Gets the list of references to scene props.
virtual DtProp *	findProp (DtElementID id)
	Gets a pointer to the scene prop matching the passed in prop object.
virtual bool	destroyProp (DtElementID id)
	Destroys the prop.

---

Detailed Description

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

---

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 std::string &

filePath

)

Load the terrain from a file.

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 to a file.

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.

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]

std::string makVrv::DtScene::myTerrainFileName [protected]

std::string makVrv::DtScene::myEnviromentFileName [protected]

---

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

• include/vrvCore/DtScene.h