Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkUnstructuredGridVolumeRayCastMapper Class Reference

#include <vtkUnstructuredGridVolumeRayCastMapper.h>

Inheritance diagram for vtkUnstructuredGridVolumeRayCastMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkUnstructuredGridVolumeRayCastMapper:

Collaboration graph
[legend]
List of all members.

Detailed Description

A software mapper for unstructured volumes.

This is a software ray caster for rendering volumes in vtkUnstructuredGrid.

See also:
vtkVolumeMapper
Examples:
vtkUnstructuredGridVolumeRayCastMapper (Examples)
Tests:
vtkUnstructuredGridVolumeRayCastMapper (Tests)

Definition at line 45 of file vtkUnstructuredGridVolumeRayCastMapper.h.

Public Types

typedef vtkUnstructuredGridVolumeMapper Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void Render (vtkRenderer *, vtkVolume *)
void ReleaseGraphicsResources (vtkWindow *)
virtual int * GetImageInUseSize ()
virtual void GetImageInUseSize (int data[2])
virtual int * GetImageOrigin ()
virtual void GetImageOrigin (int data[2])
virtual int * GetImageViewportSize ()
virtual void GetImageViewportSize (int data[2])
void CastRays (int threadID, int threadCount)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetScalarMode (int)
virtual int GetScalarMode ()
void SetScalarModeToDefault ()
void SetScalarModeToUsePointData ()
void SetScalarModeToUseCellData ()
void SetScalarModeToUsePointFieldData ()
void SetScalarModeToUseCellFieldData ()
virtual void SelectScalarArray (int arrayNum)
virtual void SelectScalarArray (const char *arrayName)
virtual char * GetArrayName ()
virtual int GetArrayId ()
virtual int GetArrayAccessMode ()
const char * GetScalarModeAsString ()
virtual void SetImageSampleDistance (float)
virtual float GetImageSampleDistance ()
virtual void SetMinimumImageSampleDistance (float)
virtual float GetMinimumImageSampleDistance ()
virtual void SetMaximumImageSampleDistance (float)
virtual float GetMaximumImageSampleDistance ()
virtual void SetAutoAdjustSampleDistances (int)
virtual int GetAutoAdjustSampleDistances ()
virtual void AutoAdjustSampleDistancesOn ()
virtual void AutoAdjustSampleDistancesOff ()
virtual void SetNumberOfThreads (int)
virtual int GetNumberOfThreads ()
virtual void SetIntermixIntersectingGeometry (int)
virtual int GetIntermixIntersectingGeometry ()
virtual void IntermixIntersectingGeometryOn ()
virtual void IntermixIntersectingGeometryOff ()
virtual void SetRayCastFunction (vtkUnstructuredGridVolumeRayCastFunction *f)
virtual vtkUnstructuredGridVolumeRayCastFunction * GetRayCastFunction ()
virtual void SetRayIntegrator (vtkUnstructuredGridVolumeRayIntegrator *ri)
virtual vtkUnstructuredGridVolumeRayIntegrator * GetRayIntegrator ()

Static Public Member Functions

static vtkUnstructuredGridVolumeRayCastMapper * New ()
static int IsTypeOf (const char *type)
static vtkUnstructuredGridVolumeRayCastMapper * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkUnstructuredGridVolumeRayCastMapper ()
 ~vtkUnstructuredGridVolumeRayCastMapper ()
void StoreRenderTime (vtkRenderer *ren, vtkVolume *vol, float t)
float RetrieveRenderTime (vtkRenderer *ren, vtkVolume *vol)
double GetZBufferValue (int x, int y)
double GetMinimumBoundsDepth (vtkRenderer *ren, vtkVolume *vol)

Protected Attributes

float ImageSampleDistance
float MinimumImageSampleDistance
float MaximumImageSampleDistance
int AutoAdjustSampleDistances
vtkMultiThreader * Threader
int NumberOfThreads
vtkRayCastImageDisplayHelper * ImageDisplayHelper
int ImageViewportSize [2]
int ImageMemorySize [2]
int ImageInUseSize [2]
int ImageOrigin [2]
unsigned char * Image
float * RenderTimeTable
vtkVolume ** RenderVolumeTable
vtkRenderer ** RenderRendererTable
int RenderTableSize
int RenderTableEntries
int IntermixIntersectingGeometry
float * ZBuffer
int ZBufferSize [2]
int ZBufferOrigin [2]
vtkUnstructuredGridVolumeRayCastFunction * RayCastFunction
vtkUnstructuredGridVolumeRayCastIterator ** RayCastIterators
vtkUnstructuredGridVolumeRayIntegrator * RayIntegrator
vtkUnstructuredGridVolumeRayIntegrator * RealRayIntegrator
vtkVolume * CurrentVolume
vtkRenderer * CurrentRenderer
int ScalarMode
char * ArrayName
int ArrayId
int ArrayAccessMode
vtkDataArray * Scalars
int CellScalars

