Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

nvsg::CullData Class Reference

Class holding culling information for an object and it's children. More...

#include <CullData.h>

Inheritance diagram for nvsg::CullData:

Inheritance graph
[legend]
Collaboration diagram for nvsg::CullData:

Collaboration graph
[legend]
List of all members.

Public Methods

NVSG_API CullData (CullCode cullCode)
 Constructor. More...

virtual NVSG_API ~CullData (void)
 Destructor. More...

NVSG_API void balance (void)
 Balance the CullData tree. More...

NVSG_API void addChild (CullData *cd)
 Add a child to this CullData. More...

NVSG_API const CullData * getChild (size_t i) const
 Get the i'th child of this CullData. More...

NVSG_API CullCode getCullCode (void) const
 Get the CullCode of this CullData. More...

NVSG_API size_t getNumberOfChildren (void) const
 Get the number of children of this CullData. More...


Detailed Description

Class holding culling information for an object and it's children.

With CullData, a CullTraverser can build a (somewhat simplified) mirror of a scene tree. Each CullData corresponds to one object in a scene tree. Such a CullData tree is used in the Traverser to determine if parts of the scene tree are to be traversed.


Constructor & Destructor Documentation

nvsg::CullData::CullData CullCode    cullCode [inline]
 

Constructor.

virtual NVSG_API nvsg::CullData::~CullData void    [virtual]
 

Destructor.


Member Function Documentation

NVSG_API void nvsg::CullData::balance void   
 

Balance the CullData tree.

After having constructed a CullData tree, it might be of value to improve it. When CullData has a CullCode of CC_PART and the children of CullData have a CullCode of CC_IN to CC_IN, then this function removes these children.

void nvsg::CullData::addChild CullData *    cd [inline]
 

Add a child to this CullData.

CullData builds a somewhat simplified mirror of a scene tree. With addChild , the CullData of a child object can be added to the parent object to which the current CullData belongs.

Parameters:
cd  CullData to add to the back of the parent object's CullData

const CullData * nvsg::CullData::getChild size_t    i const [inline]
 

Get the i'th child of this CullData.

It is assumed that this child does exist.

Parameters:
i  Index of children to get

CullCode nvsg::CullData::getCullCode void    const [inline]
 

Get the CullCode of this CullData.

Returns:
CullCode of this CullData.

size_t nvsg::CullData::getNumberOfChildren void    const [inline]
 

Get the number of children of this CullData.

Returns:
Number of children of this CullData. This should be zero or the same as the number of children of the scene tree object that this CullData represents.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:20:25 2005 for NVSGSDK by NVIDIA