DtTerrainCapabilities Class Reference

This class holds parameters which define the capabilities of the current terrain. More...

List of all members.

Public Member Functions
	DtTerrainCapabilities ()
virtual	~DtTerrainCapabilities ()
virtual DtString	capabilityValue (const DtString &key) const
virtual void	setCapabilityValue (const DtString &key, const DtString &value)
	Sets teh capability value for the specified key.
virtual void	clearCapability (const DtString &key)
	Clears the specified capability key and any value associated.
virtual const std::map < DtString, DtString > &	capabilityMap () const
virtual bool	supportsTerrainPreload () const
	Indicates whether or not the loaded terrain responds to terrainPreloadAreas() calls.
virtual void	setSupportsTerrainPreload (bool value)
	Indicates whether or not the loaded terrain responds to terrainPreloadAreas() calls.
Protected Attributes
bool	mySupportsTerrainPreload
std::map< DtString, DtString >	myCapabilitiesMap
Private Member Functions
	DtTerrainCapabilities (const DtTerrainCapabilities &orig)
	Not implemented.
DtTerrainCapabilities &	operator= (const DtTerrainCapabilities &orig)
	Not implemented.

---

Detailed Description

This class holds parameters which define the capabilities of the current terrain.

The terrain implementation defines the capabilities of the terrain, and users of the DtTerrainInterface and query for these capabilities. Some capability parameters are defined directly here, and there is also a free-form string map where other terrain capabilities can be defined by the terrain implementation using a key-value pair type of structure.

---

Constructor & Destructor Documentation

DtTerrainCapabilities::DtTerrainCapabilities

(

const DtTerrainCapabilities &

orig

)

[private]

Not implemented.

DtTerrainCapabilities::DtTerrainCapabilities

(

)

virtual DtTerrainCapabilities::~DtTerrainCapabilities

(

)

[virtual]

---

Member Function Documentation

DtTerrainCapabilities& DtTerrainCapabilities::operator=

(

const DtTerrainCapabilities &

orig

)

[private]

Not implemented.

virtual bool DtTerrainCapabilities::supportsTerrainPreload

(

)

const [virtual]

Indicates whether or not the loaded terrain responds to terrainPreloadAreas() calls.

If false, the terrainPreloadAreas() is assumed to be a no-op, and there is no benefit to calling it.

virtual void DtTerrainCapabilities::setSupportsTerrainPreload

(

bool

value

)

[virtual]

Indicates whether or not the loaded terrain responds to terrainPreloadAreas() calls.

If false, the terrainPreloadAreas() is assumed to be a no-op, and there is no benefit to calling it.

virtual DtString DtTerrainCapabilities::capabilityValue

(

const DtString &

key

)

const [virtual]

Returns:

The capability value associated with the specified key.

virtual void DtTerrainCapabilities::setCapabilityValue	(	const DtString &	key,
		const DtString &	value
	)		[virtual]

Sets teh capability value for the specified key.

Will overwrite any existing value at that key.

virtual void DtTerrainCapabilities::clearCapability

(

const DtString &

key

)

[virtual]

Clears the specified capability key and any value associated.

virtual const std::map<DtString, DtString>& DtTerrainCapabilities::capabilityMap

(

)

const [virtual]

Returns:

The entire capabilities key-value pair map.

---

Member Data Documentation

bool DtTerrainCapabilities::mySupportsTerrainPreload [protected]

std::map<DtString, DtString> DtTerrainCapabilities::myCapabilitiesMap [protected]

---

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

• include/terrainInterface/terrainCapabilities.h