All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
VGEO_Volume::HitList Class Reference

#include <VGEO_Volume.h>

Public Member Functions

 HitList (VGEO_HitList &hits, VGEO_RayState &state, VGEO_ShadeObject *prim, float zoff, float tmin, float tmax, float stepsize)
 Constructor (used internally) More...
float tmin () const
 Return the minimum ray parameter for hit insertion. More...
float tmax () const
float zoff () const
float stepsize () const
 Return the volume step size for ray marching algorithms. More...
void addHit (float t, const UT_Vector3 &pos, bool backface)
void dump () const
 Dump the hist. More...
exint entries () const
 Size of the hit list. More...

Detailed Description

A class to transfer ray intersection hit information back to the renderer from ray tracing callbacks. The VGEO_HitList, VGEO_RayState, and VGEO_ShadeObject classes are internal to mantra and are only accessible to plugins as forward declarations.

Definition at line 147 of file VGEO_Volume.h.

Constructor & Destructor Documentation

VGEO_Volume::HitList::HitList ( VGEO_HitList &  hits,
VGEO_RayState &  state,
VGEO_ShadeObject *  prim,
float  zoff,
float  tmin,
float  tmax,
float  stepsize 

Constructor (used internally)

Definition at line 150 of file VGEO_Volume.h.

Member Function Documentation

void VGEO_Volume::HitList::addHit ( float  t,
const UT_Vector3 pos,
bool  backface 

Insert a ray intersection hit. This method may decrease the value returned by tmax().

tRay parameter for the intersection
posIntersection position in local space
backfaceWhether the hit is backfacing
void VGEO_Volume::HitList::dump ( ) const

Dump the hist.

exint VGEO_Volume::HitList::entries ( ) const

Size of the hit list.

float VGEO_Volume::HitList::stepsize ( ) const

Return the volume step size for ray marching algorithms.

Definition at line 174 of file VGEO_Volume.h.

float VGEO_Volume::HitList::tmax ( ) const

Return the maximum ray parameter for hit insertion. When t >= tmax(), intersection tests can be terminated.

Definition at line 169 of file VGEO_Volume.h.

float VGEO_Volume::HitList::tmin ( ) const

Return the minimum ray parameter for hit insertion.

Definition at line 166 of file VGEO_Volume.h.

float VGEO_Volume::HitList::zoff ( ) const

Return the stratified sample offset for this hit list. This value is premultiplied by stepsize().

Definition at line 172 of file VGEO_Volume.h.

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