DtTerrainIntersectStatus Class Reference

DtTerrainIntersectStatus Contains information about status of "data available" when an intersection call is made. When terrain intersection calls are made, it is possible that the terrain is a dynamically paged terrain. If the data required to fully answer a terrain intersection call is not currently paged in, any non-blocking terrain intersection call will return and this status object will indicated dataAvailable() == false indicating this. Whenever dataAvailable is false, any result of a terrain intersection call should be treated as possibly incomplete. Terrain intersection calls may still have some data, but they may be missing some intersections should be returned.

Inheritance diagram for DtTerrainIntersectStatus:

Public Member Functions
	DtTerrainIntersectStatus ()
virtual	~DtTerrainIntersectStatus ()
	operator bool ()
virtual bool *	dataAvailablePointer (const DtTerrainIntersectOptions &options)
virtual void	reset ()
virtual bool	dataAvailable (bool setCheckedFlag=true)
virtual void	setDataUnavailable ()

Static Public Member Functions
static void	SuppressDataAvailableException (bool suppress)

Protected Attributes
bool	myDataAvailable
bool	myDataAvailableChecked

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.

DtTerrainIntersectStatus::operator bool ( )

explicit

Returns

dataAvailable()

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.

virtual bool* DtTerrainIntersectStatus::dataAvailablePointer ( const DtTerrainIntersectOptions &  options )

virtual

Returns

A pointer to the boolean for dataAvailable if options.overrideBlockingAssert is false, otherwise true. Useful when passing from options-style intersect calls to old style intersect calls.

virtual void DtTerrainIntersectStatus::reset ( )

virtual

Sets the object back to the same state it is when it is first created. This means dataAvailable will be set to true.

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.vrf5-2-branch/include/terrainInterface/terrainIntersectStatus.h