DtTriangleOutputInterface Class Reference

Interface for getting terrain triangle data out of DtTerrainInterface::trianglesInArea. More...

Inheritance diagram for DtTriangleOutputInterface:

Public Member Functions
virtual bool	processTriangles () const
	Will only call processTriangle(const DtTerrainTriangleStruct& triangle) if this returns true. More...
virtual void	processTriangle (const DtTerrainTriangleStruct &triangle)=0
	Called on each triangle. More...
virtual bool	processAABBs () const
	AABB functions will only be called if this returns true. More...
virtual void	queryAABB (const DtVector &min, const DtVector &max, const DtCoordTransform &toLocal)
	Called with the axis-aligned bounding box values computed for the query. More...
virtual bool	objectAABB (const DtVector &min, const DtVector &max, const DtCoordTransform &toLocal)
	Called with the axis-aligned bounding box of each object processed. More...
virtual bool	processElevationTiles () const
	elevationTile() functions will only be called if this returns true. More...
virtual bool	elevationTile (const DtVector &p1, const DtVector &p2, const DtVector &p3, const DtVector &p4)
	Corner points of an elevation tile. More...
virtual bool	forcePaging () const
	This will force paging in of all terrain within the box, which may take a significant amount of time and may also consume large amounts of memory. More...
virtual void	setFailure (const std::string &reason)
	Called by implementation if there is an error. More...
virtual bool	shouldExit () const
	Called by implementation to allow early exit. More...
virtual void	setName (const std::string &name)
	Set terrain area name. More...
virtual std::string &	name ()
	Return the terrain area name. More...

Protected Attributes
std::string	myTerrainAreaName

Detailed Description

Interface for getting terrain triangle data out of DtTerrainInterface::trianglesInArea.

This object should always be created on the stack.

Member Function Documentation

virtual bool DtTriangleOutputInterface::processTriangles ( ) const

virtual

Will only call processTriangle(const DtTerrainTriangleStruct& triangle) if this returns true.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual void DtTriangleOutputInterface::processTriangle ( const DtTerrainTriangleStruct &  triangle )

pure virtual

Called on each triangle.

Implemented in DtDebugDrawTerrainOutputInterface.

virtual bool DtTriangleOutputInterface::processAABBs ( ) const

virtual

AABB functions will only be called if this returns true.

Returns false by default.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual void DtTriangleOutputInterface::queryAABB ( const DtVector &  min, const DtVector &  max, const DtCoordTransform &  toLocal  )

virtual

Called with the axis-aligned bounding box values computed for the query.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual bool DtTriangleOutputInterface::objectAABB ( const DtVector &  min, const DtVector &  max, const DtCoordTransform &  toLocal  )

virtual

Called with the axis-aligned bounding box of each object processed.

These AABBs are calculated in the coordinate system in which the query is done.

Returns

Can reject objects from further processing by returning false.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual bool DtTriangleOutputInterface::processElevationTiles ( ) const

virtual

elevationTile() functions will only be called if this returns true.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual bool DtTriangleOutputInterface::elevationTile ( const DtVector &  p1, const DtVector &  p2, const DtVector &  p3, const DtVector &  p4  )

virtual

Corner points of an elevation tile.

Returns

Can reject tiles from further processing by returning false.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual bool DtTriangleOutputInterface::forcePaging ( ) const

virtual

This will force paging in of all terrain within the box, which may take a significant amount of time and may also consume large amounts of memory.

Default returns true.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual void DtTriangleOutputInterface::setFailure ( const std::string &  reason )

virtual

Called by implementation if there is an error.

virtual bool DtTriangleOutputInterface::shouldExit ( ) const

virtual

Called by implementation to allow early exit.

Functions will return as soon as possible if this returns true.

Reimplemented in DtDebugDrawTerrainOutputInterface.

virtual void DtTriangleOutputInterface::setName ( const std::string &  name )

virtual

Set terrain area name.

virtual std::string& DtTriangleOutputInterface::name ( )

virtual

Return the terrain area name.

Member Data Documentation

std::string DtTriangleOutputInterface::myTerrainAreaName

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/terrainInterface/terrainProcessPolygonsBox.h