Member Typedef Documentation

typedef vtkUnstructuredGridVolumeMapper vtkUnstructuredGridVolumeRayCastMapper::Superclass
 

Reimplemented from vtkUnstructuredGridVolumeMapper.

Definition at line 49 of file vtkUnstructuredGridVolumeRayCastMapper.h.

Constructor & Destructor Documentation

vtkUnstructuredGridVolumeRayCastMapper::vtkUnstructuredGridVolumeRayCastMapper (   )  [protected]
 

vtkUnstructuredGridVolumeRayCastMapper::~vtkUnstructuredGridVolumeRayCastMapper (   )  [protected]
 

Member Function Documentation

static vtkUnstructuredGridVolumeRayCastMapper* vtkUnstructuredGridVolumeRayCastMapper::New (   )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkUnstructuredGridVolumeRayCastMapper::GetClassName (   )  [virtual]
 

Reimplemented from vtkUnstructuredGridVolumeMapper.

static int vtkUnstructuredGridVolumeRayCastMapper::IsTypeOf (  const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeMapper.

virtual int vtkUnstructuredGridVolumeRayCastMapper::IsA (  const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeMapper.

static vtkUnstructuredGridVolumeRayCastMapper* vtkUnstructuredGridVolumeRayCastMapper::SafeDownCast (  vtkObject *  o  )  [static]
 

Reimplemented from vtkUnstructuredGridVolumeMapper.

void vtkUnstructuredGridVolumeRayCastMapper::PrintSelf (  ostream &  os,
vtkIndent  indent
)  [virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkUnstructuredGridVolumeMapper.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetScalarMode (  int   )  [virtual]
 

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors.

virtual int vtkUnstructuredGridVolumeRayCastMapper::GetScalarMode (   )  [virtual]
 

void vtkUnstructuredGridVolumeRayCastMapper::SetScalarModeToDefault (   )  [inline]
 

Definition at line 65 of file vtkUnstructuredGridVolumeRayCastMapper.h.

References VTK_SCALAR_MODE_DEFAULT.

void vtkUnstructuredGridVolumeRayCastMapper::SetScalarModeToUsePointData (   )  [inline]
 

Definition at line 67 of file vtkUnstructuredGridVolumeRayCastMapper.h.

References VTK_SCALAR_MODE_USE_POINT_DATA.

void vtkUnstructuredGridVolumeRayCastMapper::SetScalarModeToUseCellData (   )  [inline]
 

Definition at line 69 of file vtkUnstructuredGridVolumeRayCastMapper.h.

References VTK_SCALAR_MODE_USE_CELL_DATA.

void vtkUnstructuredGridVolumeRayCastMapper::SetScalarModeToUsePointFieldData (   )  [inline]
 

Definition at line 71 of file vtkUnstructuredGridVolumeRayCastMapper.h.

References VTK_SCALAR_MODE_USE_POINT_FIELD_DATA.

void vtkUnstructuredGridVolumeRayCastMapper::SetScalarModeToUseCellFieldData (   )  [inline]
 

Definition at line 73 of file vtkUnstructuredGridVolumeRayCastMapper.h.

References VTK_SCALAR_MODE_USE_CELL_FIELD_DATA.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SelectScalarArray (  int  arrayNum  )  [virtual]
 

When ScalarMode is set to UsePointFileData or UseCellFieldData, you can specify which array to use for coloring using these methods. The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SelectScalarArray (  const char *  arrayName  )  [virtual]
 

When ScalarMode is set to UsePointFileData or UseCellFieldData, you can specify which array to use for coloring using these methods. The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

virtual char* vtkUnstructuredGridVolumeRayCastMapper::GetArrayName (   )  [inline, virtual]
 

Get the array name or number and component to color by.

Definition at line 88 of file vtkUnstructuredGridVolumeRayCastMapper.h.

virtual int vtkUnstructuredGridVolumeRayCastMapper::GetArrayId (   )  [inline, virtual]
 

Get the array name or number and component to color by.

Definition at line 89 of file vtkUnstructuredGridVolumeRayCastMapper.h.

virtual int vtkUnstructuredGridVolumeRayCastMapper::GetArrayAccessMode (   )  [inline, virtual]
 

Get the array name or number and component to color by.

Definition at line 90 of file vtkUnstructuredGridVolumeRayCastMapper.h.

const char* vtkUnstructuredGridVolumeRayCastMapper::GetScalarModeAsString (   ) 
 

Return the method for obtaining scalar data.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetImageSampleDistance (  float   )  [virtual]
 

Sampling distance in the XY image dimensions. Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels.

virtual float vtkUnstructuredGridVolumeRayCastMapper::GetImageSampleDistance (   )  [virtual]
 

Return the method for obtaining scalar data.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetMinimumImageSampleDistance (  float   )  [virtual]
 

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted

virtual float vtkUnstructuredGridVolumeRayCastMapper::GetMinimumImageSampleDistance (   )  [virtual]
 

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetMaximumImageSampleDistance (  float   )  [virtual]
 

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted

virtual float vtkUnstructuredGridVolumeRayCastMapper::GetMaximumImageSampleDistance (   )  [virtual]
 

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetAutoAdjustSampleDistances (  int   )  [virtual]
 

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual int vtkUnstructuredGridVolumeRayCastMapper::GetAutoAdjustSampleDistances (   )  [virtual]
 

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkUnstructuredGridVolumeRayCastMapper::AutoAdjustSampleDistancesOn (   )  [virtual]
 

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkUnstructuredGridVolumeRayCastMapper::AutoAdjustSampleDistancesOff (   )  [virtual]
 

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetNumberOfThreads (  int   )  [virtual]
 

Set/Get the number of threads to use. This by default is equal to the number of available processors detected.

virtual int vtkUnstructuredGridVolumeRayCastMapper::GetNumberOfThreads (   )  [virtual]
 

Set/Get the number of threads to use. This by default is equal to the number of available processors detected.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetIntermixIntersectingGeometry (  int   )  [virtual]
 

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual int vtkUnstructuredGridVolumeRayCastMapper::GetIntermixIntersectingGeometry (   )  [virtual]
 

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkUnstructuredGridVolumeRayCastMapper::IntermixIntersectingGeometryOn (   )  [virtual]
 

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkUnstructuredGridVolumeRayCastMapper::IntermixIntersectingGeometryOff (   )  [virtual]
 

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetRayCastFunction (  vtkUnstructuredGridVolumeRayCastFunction *  f  )  [virtual]
 

Set/Get the helper class for casting rays.

virtual vtkUnstructuredGridVolumeRayCastFunction* vtkUnstructuredGridVolumeRayCastMapper::GetRayCastFunction (   )  [virtual]
 

Set/Get the helper class for casting rays.

virtual void vtkUnstructuredGridVolumeRayCastMapper::SetRayIntegrator (  vtkUnstructuredGridVolumeRayIntegrator *  ri  )  [virtual]
 

Set/Get the helper class for integrating rays. If set to NULL, a default integrator will be assigned.

virtual vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridVolumeRayCastMapper::GetRayIntegrator (   )  [virtual]
 

Set/Get the helper class for integrating rays. If set to NULL, a default integrator will be assigned.

void vtkUnstructuredGridVolumeRayCastMapper::Render (  vtkRenderer *  ,
vtkVolume * 
)  [virtual]
 

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume.

Implements vtkUnstructuredGridVolumeMapper.

void vtkUnstructuredGridVolumeRayCastMapper::ReleaseGraphicsResources (  vtkWindow *   )  [virtual]
 

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkUnstructuredGridVolumeMapper.

virtual int* vtkUnstructuredGridVolumeRayCastMapper::GetImageInUseSize (   )  [virtual]
 

virtual void vtkUnstructuredGridVolumeRayCastMapper::GetImageInUseSize (  int  data[2]  )  [virtual]
 

virtual int* vtkUnstructuredGridVolumeRayCastMapper::GetImageOrigin (   )  [virtual]
 

virtual void vtkUnstructuredGridVolumeRayCastMapper::GetImageOrigin (  int  data[2]  )  [virtual]
 

virtual int* vtkUnstructuredGridVolumeRayCastMapper::GetImageViewportSize (   )  [virtual]
 

virtual void vtkUnstructuredGridVolumeRayCastMapper::GetImageViewportSize (  int  data[2]  )  [virtual]
 

void vtkUnstructuredGridVolumeRayCastMapper::CastRays (  int  threadID,
int  threadCount
) 
 

void vtkUnstructuredGridVolumeRayCastMapper::StoreRenderTime (  vtkRenderer *  ren,
vtkVolume *  vol,
float  t
)  [protected]
 

float vtkUnstructuredGridVolumeRayCastMapper::RetrieveRenderTime (  vtkRenderer *  ren,
vtkVolume *  vol
)  [protected]
 

double vtkUnstructuredGridVolumeRayCastMapper::GetZBufferValue (  int  x,
int  y
)  [protected]
 

double vtkUnstructuredGridVolumeRayCastMapper::GetMinimumBoundsDepth (  vtkRenderer *  ren,
vtkVolume *  vol
)  [protected]
 

Member Data Documentation

float vtkUnstructuredGridVolumeRayCastMapper::ImageSampleDistance [protected]
 

Definition at line 178 of file vtkUnstructuredGridVolumeRayCastMapper.h.

float vtkUnstructuredGridVolumeRayCastMapper::MinimumImageSampleDistance [protected]
 

Definition at line 179 of file vtkUnstructuredGridVolumeRayCastMapper.h.

float vtkUnstructuredGridVolumeRayCastMapper::MaximumImageSampleDistance [protected]
 

Definition at line 180 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::AutoAdjustSampleDistances [protected]
 

Definition at line 181 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkMultiThreader* vtkUnstructuredGridVolumeRayCastMapper::Threader [protected]
 

Definition at line 183 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::NumberOfThreads [protected]
 

Definition at line 184 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkRayCastImageDisplayHelper* vtkUnstructuredGridVolumeRayCastMapper::ImageDisplayHelper [protected]
 

Definition at line 186 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ImageViewportSize[2] [protected]
 

Definition at line 189 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ImageMemorySize[2] [protected]
 

Definition at line 195 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ImageInUseSize[2] [protected]
 

Definition at line 201 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ImageOrigin[2] [protected]
 

Definition at line 205 of file vtkUnstructuredGridVolumeRayCastMapper.h.

unsigned char* vtkUnstructuredGridVolumeRayCastMapper::Image [protected]
 

Definition at line 208 of file vtkUnstructuredGridVolumeRayCastMapper.h.

float* vtkUnstructuredGridVolumeRayCastMapper::RenderTimeTable [protected]
 

Definition at line 210 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkVolume** vtkUnstructuredGridVolumeRayCastMapper::RenderVolumeTable [protected]
 

Definition at line 211 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkRenderer** vtkUnstructuredGridVolumeRayCastMapper::RenderRendererTable [protected]
 

Definition at line 212 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::RenderTableSize [protected]
 

Definition at line 213 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::RenderTableEntries [protected]
 

Definition at line 214 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::IntermixIntersectingGeometry [protected]
 

Definition at line 219 of file vtkUnstructuredGridVolumeRayCastMapper.h.

float* vtkUnstructuredGridVolumeRayCastMapper::ZBuffer [protected]
 

Definition at line 221 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ZBufferSize[2] [protected]
 

Definition at line 222 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ZBufferOrigin[2] [protected]
 

Definition at line 223 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkUnstructuredGridVolumeRayCastFunction* vtkUnstructuredGridVolumeRayCastMapper::RayCastFunction [protected]
 

Definition at line 233 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkUnstructuredGridVolumeRayCastIterator** vtkUnstructuredGridVolumeRayCastMapper::RayCastIterators [protected]
 

Definition at line 234 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridVolumeRayCastMapper::RayIntegrator [protected]
 

Definition at line 235 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridVolumeRayCastMapper::RealRayIntegrator [protected]
 

Definition at line 236 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkVolume* vtkUnstructuredGridVolumeRayCastMapper::CurrentVolume [protected]
 

Definition at line 238 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkRenderer* vtkUnstructuredGridVolumeRayCastMapper::CurrentRenderer [protected]
 

Definition at line 239 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ScalarMode [protected]
 

Definition at line 241 of file vtkUnstructuredGridVolumeRayCastMapper.h.

char* vtkUnstructuredGridVolumeRayCastMapper::ArrayName [protected]
 

Definition at line 242 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ArrayId [protected]
 

Definition at line 243 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::ArrayAccessMode [protected]
 

Definition at line 244 of file vtkUnstructuredGridVolumeRayCastMapper.h.

vtkDataArray* vtkUnstructuredGridVolumeRayCastMapper::Scalars [protected]
 

Definition at line 246 of file vtkUnstructuredGridVolumeRayCastMapper.h.

int vtkUnstructuredGridVolumeRayCastMapper::CellScalars [protected]
 

Definition at line 247 of file vtkUnstructuredGridVolumeRayCastMapper.h.

The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:27:24 2008 for VTK by  doxygen 1.4.3-20050530