Documentation for vtkVolume

vtkVolume - represents a volume (data & properties) in a rendered scene

Super Class: vtkProp

Description:

vtkVolume is used to represent a volumetric entity in a rendering scene. It inherits functions related to the volume's position, orientation and origin from vtkProp. The volume maintains a reference to the volumetric data (i.e., the volume mapper). The volume also contains a reference to a volume property which contains all common volume rendering parameters.

See Also:

vtkVolumeMapper vtkVolumeProperty vtkProp

Methods:

	void vtkVolume ()
	void vtkVolume ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	static vtkVolume *New ()
	void Render (vtkRenderer *)
	void Update ()
	float GetScale ()
	void SetScale (float )
	void GetMatrix (vtkMatrix4x4 *)
	float *GetBounds ()
	float GetMinXBound ()
	float GetMaxXBound ()
	float GetMinYBound ()
	float GetMaxYBound ()
	float GetMinZBound ()
	float GetMaxZBound ()
	void SetVolumeMapper (vtkVolumeMapper *)
	vtkVolumeMapper *GetVolumeMapper ()
	void SetVolumeProperty (vtkVolumeProperty *)
	vtkVolumeProperty *GetVolumeProperty ()
	unsigned long GetMTime ()
	void GetMatrix (vtkMatrix4x4 &)
	void SetVolumeProperty (vtkVolumeProperty &)

Detailed Method Descriptions:

Creates a Volume with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pickable=1 dragable=1 orientation=(0,0,0).

static vtkVolume *New ()

Render the volume by calling the Render() method of its mapper

void Render (vtkRenderer *)

Update the volume rendering pipeline by updating the volume mapper

void Update ()

Set/Get the scale of the volume. Scaling in performed isotropically in X,Y and Z. Any scale values that are zero will be automatically converted to one. Non-isotropic scaling must be done in the scalar data provided to vtkVolumeMapper.

	float GetScale ()
	void SetScale (float )

Get the matrix from the position, origin, scale and orientation This matrix is cached, so multiple GetMatrix() calls will be efficient.

void GetMatrix (vtkMatrix4x4 *)

Get the bounds. GetBounds(), GetXRange(), GetYRange(), and GetZRange return world coordinates.

	float *GetBounds ()
	float GetMinXBound ()
	float GetMaxXBound ()
	float GetMinYBound ()
	float GetMaxYBound ()
	float GetMinZBound ()
	float GetMaxZBound ()

Set/Get the volume mapper.

	void SetVolumeMapper (vtkVolumeMapper *)
	vtkVolumeMapper *GetVolumeMapper ()

Set/Get the volume property.

	void SetVolumeProperty (vtkVolumeProperty *)
	vtkVolumeProperty *GetVolumeProperty ()

Return the MTime also considering the property etc.

unsigned long GetMTime ()

For legacy compatibility. Do not use.

void GetMatrix (vtkMatrix4x4 &)