VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
DtTerrainCapabilities Class Reference

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

Public Member Functions

 DtTerrainCapabilities ()
virtual ~DtTerrainCapabilities ()
virtual void setIsHighFidelityTerrain (bool b)
 Returns true if this is a high fidelity terrain (more than just a sphere or bounding volume)
virtual bool isHighFidelityTerrain () 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.

Private Member Functions

 DtTerrainCapabilities (const DtTerrainCapabilities &orig)
 Not implemented.
DtTerrainCapabilitiesoperator= (const DtTerrainCapabilities &orig)
 Not implemented.
bool mySupportsTerrainPreload
 Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)
bool myHasNonPolygonalWaterRegions
 Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)
bool myIsHighFidelityTerrain
 Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)
std::map< DtString, DtStringmyCapabilitiesMap
 Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)
virtual bool hasNonPolygonalWaterRegions () const
 Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)
virtual void setHasNonPolygonalWaterRegions (bool value)
 Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)
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

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 void DtTerrainCapabilities::setIsHighFidelityTerrain ( bool  b)
virtual

Returns true if this is a high fidelity terrain (more than just a sphere or bounding volume)

virtual bool DtTerrainCapabilities::isHighFidelityTerrain ( ) const
virtual
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 bool DtTerrainCapabilities::hasNonPolygonalWaterRegions ( ) const
virtual

Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)

virtual void DtTerrainCapabilities::setHasNonPolygonalWaterRegions ( bool  value)
virtual

Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)

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

Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)

bool DtTerrainCapabilities::myHasNonPolygonalWaterRegions
protected

Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)

bool DtTerrainCapabilities::myIsHighFidelityTerrain
protected

Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)

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

Indicates whether or not the loaded terrain has non-polygonal water defined by a fixed altitude and possibly defined in a set of regions (each of which can have a different water altitude)


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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)