---

vtkVolume Class Reference

represents a volume (data & properties) in a rendered scene. More...

#include <vtkVolume.h>

Inheritance diagram for vtkVolume:

[legend]Collaboration diagram for vtkVolume:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	GetVolumes (vtkPropCollection *vc)
void	Update ()
unsigned long int	GetMTime ()
unsigned long	GetRedrawMTime ()
void	ShallowCopy (vtkProp *prop)
int	RenderTranslucentGeometry (vtkViewport *viewport)
void	ReleaseGraphicsResources (vtkWindow *)
float *	GetCorrectedScalarOpacityArray ()
float *	GetScalarOpacityArray ()
float *	GetGradientOpacityArray ()
float *	GetGrayArray ()
float *	GetRGBArray ()
float	GetGradientOpacityConstant ()
float	GetArraySize ()
void	UpdateTransferFunctions (vtkRenderer *ren)
void	UpdateScalarOpacityforSampleSize (vtkRenderer *ren, float sample_distance)
void	SetMapper (vtkVolumeMapper *mapper)
virtual vtkVolumeMapper *	GetMapper ()
void	SetProperty (vtkVolumeProperty *property)
vtkVolumeProperty *	GetProperty ()
float *	GetBounds ()
void	GetBounds (float bounds[6])
float	GetMinXBound ()
float	GetMaxXBound ()
float	GetMinYBound ()
float	GetMaxYBound ()
float	GetMinZBound ()
float	GetMaxZBound ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkVolume *	SafeDownCast (vtkObject *o)
vtkVolume *	New ()
Protected Methods
	vtkVolume ()
	~vtkVolume ()
float	ComputeScreenCoverage (vtkViewport *vp)
Protected Attributes
vtkVolumeMapper *	Mapper
vtkVolumeProperty *	Property
float *	RGBArray
vtkTimeStamp	RGBArrayMTime
float *	GrayArray
vtkTimeStamp	GrayArrayMTime
float *	ScalarOpacityArray
vtkTimeStamp	ScalarOpacityArrayMTime
float *	CorrectedScalarOpacityArray
float	CorrectedStepSize
vtkTimeStamp	CorrectedScalarOpacityArrayMTime
int	ArraySize
float	GradientOpacityArray [256]
float	GradientOpacityConstant
vtkTimeStamp	GradientOpacityArrayMTime

---

Detailed Description

represents a volume (data & properties) in a rendered scene.

Date:

2001/10/11 13:38:27

Revision:

1.59

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 vtkProp3D. 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 vtkProp3D

Examples:

vtkVolume (Examples)

Tests:

vtkVolume (Tests)

Definition at line 77 of file vtkVolume.h.

---

Constructor & Destructor Documentation

vtkVolume::vtkVolume (    )  [protected]

vtkVolume::~vtkVolume (    )  [protected]

---

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProp3D.

int vtkVolume::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProp3D.

virtual int vtkVolume::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProp3D.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProp3D.

void vtkVolume::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 vtkProp3D.

vtkVolume* vtkVolume::New (    )  [static]

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). Reimplemented from vtkProp.

void vtkVolume::SetMapper (  vtkVolumeMapper *    mapper )

Set/Get the volume mapper.

virtual vtkVolumeMapper* vtkVolume::GetMapper (    )  [virtual]

Set/Get the volume mapper.

void vtkVolume::SetProperty (  vtkVolumeProperty *    property )

Set/Get the volume property.

vtkVolumeProperty* vtkVolume::GetProperty (    )

Set/Get the volume property.

void vtkVolume::GetVolumes (  vtkPropCollection *    vc )  [virtual]

For some exporters and other other operations we must be able to collect all the actors or volumes. This method is used in that process. Reimplemented from vtkProp.

void vtkVolume::Update (  void    )

Update the volume rendering pipeline by updating the volume mapper

float* vtkVolume::GetBounds (    )  [virtual]

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. Reimplemented from vtkProp3D.

