VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtTerrainIntersectStatus Class Reference

DtTerrainIntersectStatus Contains information about result of terrain intersection.

Inheritance diagram for DtTerrainIntersectStatus:
Inheritance graph
[legend]

Public Member Functions

 DtTerrainIntersectStatus ()
 
virtual ~DtTerrainIntersectStatus ()
 
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.

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
setCheckedFlagIf 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:

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)