Man Page for vtkVolumeMapper
Table of Contents

NAME

vtkVolumeMapper - Abstract class for a volume mapper

SYNOPSIS


#include "/opt/vtk-c++/graphics/vtkVolumeMapper.h"

class VTK_EXPORT vtkVolumeMapper : public vtkObject

vtkVolumeMapper();
~vtkVolumeMapper();
const char *GetClassName() {return "vtkVolumeMapper";};
void PrintSelf( ostream& os, vtkIndent index );
void operator=(const vtkVolumeMapper& mapper);
virtual void Render(vtkRenderer *ren, vtkVolume *vol) = 0;
virtual void Update();
virtual float *GetBounds();
virtual int DestroyHardwareBuffer( void ) = 0;
virtual int ImageLocatedInHardware( void ) = 0;
virtual float *GetZbufferData( void ) = 0;
virtual float *GetRGBAPixelData( void ) = 0;
void SetClipping(int);
int GetClipping();
void ClippingOn();
void ClippingOff();
float GetXminClipPlane( void ) { return this->ClippingPlanes[0]; };
float GetXmaxClipPlane( void ) { return this->ClippingPlanes[1]; };
float GetYminClipPlane( void ) { return this->ClippingPlanes[2]; };
float GetYmaxClipPlane( void ) { return this->ClippingPlanes[3]; };
float GetZminClipPlane( void ) { return this->ClippingPlanes[4]; };
float GetZmaxClipPlane( void ) { return this->ClippingPlanes[5]; };
void SetClippingPlanes( float a, float b, float c,
float d, float e, float f );
void SetClippingPlanes( float p[6] );
float *GetClippingPlanes( void ) { return this->ClippingPlanes; };
void Set ScalarInput( vtkStructuredPoints *);
void Set ScalarInput( vtkStructuredPoints & );
void SetScalarInput(vtkImageCache *cache)
{this->SetScalarInput(cache->GetImageToStructuredPoints()->GetOutput());}
virtual vtkStructuredPoints *GetScalarInput() {return this->ScalarInput;};

DESCRIPTION

vtkVolumeMapper is the abstract definition of a volume mapper. All volume mappers must answer DestroyHardwareBuffer which indicates whether or not the hardware color and z buffers will be destroyed during the volume's render method, and ImageLocatedInHardware which indicates if the image will be in the hardware color and z buffers or should be obtained through the GetZbufferData and GetRGBAPixelData methods. In addition, every mapper must supply the bounds of its data.

SEE ALSO

vtkDepthPARCMapper vtkMIPDPARCMapper

SUMMARY

virtual float *GetBounds();
Get the bounds of the scalar data.

virtual int DestroyHardwareBuffer( void ) = 0;
Will the hardware color and z buffers be destroyed during a render?

virtual int ImageLocatedInHardware( void ) = 0;
Will the image be in hardware when the render is complete?

virtual float *GetZbufferData( void ) = 0;
Get the z buffer data for the image.

virtual float *GetRGBAPixelData( void ) = 0;
Get the RGBA color buffer data for the image.

void SetClipping(int)
Turn On/Off orthogonal clipping. (Clipping planes are perpendicular to the coordinate axes.)

void Set ScalarInput( vtkStructuredPoints *)
void Set ScalarInput( vtkStructuredPoints & )
Set/Get the ClippingPlanes ( xmin, xmax, ymin, ymax, zmin, zmax ) Set/Get the scalar input data

vtkVolumeMapper()
Construct a vtkVolumeMapper with empty scalar input and clipping off.

~vtkVolumeMapper()
Destroy the object.

float *GetBounds()
Get the bounds of the ScalarInput

void PrintSelf(ostream& os, vtkIndent indent)
Print the vtkVolumeMapper


Table of Contents