Documentation for vtkRayCaster

vtkRayCaster - A helper object for the renderer that controls ray casting

Super Class: vtkObject

Description:

vtkRayCaster is an automatically created object within vtkRenderer. It is used for ray casting operations. It stores variables such as the view rays, and information on multiresolution image rendering which are queried by the specific ray casters.

 

See Also:

vtkRenderer vtkViewRays

 

Methods:

void vtkRayCaster ()
void vtkRayCaster ()
static vtkRayCaster *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
int Render (vtkRenderer *)
float *GetCurrentColorBuffer ()
float *GetCurrentZBuffer ()
float *GetPerspectiveViewRays ()
void GetViewRaysSize (int )
float *GetParallelStartPosition ()
float *GetParallelIncrements ()
void SetImageScale (int ,float )
float GetImageScale (int )
void SetSelectedImageScaleIndex (int )
int GetSelectedImageScaleIndex ()
void SetViewRaysStepSize (int ,float )
float GetViewRaysStepSize (int )
void SetRenderer (vtkRenderer *)
vtkRenderer *GetRenderer ()
float GetViewportScaleFactor (vtkRenderer *)
float GetViewportStepSize ()
int GetAutomaticScaleAdjustment ()
void AutomaticScaleAdjustmentOn ()
void AutomaticScaleAdjustmentOff ()
void SetAutomaticScaleLowerLimit (float )
float GetAutomaticScaleLowerLimit ()
int GetImageScaleCount ()
void SetBilinearImageZoom (int )
int GetBilinearImageZoom ()
void BilinearImageZoomOn ()
void BilinearImageZoomOff ()
float GetTotalRenderTime ()
void NearestNeighborZoom (float * ,float * ,int ,int )
void BilinearZoom (float * ,float * ,int ,int )
void RescaleImage (float * ,int )

 

Detailed Method Descriptions:

Main routine to do the volume rendering.

int Render (vtkRenderer *)

Methods for a vtkVolumeMapper to retrieve latest color and zbuffer

float *GetCurrentColorBuffer ()
float *GetCurrentZBuffer ()

Method for a vtkVolumeMapper to retrieve the view rays for a perspective projection

float *GetPerspectiveViewRays ()

Get the size in pixels of the view rays for the selected scale index

void GetViewRaysSize (int )

For a parallel projection, get the starting position of a ray in the lower left hand corder of the viewport.

float *GetParallelStartPosition ()

For a parallel projection, get the (x,y,z) world increments to move one pixel along the image plane x and the image plane y axes.

float *GetParallelIncrements ()

Set the scale factor for a given level. This is used during multi- resolution interactive rendering

void SetImageScale (int ,float )

Get the scale factor for a given level. This is used during multi- resolution interactive rendering

float GetImageScale (int )

During multi-resolution rendering, this indicated the selected level of resolution

void SetSelectedImageScaleIndex (int )
int GetSelectedImageScaleIndex ()

For each level of resolution, set the step size associated with that level. This may be used by the vtkVolumeMapper.

void SetViewRaysStepSize (int ,float )
float GetViewRaysStepSize (int )

This method allows the ray caster to know about the renderer with which it is associated

void SetRenderer (vtkRenderer *)
vtkRenderer *GetRenderer ()

This method returns the scale that should be applied to the viewport for geometric rendering, and for the image in volume rendering. It is either explicitly set (if AutomaticScaleAdjustment is off) or is adjusted automatically to get the desired frame rate. Note: IMPORTANT!!!! This should only be called once per render!!!

float GetViewportScaleFactor (vtkRenderer *)

Get the step size that should be used

float GetViewportStepSize ()

Get the value of AutomaticScaleAdjustment. 0 = off, 1 = on

int GetAutomaticScaleAdjustment ()

Turn the automatic scale adjustment on

void AutomaticScaleAdjustmentOn ()

Turn the automatic scale adjustment off

void AutomaticScaleAdjustmentOff ()

Set / Get the lower limit for scaling an image. This will define the worst resolution allowed during multiresolution rendering. The default value is 0.15.

void SetAutomaticScaleLowerLimit (float )
float GetAutomaticScaleLowerLimit ()

Get the number of levels of resolution.

int GetImageScaleCount ()

Set/Get the value of bilinear image zooming.

void SetBilinearImageZoom (int )
int GetBilinearImageZoom ()
void BilinearImageZoomOn ()
void BilinearImageZoomOff ()

Get the total time required for ray casting.

float GetTotalRenderTime ()

Zoom the small image up the full size using nearest neighbor interpolation

void NearestNeighborZoom (float * ,float * ,int ,int )

Zoom the small image up the full size using bilinear interpolation

void BilinearZoom (float * ,float * ,int ,int )

Rescale the image from the small size to the full size using one of the two interpolation methods above - NearestNeighborZoom or BilinearZoom.

void RescaleImage (float * ,int )