DtTerrainIntersectStatus Class Reference

DtTerrainIntersectStatus Contains information about result of terrain intersection. More...

Inheritance diagram for DtTerrainIntersectStatus:

Public Member Functions
	DtTerrainIntersectStatus ()
	Default constructor. More...
virtual	~DtTerrainIntersectStatus ()
	Virtual destructor. More...
virtual bool	dataAvailable (bool setCheckedFlag=true)
	Functions related to determining whether all the terrain data needed to answer a query is paged in. More...
virtual void	setDataUnavailable ()
	Sets the data available flag to false. More...

Static Public Member Functions
static void	SuppressDataAvailableException (bool suppress)
	If set to true then exception will not be thrown from destructor if dataAvailable is not checked after doing non-blocking terrain intersection. More...

Protected Attributes
bool	myDataAvailable
bool	myDataAvailableChecked

Detailed Description

DtTerrainIntersectStatus Contains information about result of terrain intersection.

Constructor & Destructor Documentation

DtTerrainIntersectStatus::DtTerrainIntersectStatus

(

)

Default constructor.

virtual DtTerrainIntersectStatus::~DtTerrainIntersectStatus ( )

virtual

Virtual destructor.

Member Function Documentation

static void DtTerrainIntersectStatus::SuppressDataAvailableException ( bool  suppress )

static

If set to true then exception will not be thrown from destructor if dataAvailable is not checked after doing non-blocking terrain intersection.

virtual bool DtTerrainIntersectStatus::dataAvailable ( bool  setCheckedFlag = true )

virtual

Functions related to determining whether all the terrain data needed to answer a query is paged in.

See Synchronous and Asynchronous Calls with Paged Terrains for general info about of blocking/nonblocking calls.

Will return true if all the data needed for satisfy a query is paged in. If the query is blocking then this will always return true (since it has waited for all the data). For nonblocking queries if this function is not called by the user then the system will print an error to the console. Defaults to true.

Parameters

setCheckedFlag

If false then the flag which causes the system to write an error the console if dataAvailable is not called will not be set and the system will still write the error.

Returns

True if all the data was paged in, false if not.

virtual void DtTerrainIntersectStatus::setDataUnavailable ( )

virtual

Sets the data available flag to false.

This is generally called by the terrain intersection code. The flag starts out as true and if during the process of satisfying the query some data is not paged in then this function is called to set dataAvailable to false.

Member Data Documentation

bool DtTerrainIntersectStatus::myDataAvailable

protected

bool DtTerrainIntersectStatus::myDataAvailableChecked

protected

---

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

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