DtTerrainImplementation Class Reference

This is the abstract base class for all terrain implementations. More...

Inheritance diagram for DtTerrainImplementation:

Public Types
typedef std::map< std::string, std::string >	TerrainSettings

Public Member Functions
	DtTerrainImplementation (DtConsoleCommandManager *cmdManager)
virtual	~DtTerrainImplementation ()
virtual bool	loadTerrain (const makArchives::DtGenericTerrainRecord &rec, MAKVRinTerra::DtFeatureLoader &featureLoader, const TerrainSettings &settings=TerrainSettings())=0
	Loads a terrain given the terrain record and a key/value pair of settings.
virtual const Coordinate_System *	coordinateSystem () const =0
virtual bool	chordIntersect (const DtChord &chord, DtChordIntersectionRecord &record, DtIntersectionRecord::DtIntersectionType irtFlag=DtIntersectionRecord::INT_ALL_DATA, bool *dataAvailable=0, bool overrideBlockingAssert=false) const =0
	Returns topmost intersection of chord with terrain in record.
virtual bool	allIntersectsAlongChord (const DtChord &chord, DtChordIntersectRecordList &intList, DtIntersectionRecord::DtIntersectionType irtFlag=DtIntersectionRecord::INT_ALL_DATA, bool *dataAvailable=0, bool overrideBlockingAssert=false) const =0
	Returns all intersections of chord with terrain.
virtual bool	sphereIntersect (const DtSphere &sphere, DtSphereIntersectionRecord &record, DtIntersectionRecord::DtIntersectionType irtFlag=DtIntersectionRecord::INT_ALL_DATA, bool *dataAvailable=0, bool overrideBlockingAssert=false) const =0
	Returns intersection of a sphere with the terrain.
virtual void	preloadTerrainAreas (const DtTerrainPagingGeometryList &preloadGeometry)
	Specifies a list of terrain areas that should be preloaded by the terrain implementation, in the case of a paging or streaming terrain source.
virtual const DtTerrainCapabilities *	terrainCapabilities () const =0
virtual void	setIntersectDataLoadExpireTime (const double &expireTime)
	No-op.
virtual void	expireDataLoadRequestsBeforeTime (const double &currentTime)
	No-op.
virtual void	processTrianglesInArea (DtTriangleCallbackFcn func, DtTriangleCallbackFinalizeFcn finalize, DtTerrainProcessPolygonsBox &box, void *usr) const
virtual void	breakUpChords (const MAKVRinTerra::DtProj &, const DtChord &chord, std::vector< DtChord > &chords)
const TerrainSettings &	settings ()
	Returns settings.
void	setFeatureContext (const boost::scoped_ptr< MAKVRinTerra::DtFeatureContext > &fc)
	Sets the feature context for use in lookups.
virtual void	setAssertOnBlockingTerrainCalls (bool assertBlock)
	Determines if an exception should be thrown if a blocking terrain call is made.
virtual bool	assertOnBlockingTerrainCalls () const
	Determines if an exception should be thrown if a blocking terrain call is made.

Protected Attributes
bool	myAssertOnBlockingTerrainCalls
	Determines if an exception should be thrown if a blocking terrain call is made.
TerrainSettings	mySettings
	Settings used for this implementation.
MAKVRinTerra::DtFeatureContext *	myFeatureContext
	Used for featutre lookups.

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

Detailed Description

This is the abstract base class for all terrain implementations.

A terrain implementation is used by the DtTerrainInterface to interact with a terrain representation.

Member Typedef Documentation

typedef std::map<std::string, std::string> DtTerrainImplementation::TerrainSettings

Constructor & Destructor Documentation

DtTerrainImplementation::DtTerrainImplementation ( )

private

Not implemented.

DtTerrainImplementation::DtTerrainImplementation ( const DtTerrainImplementation &  orig )

private

Not implemented.

DtTerrainImplementation::DtTerrainImplementation

(

DtConsoleCommandManager *

cmdManager

)

virtual DtTerrainImplementation::~DtTerrainImplementation ( )

virtual

Member Function Documentation

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

private

Not implemented.

virtual bool DtTerrainImplementation::loadTerrain ( const makArchives::DtGenericTerrainRecord &  rec, MAKVRinTerra::DtFeatureLoader &  featureLoader, const TerrainSettings &  settings = TerrainSettings()  )

pure virtual

Loads a terrain given the terrain record and a key/value pair of settings.

