Man Page for vtkVolume
Table of Contents

NAME

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

SYNOPSIS


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

class VTK_EXPORT vtkVolume : public vtkProp

vtkVolume();
~vtkVolume();
static vtkVolume *New() {return new vtkVolume;};
const char *GetClassName() {return "vtkVolume";};
void PrintSelf(ostream& os, vtkIndent indent);
vtkVolume &operator=(const vtkVolume& volume);
virtual void Render(vtkRenderer *ren);
virtual void Update();
float GetScale();
void SetScale(float);
void GetMatrix(vtkMatrix4x4& m);
float *GetBounds();
float GetMinXBound();
float GetMaxXBound();
float GetMinYBound();
float GetMaxYBound();
float GetMinZBound();
float GetMaxZBound();
void SetVolumeMapper(vtkVolumeMapper*);
void SetVolumeMapper(vtkVolumeMapper& );
vtkVolumeMapper *GetVolumeMapper();
void SetVolumeProperty(vtkVolumeProperty *property);
void SetVolumeProperty(vtkVolumeProperty& property) {this->SetVolumeProperty(&property);};
vtkVolumeProperty *GetVolumeProperty();
unsigned long int GetMTime(); overload superclasses' implementation

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 also 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

SUMMARY

float GetScale()
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.

void SetVolumeMapper(vtkVolumeMapper*)
void SetVolumeMapper(vtkVolumeMapper& )
Get the matrix from the position, origin, scale and orientation This matrix is cached, so multiple GetMatrix() calls will be efficient. Get the bounds. GetBounds(), GetXRange(), GetYRange(), and GetZRange
return world coordinates. Set/Get the volume mapper.

vtkVolume()
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).

~vtkVolume()
Destruct a volume

vtkVolume& operator=(const vtkVolume& volume)
Shallow copy of an volume.

void GetMatrix(vtkMatrix4x4& result)
Copy the volume's composite 4x4 matrix into the matrix provided.

float *GetBounds()
Get the bounds for this Volume as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

float GetMinXBound( )
Get the minimum X bound

float GetMaxXBound( )
Get the maximum X bound

float GetMinYBound( )
Get the minimum Y bound

float GetMaxYBound( )
Get the maximum Y bound

float GetMinZBound( )
Get the minimum Z bound

float GetMaxZBound( )
Get the maximum Z bound


Table of Contents