Documentation for vtkVolumeMapper

vtkVolumeMapper - Abstract class for a volume mapper

Description:

vtkVolumeMapper is the abstract definition of a volume mapper. Several basic types of volume mappers are supported. There are ray casters, which produce an image that must be merged with geometry, there are hardware methods that blend with geometry, and some combinations of these.

See Also:

vtkVolumeRayCastMapper

Methods:

	void vtkVolumeMapper ()
	void vtkVolumeMapper ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	void Render (vtkRenderer * ,vtkVolume *)
	void Update ()
	float *GetBounds ()
	void GetBounds (float )
	float *GetCenter ()
	float GetLength ()
	int DestroyHardwareBuffer ()
	int ImageLocatedInHardware ()
	float *GetZbufferData ()
	float *GetRGBAPixelData ()
	void SetClipping (int )
	int GetClipping ()
	void ClippingOn ()
	void ClippingOff ()
	float GetXminClipPlane ()
	float GetXmaxClipPlane ()
	float GetYminClipPlane ()
	float GetYmaxClipPlane ()
	float GetZminClipPlane ()
	float GetZmaxClipPlane ()
	void SetClippingPlanes (float ,float ,float ,float ,float ,float )
	void SetClippingPlanes (float )
	float *GetClippingPlanes ()
	void SetScalarInput (vtkStructuredPoints *)
	void SetScalarInput (vtkImageCache *)
	vtkStructuredPoints *GetScalarInput ()

Detailed Method Descriptions:

Render the volume

void Render (vtkRenderer * ,vtkVolume *)

Update the volume rendering pipeline by updating the scalar input

void Update ()

Get the bounds of the scalar data.

float *GetBounds ()

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

void GetBounds (float )

Return the Center of this mapper's data.

float *GetCenter ()

Return the diagonal length of this mappers bounding box.

float GetLength ()

Will the hardware color and z buffers be destroyed during a render?

int DestroyHardwareBuffer ()

Will the image be in hardware when the render is complete?

int ImageLocatedInHardware ()

Get the z buffer data for the image.

float *GetZbufferData ()

Get the RGBA color buffer data for the image.

float *GetRGBAPixelData ()

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

	void SetClipping (int )
	int GetClipping ()
	void ClippingOn ()
	void ClippingOff ()

Get the clipping plane values one at a time

	float GetXminClipPlane ()
	float GetXmaxClipPlane ()
	float GetYminClipPlane ()
	float GetYmaxClipPlane ()
	float GetZminClipPlane ()
	float GetZmaxClipPlane ()

Set/Get the ClippingPlanes ( xmin, xmax, ymin, ymax, zmin, zmax )

	void SetClippingPlanes (float ,float ,float ,float ,float ,float )
	void SetClippingPlanes (float )
	float *GetClippingPlanes ()

Set/Get the scalar input data

	void SetScalarInput (vtkStructuredPoints *)
	void SetScalarInput (vtkImageCache *)
	vtkStructuredPoints *GetScalarInput ()