void vtkVolume::GetBounds (  float    bounds[6] )  [inline]

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. Reimplemented from vtkProp3D. Definition at line 112 of file vtkVolume.h.

float vtkVolume::GetMinXBound (    )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

float vtkVolume::GetMaxXBound (    )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

float vtkVolume::GetMinYBound (    )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

float vtkVolume::GetMaxYBound (    )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

float vtkVolume::GetMinZBound (    )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

float vtkVolume::GetMaxZBound (    )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

unsigned long int vtkVolume::GetMTime (    )  [virtual]

Return the MTime also considering the property etc. Reimplemented from vtkObject.

unsigned long vtkVolume::GetRedrawMTime (    )  [virtual]

Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, mappers, etc. Reimplemented from vtkProp.

void vtkVolume::ShallowCopy (  vtkProp *    prop )  [virtual]

Shallow copy of this vtkVolume. Overloads the virtual vtkProp method. Reimplemented from vtkProp3D.

int vtkVolume::RenderTranslucentGeometry (  vtkViewport *    viewport )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods. Depending on the mapper type, the volume may be rendered using this method (FRAMEBUFFER volume such as texture mapping will be rendered this way) Reimplemented from vtkProp.

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

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

float* vtkVolume::GetCorrectedScalarOpacityArray (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 149 of file vtkVolume.h.

float* vtkVolume::GetScalarOpacityArray (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 153 of file vtkVolume.h.

float* vtkVolume::GetGradientOpacityArray (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 157 of file vtkVolume.h.

float* vtkVolume::GetGrayArray (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 161 of file vtkVolume.h.

float* vtkVolume::GetRGBArray (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 165 of file vtkVolume.h.

float vtkVolume::GetGradientOpacityConstant (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 169 of file vtkVolume.h.

float vtkVolume::GetArraySize (    )  [inline]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Definition at line 173 of file vtkVolume.h.

void vtkVolume::UpdateTransferFunctions (  vtkRenderer *    ren )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS

void vtkVolume::UpdateScalarOpacityforSampleSize (  vtkRenderer *    ren, float    sample_distance )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS

float vtkVolume::ComputeScreenCoverage (  vtkViewport *    vp )  [protected]

---

Member Data Documentation

vtkVolumeMapper* vtkVolume::Mapper [protected]

Definition at line 189 of file vtkVolume.h.

vtkVolumeProperty* vtkVolume::Property [protected]

Definition at line 190 of file vtkVolume.h.

float* vtkVolume::RGBArray [protected]

Definition at line 196 of file vtkVolume.h.

vtkTimeStamp vtkVolume::RGBArrayMTime [protected]

Definition at line 197 of file vtkVolume.h.

float* vtkVolume::GrayArray [protected]

Definition at line 203 of file vtkVolume.h.

vtkTimeStamp vtkVolume::GrayArrayMTime [protected]

Definition at line 204 of file vtkVolume.h.

float* vtkVolume::ScalarOpacityArray [protected]

Definition at line 210 of file vtkVolume.h.

vtkTimeStamp vtkVolume::ScalarOpacityArrayMTime [protected]

Definition at line 211 of file vtkVolume.h.

float* vtkVolume::CorrectedScalarOpacityArray [protected]

Definition at line 217 of file vtkVolume.h.

float vtkVolume::CorrectedStepSize [protected]

Definition at line 223 of file vtkVolume.h.

vtkTimeStamp vtkVolume::CorrectedScalarOpacityArrayMTime [protected]

Definition at line 226 of file vtkVolume.h.

int vtkVolume::ArraySize [protected]

Definition at line 229 of file vtkVolume.h.

float vtkVolume::GradientOpacityArray[256] [protected]

Definition at line 232 of file vtkVolume.h.

float vtkVolume::GradientOpacityConstant [protected]

Definition at line 233 of file vtkVolume.h.

vtkTimeStamp vtkVolume::GradientOpacityArrayMTime [protected]

Definition at line 234 of file vtkVolume.h.

---

The documentation for this class was generated from the following file:

• Rendering/vtkVolume.h

---