DtTerrainImplementation Class Reference

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

Inheritance diagram for DtTerrainImplementation:

Public Member Functions
	DtTerrainImplementation (DtConsoleCommandManager *cmdManager)
virtual	~DtTerrainImplementation ()
virtual MAKVRinTerra::DtFeatureDatabase &	featureDatabase ()
	Access feature database.
virtual const MAKVRinTerra::DtFeatureDatabase &	featureDatabase () const
virtual MAKVRinTerra::DtFeatureContext &	featureContext ()
	Access feature context.
virtual const MAKVRinTerra::DtFeatureContext &	featureContext () const
virtual void	init ()
	Called immediately after creation.
virtual void	finishedLoading (const MAKVRinTerra::DtProj &proj)
	Called after terrain loaded successfully.
virtual bool	loadTerrain (const makArchives::DtGenericTerrainRecord &rec)=0
	Loads a terrain given the terrain record.
virtual void	shutdown (bool block=true)
	Shutdown the terrain.
virtual const Coordinate_System *	coordinateSystem () const =0
virtual double	modelHeightDifferencesFromAppearances (int oldApp, int newApp) const
	If supported by the implementation, return the height difference from the currently loaded model as a transition from the old appearance to the new appearance.
virtual bool	createFromExtent (const Dt3dBoundingVolume &)
	Creates an extent from the given extent. Not all implementations will support this.
virtual bool	loadModel (const DtFilename &, const DtEntityType &t=DtEntityType())
	Defaults to loading terrain for gdb.
virtual DtTerrainInterfaceConfig &	configurationOptions ()
virtual const DtTerrainInterfaceConfig &	configurationOptions () const
virtual bool	chordIntersect (const DtChord &chord, DtChordIntersectionRecord &record, DtIntersectionRecord::DtIntersectionType irtFlag=DtIntersectionRecord::INT_ALL_DATA, bool *dataAvailable=0, bool overrideBlockingAssert=false, int flags=0) 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, int flags=0) const =0
	Returns all intersections of chord with 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)
virtual bool	hasFeatureContext () const
	Returns true if there is an active feature context.
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.
virtual void	setWarnOnBlockingTerrainCalls (bool warnBlock)
	Determines if a warning should be printed out if a blocking terrain call is made.
virtual bool	warnOnBlockingTerrainCalls () const
	Determines if a warning should be printed out if a blocking terrain call is made.

Protected Attributes
DtTerrainInterfaceConfig	myConfig
bool	myAssertOnBlockingTerrainCalls
	Determines if an exception should be thrown if a blocking terrain call is made.
bool	myWarnOnBlockingTerrainCalls
boost::scoped_ptr < MAKVRinTerra::DtFeatureDatabase >	myFeatureDatabase
boost::scoped_ptr < MAKVRinTerra::DtFeatureContext >	myFeatureContext

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.

Constructor & Destructor Documentation

DtTerrainImplementation::DtTerrainImplementation

(

DtConsoleCommandManager *

cmdManager

)

virtual DtTerrainImplementation::~DtTerrainImplementation ( )

virtual

Member Function Documentation

virtual MAKVRinTerra::DtFeatureDatabase& DtTerrainImplementation::featureDatabase ( )

virtual

Access feature database.

virtual const MAKVRinTerra::DtFeatureDatabase& DtTerrainImplementation::featureDatabase ( ) const

virtual

virtual MAKVRinTerra::DtFeatureContext& DtTerrainImplementation::featureContext ( )

virtual

Access feature context.

virtual const MAKVRinTerra::DtFeatureContext& DtTerrainImplementation::featureContext ( ) const

virtual

virtual void DtTerrainImplementation::init ( )

virtual

Called immediately after creation.

virtual void DtTerrainImplementation::finishedLoading ( const MAKVRinTerra::DtProj &  proj )

virtual

Called after terrain loaded successfully.

Parameters

proj	DtProj object for local coordinate system.

virtual bool DtTerrainImplementation::loadTerrain ( const makArchives::DtGenericTerrainRecord &  rec )

pure virtual

Loads a terrain given the terrain record.

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

virtual void DtTerrainImplementation::shutdown ( bool  block = true )

virtual

Shutdown the terrain.

Reimplemented in DtVantageTerrainImplementation.

virtual const Coordinate_System* DtTerrainImplementation::coordinateSystem ( ) const

pure virtual

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

virtual double DtTerrainImplementation::modelHeightDifferencesFromAppearances ( int  oldApp, int  newApp  ) const

virtual

If supported by the implementation, return the height difference from the currently loaded model as a transition from the old appearance to the new appearance.

Reimplemented in DtVantageTerrainImplementation.

virtual bool DtTerrainImplementation::createFromExtent ( const Dt3dBoundingVolume &  )

virtual

Creates an extent from the given extent. Not all implementations will support this.

Reimplemented in DtGdbTerrainImplementation.

virtual bool DtTerrainImplementation::loadModel ( const DtFilename &  , const DtEntityType &  t = DtEntityType()  )

virtual

Defaults to loading terrain for gdb.

Supply option entity for for use by implementation to mutate loaded model based on appearance

Reimplemented in DtVantageTerrainImplementation.

virtual DtTerrainInterfaceConfig& DtTerrainImplementation::configurationOptions ( )

virtual

virtual const DtTerrainInterfaceConfig& DtTerrainImplementation::configurationOptions ( ) const

virtual

virtual bool DtTerrainImplementation::chordIntersect ( const DtChord &  chord, DtChordIntersectionRecord &  record, DtIntersectionRecord::DtIntersectionType  irtFlag = DtIntersectionRecord::INT_ALL_DATA, bool *  dataAvailable = 0, bool  overrideBlockingAssert = false, int  flags = 0  ) 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.
flags	optional flags to pass into the intersector. The flags are implementation dependent

Implemented in DtVantageTerrainImplementation, DtGdbTerrainImplementation, 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, int  flags = 0  ) 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.
flags	optional flags to pass into the intersector. The flags are implementation dependent

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

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, DtGdbTerrainImplementation, DtTerrainPassThroughLayer, DtExtentTerrainImplementation, 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::setWarnOnBlockingTerrainCalls ( bool  warnBlock )

virtual

Determines if a warning should be printed out if a blocking terrain call is made.

virtual bool DtTerrainImplementation::warnOnBlockingTerrainCalls ( ) const

virtual

Determines if a warning should be printed out if a blocking terrain call is made.

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.

virtual bool DtTerrainImplementation::hasFeatureContext ( ) const

virtual

Returns true if there is an active feature context.

Member Data Documentation

DtTerrainInterfaceConfig DtTerrainImplementation::myConfig

protected

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.

bool DtTerrainImplementation::myWarnOnBlockingTerrainCalls

protected

boost::scoped_ptr<MAKVRinTerra::DtFeatureDatabase> DtTerrainImplementation::myFeatureDatabase

protected

boost::scoped_ptr<MAKVRinTerra::DtFeatureContext> DtTerrainImplementation::myFeatureContext

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/terrainInterface/terrainImplementation.h