---

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	SetMapper (vtkVolumeMapper *mapper)
virtual vtkVolumeMapper *	GetMapper ()
void	SetProperty (vtkVolumeProperty *property)
vtkVolumeProperty *	GetProperty ()
void	GetVolumes (vtkPropCollection *vc)
void	Update ()
float *	GetBounds ()
void	GetBounds (float bounds[6])
float	GetMinXBound ()
float	GetMaxXBound ()
float	GetMinYBound ()
float	GetMaxYBound ()
float	GetMinZBound ()
float	GetMaxZBound ()
unsigned long int	GetMTime ()
unsigned long	GetRedrawMTime ()
void	ShallowCopy (vtkProp *prop)
int	RenderTranslucentGeometry (vtkViewport *viewport)
int	RenderIntoImage (vtkViewport *viewport)
float *	GetRGBAImage ()
float *	GetZImage ()
int	RequiresRayCasting ()
int	RequiresRenderingIntoImage ()
virtual int	InitializeRayCasting (vtkViewport *viewport)
virtual void	InitializeTextureMapping (vtkViewport *viewport, float sampleDistance)
virtual int	CastViewRay (VTKRayCastRayInfo *rayInfo)
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	AddEstimatedRenderTime (float t, vtkViewport *vp)
float	GetEstimatedRenderTime (vtkViewport *vp)
float	GetEstimatedRenderTime ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkVolume *	SafeDownCast (vtkObject *o)
vtkVolume *	New ()
Protected Methods
	vtkVolume ()
	~vtkVolume ()
	vtkVolume (const vtkVolume &)
void	operator= (const 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
VTKRayCastVolumeInfo *	VolumeInfo

---

Detailed Description

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

Date:

2000/12/10 20:08:58

Revision:

1.55

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)

Definition at line 74 of file vtkVolume.h.

---

Constructor & Destructor Documentation

vtkVolume::vtkVolume (    )  [protected]

vtkVolume::~vtkVolume (    )  [protected]

vtkVolume::vtkVolume (  const vtkVolume &    )  [inline, protected]

Definition at line 228 of file vtkVolume.h.

---

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. Referenced by vtkVolumeCollection::GetNextVolume().

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]

void vtkVolume::SetProperty (  vtkVolumeProperty *    property )

Set/Get the volume property.

vtkVolumeProperty* vtkVolume::GetProperty (    )

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 for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). Reimplemented from vtkProp3D. Definition at line 104 of file vtkVolume.h.

float vtkVolume::GetMinXBound (    )

float vtkVolume::GetMaxXBound (    )

float vtkVolume::GetMinYBound (    )

float vtkVolume::GetMaxYBound (    )

float vtkVolume::GetMinZBound (    )

float vtkVolume::GetMaxZBound (    )

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.

int vtkVolume::RenderIntoImage (  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 (SOFTWAREBUFFER volumes such as multiray will be rendered this way) Reimplemented from vtkProp.

float* vtkVolume::GetRGBAImage (    )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods. These are the methods to access the image generated by the RenderIntoImage() method. Reimplemented from vtkProp.

float* vtkVolume::GetZImage (    )  [virtual]

Reimplemented from vtkProp.

int vtkVolume::RequiresRayCasting (    )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Do we need to ray cast this prop? Reimplemented from vtkProp.

int vtkVolume::RequiresRenderingIntoImage (    )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Does this prop render into an image? Reimplemented from vtkProp.

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

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support for ray casting if the mapper requires it - do the initialization and save up all the info required into a structure that will later be passed into the mapper when each ray is cast. Reimplemented from vtkProp.

virtual void vtkVolume::InitializeTextureMapping (  vtkViewport *    viewport, float    sampleDistance )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support for texture mapping if the mapper requires it - currently this only initializes transfer functions

virtual int vtkVolume::CastViewRay (  VTKRayCastRayInfo *    rayInfo )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support for ray casting if the mapper requires it - cast a ray that is defined in viewing coordinates 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 182 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 186 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 190 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 194 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 198 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 202 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 206 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

void vtkVolume::AddEstimatedRenderTime (  float    t, vtkViewport *    vp )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Override in order to take into account screen coverage

float vtkVolume::GetEstimatedRenderTime (  vtkViewport *    vp )  [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. The value is returned in seconds. For simple geometry the accuracy may not be great due to buffering. For ray casting, which is already multi-resolution, the current resolution of the image is factored into the time. We need the viewport for viewing parameters that affect timing. The no-arguments version simply returns the value of the variable with no estimation. Reimplemented from vtkProp.

float vtkVolume::GetEstimatedRenderTime (    )  [inline, virtual]

Reimplemented from vtkProp. Definition at line 221 of file vtkVolume.h.

void vtkVolume::operator= (  const vtkVolume &    )  [inline, protected]

Definition at line 229 of file vtkVolume.h.

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

---

Member Data Documentation

vtkVolumeMapper* vtkVolume::Mapper [protected]

Definition at line 231 of file vtkVolume.h.

vtkVolumeProperty* vtkVolume::Property [protected]

Definition at line 232 of file vtkVolume.h.

float* vtkVolume::RGBArray [protected]

Definition at line 238 of file vtkVolume.h.

vtkTimeStamp vtkVolume::RGBArrayMTime [protected]

Definition at line 239 of file vtkVolume.h.

float* vtkVolume::GrayArray [protected]

Definition at line 245 of file vtkVolume.h.

vtkTimeStamp vtkVolume::GrayArrayMTime [protected]

Definition at line 246 of file vtkVolume.h.

float* vtkVolume::ScalarOpacityArray [protected]

Definition at line 252 of file vtkVolume.h.

vtkTimeStamp vtkVolume::ScalarOpacityArrayMTime [protected]

Definition at line 253 of file vtkVolume.h.

float* vtkVolume::CorrectedScalarOpacityArray [protected]

Definition at line 259 of file vtkVolume.h.

float vtkVolume::CorrectedStepSize [protected]

Definition at line 265 of file vtkVolume.h.

vtkTimeStamp vtkVolume::CorrectedScalarOpacityArrayMTime [protected]

Definition at line 268 of file vtkVolume.h.

int vtkVolume::ArraySize [protected]

Definition at line 271 of file vtkVolume.h.

float vtkVolume::GradientOpacityArray[256] [protected]

Definition at line 274 of file vtkVolume.h.

float vtkVolume::GradientOpacityConstant [protected]

Definition at line 275 of file vtkVolume.h.

vtkTimeStamp vtkVolume::GradientOpacityArrayMTime [protected]

Definition at line 276 of file vtkVolume.h.

VTKRayCastVolumeInfo* vtkVolume::VolumeInfo [protected]

Definition at line 281 of file vtkVolume.h.

---

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

• graphics/vtkVolume.h

---