These settings are interpreted (or not) by the implementation

Implemented in DtVantageTerrainImplementation, DtGdbTerrainImplementation, DtTerrainPassThroughLayer, DtExtentTerrainImplementation, and DtEllipsoidTerrainImplementation.

virtual const Coordinate_System* DtTerrainImplementation::coordinateSystem ( ) const

pure virtual

Implemented in DtVantageTerrainImplementation, DtGdbTerrainImplementation, DtTerrainPassThroughLayer, DtExtentTerrainImplementation, and DtEllipsoidTerrainImplementation.

virtual bool DtTerrainImplementation::chordIntersect ( const DtChord &  chord, DtChordIntersectionRecord &  record, DtIntersectionRecord::DtIntersectionType  irtFlag = DtIntersectionRecord::INT_ALL_DATA, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

pure virtual

Returns topmost intersection of chord with terrain in record.

Parameters

Input
chord	the chord to test
irtFlag	specifies what intersection data should be filled in for the record.
Output
record	the results of the intersection
dataAvailable	Please see "Synchronous and asynchronous calls with paged terrains" in DtTerrainInterface for information on how to specify that this function be blocking or non-blocking. If this parameter is specified and the required terrain data is not yet paged in, this call will return immediately and dataAvailable will be set to false.
overrideBlockingAssert	when set to true this parameter will prevent an assertion from being thrown when the terrain implementation has myAssertOnBlockingTerrainCalls set to true. This should only be done when the call is being made from outside the main simulation thread and a blocking call would not cause a a problem.

Implemented in DtVantageTerrainImplementation, DtGdbTerrainImplementation, DtTerrainPassThroughLayer, DtExtentTerrainImplementation, DtEllipsoidTerrainImplementation, and DtIntersectTimerPassThroughLayer.

virtual bool DtTerrainImplementation::allIntersectsAlongChord ( const DtChord &  chord, DtChordIntersectRecordList &  intList, DtIntersectionRecord::DtIntersectionType  irtFlag = DtIntersectionRecord::INT_ALL_DATA, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

pure virtual

Returns all intersections of chord with terrain.

Parameters

Input
chord	the chord to test
irtFlag	specifies what intersection data should be filled in for the record.
Output
intList	the results of the intersection
dataAvailable	Please see "Synchronous and asynchronous calls with paged terrains" in DtTerrainInterface for information on how to specify that this function be blocking or non-blocking. If this parameter is specified and the required terrain data is not yet paged in, this call will return immediately and dataAvailable will be set to false.
overrideBlockingAssert	when set to true this parameter will prevent an assertion from being thrown when the terrain implementation has myAssertOnBlockingTerrainCalls set to true. This should only be done when the call is being made from outside the main simulation thread and a blocking call would not cause a a problem.

Implemented in DtVantageTerrainImplementation, DtTerrainPassThroughLayer, DtGdbTerrainImplementation, DtExtentTerrainImplementation, DtEllipsoidTerrainImplementation, and DtIntersectTimerPassThroughLayer.

virtual bool DtTerrainImplementation::sphereIntersect ( const DtSphere &  sphere, DtSphereIntersectionRecord &  record, DtIntersectionRecord::DtIntersectionType  irtFlag = DtIntersectionRecord::INT_ALL_DATA, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false  ) const

pure virtual

Returns intersection of a sphere with the terrain.

Parameters

Input
sphere	the sphere to test
irtFlag	specifies what intersection data should be filled in for the record.
Output
record	the results of the intersection
dataAvailable	Please see "Synchronous and asynchronous calls with paged terrains" in DtTerrainInterface for information on how to specify that this function be blocking or non-blocking. If this parameter is specified and the required terrain data is not yet paged in, this call will return immediately and dataAvailable will be set to false.
overrideBlockingAssert	when set to true this parameter will prevent an assertion from being thrown when the terrain implementation has myAssertOnBlockingTerrainCalls set to true. This should only be done when the call is being made from outside the main simulation thread and a blocking call would not cause a a problem.

Implemented in DtVantageTerrainImplementation, DtTerrainPassThroughLayer, DtGdbTerrainImplementation, DtExtentTerrainImplementation, and DtEllipsoidTerrainImplementation.

virtual void DtTerrainImplementation::preloadTerrainAreas ( const DtTerrainPagingGeometryList &  preloadGeometry )

inlinevirtual

Specifies a list of terrain areas that should be preloaded by the terrain implementation, in the case of a paging or streaming terrain source.

The typical use of this is to specify parts of the terrain that are expected to be needed in the near future.

The terrain may not be loaded immediately upon making this call, and there is no guarantee that the terrain areas will be available for intersection immediately after making this call.

Parameters

preloadGeometry

A list of the geometric areas that should be preloaded. They can be specified using any of the subclasses of DtTerrainPagingGeometry.

Note

The geometry set with this call completely replaces any geometry previously set using this call.

The default implementation for this is a noop.

Reimplemented in DtVantageTerrainImplementation, and DtTerrainPassThroughLayer.

virtual const DtTerrainCapabilities* DtTerrainImplementation::terrainCapabilities ( ) const

pure virtual

Returns

A DtTerrainCapabilites structure that describes the capabilities of the currently loaded terrain.

Implemented in DtVantageTerrainImplementation, DtTerrainPassThroughLayer, DtExtentTerrainImplementation, DtGdbTerrainImplementation, and DtEllipsoidTerrainImplementation.

virtual void DtTerrainImplementation::setAssertOnBlockingTerrainCalls ( bool  assertBlock )

virtual

Determines if an exception should be thrown if a blocking terrain call is made.

This can help to track down blocking terrain calls which are causing problems with a running simulation. Note that calling the blocking form of any terrain intersection function will cause an assertion; it is not necessary for the call to actually block and even non-paging implementations will assert. This is done to make it easier to find potential problems regardless of the particular terrain or location being used.

Returns

myAssertOnBlockingTerrainCalls

virtual bool DtTerrainImplementation::assertOnBlockingTerrainCalls ( ) const

virtual

Determines if an exception should be thrown if a blocking terrain call is made.

This can help to track down blocking terrain calls which are causing problems with a running simulation. Note that calling the blocking form of any terrain intersection function will cause an assertion; it is not necessary for the call to actually block and even non-paging implementations will assert. This is done to make it easier to find potential problems regardless of the particular terrain or location being used.

Returns

myAssertOnBlockingTerrainCalls

virtual void DtTerrainImplementation::setIntersectDataLoadExpireTime ( const double &  expireTime )

inlinevirtual

No-op.

Override to set the default expiration time for data load requests generated by intersect calls that require data that has not yet been loaded (paged-in).

Parameters

expireTime

The expiration time to be assigned to load data requests generated by intersect calls on the terrain implementation.

Reimplemented in DtVantageTerrainImplementation, and DtTerrainPassThroughLayer.

virtual void DtTerrainImplementation::expireDataLoadRequestsBeforeTime ( const double &  currentTime )

inlinevirtual

No-op.

Override to expire data load requests generated before the given time. See comment for #setIntersectLoadDataExpireTime.

Parameters

currentTime

The time to compare to data load requests to determine if they should be expired rather than executed.

Reimplemented in DtVantageTerrainImplementation, and DtTerrainPassThroughLayer.

virtual void DtTerrainImplementation::processTrianglesInArea ( DtTriangleCallbackFcn  func, DtTriangleCallbackFinalizeFcn  finalize, DtTerrainProcessPolygonsBox &  box, void *  usr  ) const

virtual

Reimplemented in DtVantageTerrainImplementation, and DtGdbTerrainImplementation.

virtual void DtTerrainImplementation::breakUpChords ( const MAKVRinTerra::DtProj &  , const DtChord &  chord, std::vector< DtChord > &  chords  )

virtual

Reimplemented in DtVantageTerrainImplementation.

const TerrainSettings& DtTerrainImplementation::settings ( )

inline

Returns settings.

Used to communicate any additional settings defined from the loading of the terrain. Pre-defined examples are: Ocean_Layer_Present - 1/0 (not present). Sea_Level - in meters Sea_Floor - in meters

void DtTerrainImplementation::setFeatureContext ( const boost::scoped_ptr< MAKVRinTerra::DtFeatureContext > &  fc )

inline

Sets the feature context for use in lookups.

Member Data Documentation

bool DtTerrainImplementation::myAssertOnBlockingTerrainCalls

protected

Determines if an exception should be thrown if a blocking terrain call is made.

This can help to track down blocking terrain calls which are causing problems with a running simulation.

TerrainSettings DtTerrainImplementation::mySettings

protected

Settings used for this implementation.

MAKVRinTerra::DtFeatureContext* DtTerrainImplementation::myFeatureContext

protected

Used for featutre lookups.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/terrainInterface/terrainImplementation.h