Documentation for vtkVolumeRayCastMapper

vtkVolumeRayCastMapper - Abstract class for ray casting mappers

Super Class: vtkVolumeMapper

Description:

This is the abstract class for mappers that use volumetric ray casting

 

See Also:

vtkVolumeMapper

 

Methods:

void vtkVolumeRayCastMapper ()
void vtkVolumeRayCastMapper ()
static vtkVolumeRayCastMapper *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetSampleDistance (float )
float GetSampleDistance ()
int *GetScalarDataSize ()
int GetTotalStepsTaken ()
int GetTotalRaysCast ()
float GetDrawTime ()
float GetCastTime ()
void SetRayBounder (vtkRayBounder *)
vtkRayBounder *GetRayBounder ()
void SetVolumeRayCastFunction (vtkVolumeRayCastFunction *)
vtkVolumeRayCastFunction *GetVolumeRayCastFunction ()
float *GetZbufferData ()
float *GetRGBAPixelData ()
int DestroyHardwareBuffer ()
int ImageLocatedInHardware ()
void Render (vtkRenderer * ,vtkVolume *)
float GetZeroOpacityThreshold (vtkVolume *)
void SetGradientEstimator (vtkEncodedGradientEstimator *)
vtkEncodedGradientEstimator *GetGradientEstimator ()
vtkEncodedGradientShader *GetGradientShader ()
int ClipRayAgainstVolume (float ,float )
void GeneralImageInitialization (vtkRenderer * ,vtkVolume *)
void InitializeParallelImage (vtkRenderer *)
void RenderParallelImage (vtkRenderer *)
void InitializePerspectiveImage (vtkRenderer *)
void RenderPerspectiveImage (vtkRenderer *)
void CasterUpdate (vtkRenderer * ,vtkVolume *)
void UpdateShadingTables (vtkRenderer * ,vtkVolume *)
void UpdateTransferFunctions (vtkRenderer * ,vtkVolume *)
void UpdateScalarOpacityTFforSampleSize (vtkRenderer * ,vtkVolume *)

 

Detailed Method Descriptions:

Set/Get the distance between samples. This variable is only used for sampling ray casting methods. Methods that compute a ray value by stepping cell-by-cell are not affected by this value. Note: this distance is in volume coordinates. This means that if you set the scale to 4 in the vtkVolume, you will NOT have 4 times as many samples.

void SetSampleDistance (float )
float GetSampleDistance ()

Get the size of the volume in voxels

int *GetScalarDataSize ()

Get the total steps taken during the computation of the last image. For a ray stepping algorithm, this is the number of steps taken along the ray. For a cell-by-cell stepping algorithm, this is the number of cells considered along the ray.

int GetTotalStepsTaken ()

Get the total number of rays cast during the computation of the last image. Rays which do not intersect the volume, or have been determined to have zero contribution to the image according to the Parc approximation are not counted.

int GetTotalRaysCast ()

Get the time spent drawing the Parc approximation for the last image. This time, plus the casting time is the total time required to compute the image for this volume.

float GetDrawTime ()

Get the time spent casting rays for the last image. This is the software portion of the algorithm, and the draw time measures the hardware part of the method.

float GetCastTime ()

Get / Set the ray bounder. This is used to clip the rays during ray casting.

void SetRayBounder (vtkRayBounder *)
vtkRayBounder *GetRayBounder ()

Get / Set the volume ray cast function. This is used to process values found along the ray to compute a final pixel value.

void SetVolumeRayCastFunction (vtkVolumeRayCastFunction *)
vtkVolumeRayCastFunction *GetVolumeRayCastFunction ()

Get a pointer to the depth or RGBA buffer created during the previous render. These methods are used by the vtkVolumeRenderer

float *GetZbufferData ()
float *GetRGBAPixelData ()

Required methods for volume mappers. The Parc algorithm destroys whatever is in the hardware buffer, and returns the image in software (through the GetZBufferData and GetRGBAPixelData calls)

int DestroyHardwareBuffer ()
int ImageLocatedInHardware ()

Render this volume.

void Render (vtkRenderer * ,vtkVolume *)

Return the scalar value below which all opacities are zero

float GetZeroOpacityThreshold (vtkVolume *)

Set / Get the gradient estimator used to estimate normals

void SetGradientEstimator (vtkEncodedGradientEstimator *)
vtkEncodedGradientEstimator *GetGradientEstimator ()

Get the gradient shader.

vtkEncodedGradientShader *GetGradientShader ()

This is called from the Render method. Its purpose is to give the concrete depth parc mapper a chance to do any specific updating that it must do.

void CasterUpdate (vtkRenderer * ,vtkVolume *)
void UpdateShadingTables (vtkRenderer * ,vtkVolume *)
void UpdateTransferFunctions (vtkRenderer * ,vtkVolume *)