DtTerrainFileLocations Class Reference

This class holds directory locations where the terrain interface can find all of its configuration files and DLL's. More...

Public Member Functions
virtual void	setDataPath (const std::string &)
	Sets the path to find for the data directory.
virtual std::string	dataPath () const
virtual void	setUserDataPath (const std::string &)
	Sets the path to find for the data directory.
virtual std::string	userDataPath () const
virtual void	setAppDataPath (const std::string &)
	Sets the path to find for the appdata directory (default to ../appData)
virtual std::string	appDataPath () const
virtual void	setPluginsPath (const std::string &)
	Sets the path to find for the plugins directory (default to ../plugins)
virtual std::string	pluginsPath () const
virtual void	setModelDefinitionPath (const std::string &)
	Sets the path to the model definition file (default to /definitions/Model Definitions.ommx)
virtual std::string	modelDefinitionPath () const
virtual void	replaceAll (std::string &searchText)
	searches for know strings and replaces them in the given string.
virtual void	replaceString (std::string &searchText, const std::string &stringToFind, const std::string &stringToReplace)
	searches for stringToFind in the searchText and replaces it with stringToReplace

Static Public Member Functions
static DtTerrainFileLocations *	instance ()
	Returns the instance of this singleton.

Protected Member Functions
	DtTerrainFileLocations ()
	this class is a singleton
virtual	~DtTerrainFileLocations ()

Protected Attributes
std::string	myDataPath
std::string	myUserDataPath
std::string	myAppDataPath
std::string	myPluginsPath
std::string	myModelDefinitionPath

Static Protected Attributes
static DtTerrainFileLocations *	theInstance

Private Member Functions
	DtTerrainFileLocations (const DtTerrainFileLocations &orig)
	Not implemented.
DtTerrainFileLocations &	operator= (const DtTerrainFileLocations &orig)
	Not implemented.

Detailed Description

This class holds directory locations where the terrain interface can find all of its configuration files and DLL's.

Constructor & Destructor Documentation

DtTerrainFileLocations::DtTerrainFileLocations ( const DtTerrainFileLocations &  orig )

private

Not implemented.

DtTerrainFileLocations::DtTerrainFileLocations ( )

protected

this class is a singleton

virtual DtTerrainFileLocations::~DtTerrainFileLocations ( )

protectedvirtual

Member Function Documentation

DtTerrainFileLocations& DtTerrainFileLocations::operator= ( const DtTerrainFileLocations &  orig )

private

Not implemented.

static DtTerrainFileLocations* DtTerrainFileLocations::instance ( )

static

Returns the instance of this singleton.

virtual void DtTerrainFileLocations::setDataPath ( const std::string &  )

virtual

Sets the path to find for the data directory.

For terrains being loaded, will substitute DataDirectory for the dataPath (default to ../data)

virtual std::string DtTerrainFileLocations::dataPath ( ) const

virtual

virtual void DtTerrainFileLocations::setUserDataPath ( const std::string &  )

virtual

Sets the path to find for the data directory.

For terrains being loaded, will substitute UserDataDirectory to the user data path (default to ../userData)

virtual std::string DtTerrainFileLocations::userDataPath ( ) const

virtual

virtual void DtTerrainFileLocations::setAppDataPath ( const std::string &  )

virtual

Sets the path to find for the appdata directory (default to ../appData)

virtual std::string DtTerrainFileLocations::appDataPath ( ) const

virtual

virtual void DtTerrainFileLocations::setPluginsPath ( const std::string &  )

virtual

Sets the path to find for the plugins directory (default to ../plugins)

virtual std::string DtTerrainFileLocations::pluginsPath ( ) const

virtual

virtual void DtTerrainFileLocations::setModelDefinitionPath ( const std::string &  )

virtual

Sets the path to the model definition file (default to /definitions/Model Definitions.ommx)

virtual std::string DtTerrainFileLocations::modelDefinitionPath ( ) const

virtual

virtual void DtTerrainFileLocations::replaceAll ( std::string &  searchText )

virtual

searches for know strings and replaces them in the given string.

The search strings are APP_DIR, DATA_DIR, USER_DIR, and PLUGINS_DIR

virtual void DtTerrainFileLocations::replaceString ( std::string &  searchText, const std::string &  stringToFind, const std::string &  stringToReplace  )

virtual

searches for stringToFind in the searchText and replaces it with stringToReplace

Member Data Documentation

DtTerrainFileLocations* DtTerrainFileLocations::theInstance

staticprotected

std::string DtTerrainFileLocations::myDataPath

protected

std::string DtTerrainFileLocations::myUserDataPath

protected

std::string DtTerrainFileLocations::myAppDataPath

protected

std::string DtTerrainFileLocations::myPluginsPath

protected

std::string DtTerrainFileLocations::myModelDefinitionPath

protected

---

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

• include/terrainInterface/terrainFileLocations.h