NTrace
GPU ray tracing framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
FW::SplitInfo Class Reference

Class holding information about a split of a BVH node. More...

#include <BVHNode.hpp>

Public Types

enum  SplitType { SAH, SBVH, OSAH }
 Available split types. More...
 
enum  SplitAxis { SPLIT_X, SPLIT_Y, SPLIT_Z }
 Available split axes. More...
 

Public Member Functions

 SplitInfo ()
 Constructor. More...
 
 SplitInfo (S32 axis, SplitType splitType, bool osahTested)
 Constructor. More...
 
 SplitInfo (unsigned long bitCode)
 Constructor. More...
 
bool getOSAHTested () const
 
bool getOSAHChosen () const
 
SplitType getType () const
 
String getTypeName () const
 
SplitAxis getAxis () const
 
String getAxisName () const
 
unsigned long getBitCode () const
 

Detailed Description

Class holding information about a split of a BVH node.

Definition at line 58 of file BVHNode.hpp.

Member Enumeration Documentation

Available split axes.

Enumerator
SPLIT_X 
SPLIT_Y 
SPLIT_Z 

Definition at line 70 of file BVHNode.hpp.

Available split types.

Enumerator
SAH 
SBVH 
OSAH 

Definition at line 65 of file BVHNode.hpp.

Constructor & Destructor Documentation

FW::SplitInfo::SplitInfo ( )
inline

Constructor.

Definition at line 76 of file BVHNode.hpp.

FW::SplitInfo::SplitInfo ( S32  axis,
SplitType  splitType,
bool  osahTested 
)
inline

Constructor.

Parameters
[in]axisSplit axis.
[in]splitTypeType of the split.
[in]osahTestedFlag whether the split has been tested for a OSAH split.

Definition at line 84 of file BVHNode.hpp.

FW::SplitInfo::SplitInfo ( unsigned long  bitCode)
inline

Constructor.

Parameters
[in]bitCodeSplitInfo encoded in long int form.

Definition at line 90 of file BVHNode.hpp.

Member Function Documentation

SplitAxis FW::SplitInfo::getAxis ( ) const
inline
Returns
Split axis.

Definition at line 115 of file BVHNode.hpp.

String FW::SplitInfo::getAxisName ( ) const
inline
Returns
Name of the split axis.

Definition at line 120 of file BVHNode.hpp.

unsigned long FW::SplitInfo::getBitCode ( ) const
inline
Returns
SplitInfo encoded in an unsigned long integer.

Definition at line 125 of file BVHNode.hpp.

bool FW::SplitInfo::getOSAHChosen ( ) const
inline
Returns
Whether the split has been chosen for OSAH.

Definition at line 100 of file BVHNode.hpp.

bool FW::SplitInfo::getOSAHTested ( ) const
inline
Returns
Whether the split has been tested for OSAH.

Definition at line 95 of file BVHNode.hpp.

SplitType FW::SplitInfo::getType ( ) const
inline
Returns
Type of the split.

Definition at line 105 of file BVHNode.hpp.

String FW::SplitInfo::getTypeName ( ) const
inline
Returns
Name of the split type.

Definition at line 110 of file BVHNode.hpp.


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