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

#include <vtkVolume.h>

Inheritance diagram for vtkVolume:

Collaboration diagram for vtkVolume:

Public Types
typedef vtkProp3D	Superclass

Public Types inherited from vtkProp3D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkVolume *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	GetVolumes (vtkPropCollection *vc)

void	Update ()

unsigned long int	GetMTime ()

unsigned long	GetRedrawMTime ()

void	ShallowCopy (vtkProp *prop)

int	RenderVolumetricGeometry (vtkViewport *viewport)

void	ReleaseGraphicsResources (vtkWindow *)

void	UpdateTransferFunctions (vtkRenderer *ren)


void	SetMapper (vtkAbstractVolumeMapper *mapper)

virtual vtkAbstractVolumeMapper *	GetMapper ()


void	SetProperty (vtkVolumeProperty *property)

vtkVolumeProperty *	GetProperty ()


double *	GetBounds ()

void	GetBounds (double bounds[6])

double	GetMinXBound ()

double	GetMaxXBound ()

double	GetMinYBound ()

double	GetMaxYBound ()

double	GetMinZBound ()

double	GetMaxZBound ()


float *	GetCorrectedScalarOpacityArray (int)

float *	GetCorrectedScalarOpacityArray ()


float *	GetScalarOpacityArray (int)

float *	GetScalarOpacityArray ()


float *	GetGradientOpacityArray (int)

float *	GetGradientOpacityArray ()


float *	GetGrayArray (int)

float *	GetGrayArray ()


float *	GetRGBArray (int)

float *	GetRGBArray ()


float	GetGradientOpacityConstant (int)

float	GetGradientOpacityConstant ()


float	GetArraySize ()


void	UpdateScalarOpacityforSampleSize (vtkRenderer *ren, float sample_distance)

Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const

virtual void	SetPosition (double pos[3])

virtual double *	GetPosition ()

virtual void	GetPosition (double data[3])

void	AddPosition (double deltaPosition[3])

void	AddPosition (double deltaX, double deltaY, double deltaZ)

double *	GetCenter ()

double *	GetXRange ()

double *	GetYRange ()

double *	GetZRange ()

double	GetLength ()

void	RotateX (double)

void	RotateY (double)

void	RotateZ (double)

void	RotateWXYZ (double w, double x, double y, double z)

void	SetOrientation (double x, double y, double z)

void	SetOrientation (double orientation[3])

double *	GetOrientationWXYZ ()

void	AddOrientation (double x, double y, double z)

void	AddOrientation (double orentation[3])

void	PokeMatrix (vtkMatrix4x4 *matrix)

void	InitPathTraversal ()

unsigned long int	GetUserTransformMatrixMTime ()

virtual void	ComputeMatrix ()

virtual void	SetPosition (double x, double y, double z)

virtual void	SetOrigin (double x, double y, double z)

virtual void	SetOrigin (const double pos[3])

virtual double *	GetOrigin ()

virtual void	GetOrigin (double data[3])

virtual void	SetScale (double x, double y, double z)

virtual void	SetScale (double scale[3])

virtual double *	GetScale ()

virtual void	GetScale (double data[3])

void	SetScale (double s)

void	SetUserTransform (vtkLinearTransform *transform)

virtual vtkLinearTransform *	GetUserTransform ()

void	SetUserMatrix (vtkMatrix4x4 *matrix)

vtkMatrix4x4 *	GetUserMatrix ()

virtual void	GetMatrix (vtkMatrix4x4 *m)

virtual void	GetMatrix (double m[16])

void	GetBounds (double bounds[6])

double *	GetOrientation ()

void	GetOrientation (double orentation[3])

vtkMatrix4x4 *	GetMatrix ()

virtual int	GetIsIdentity ()

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual int	HasTranslucentPolygonalGeometry ()

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkVolume *	SafeDownCast (vtkObjectBase *o)

static vtkVolume *	New ()

Static Public Member Functions inherited from vtkProp3D
static int	IsTypeOf (const char *type)

static vtkProp3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVolume ()

	~vtkVolume ()

double	ComputeScreenCoverage (vtkViewport *vp)

Protected Member Functions inherited from vtkProp3D
	vtkProp3D ()

	~vtkProp3D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkAbstractVolumeMapper *	Mapper

vtkVolumeProperty *	Property

float *	RGBArray [VTK_MAX_VRCOMP]

vtkTimeStamp	RGBArrayMTime [VTK_MAX_VRCOMP]

float *	GrayArray [VTK_MAX_VRCOMP]

vtkTimeStamp	GrayArrayMTime [VTK_MAX_VRCOMP]

float *	ScalarOpacityArray [VTK_MAX_VRCOMP]

vtkTimeStamp	ScalarOpacityArrayMTime [VTK_MAX_VRCOMP]

float *	CorrectedScalarOpacityArray [VTK_MAX_VRCOMP]

vtkTimeStamp	CorrectedScalarOpacityArrayMTime [VTK_MAX_VRCOMP]

float	CorrectedStepSize

int	ArraySize

float	GradientOpacityArray [VTK_MAX_VRCOMP][256]

float	GradientOpacityConstant [VTK_MAX_VRCOMP]

vtkTimeStamp	GradientOpacityArrayMTime [VTK_MAX_VRCOMP]

Protected Attributes inherited from vtkProp3D
vtkLinearTransform *	UserTransform

vtkMatrix4x4 *	UserMatrix

vtkMatrix4x4 *	Matrix

vtkTimeStamp	MatrixMTime

double	Origin [3]

double	Position [3]

double	Orientation [3]

double	Scale [3]

double	Center [3]

vtkTransform *	Transform

double	Bounds [6]

vtkProp3D *	CachedProp3D

int	IsIdentity

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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

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: vtkAbstractVolumeMapper vtkVolumeProperty vtkProp3D

Examples:: vtkVolume (Examples)

Tests:: vtkVolume (Tests)

Definition at line 49 of file vtkVolume.h.

Member Typedef Documentation

typedef vtkProp3D vtkVolume::Superclass

Definition at line 52 of file vtkVolume.h.

Constructor & Destructor Documentation

vtkVolume::vtkVolume ( )

protected

vtkVolume::~vtkVolume ( )

protected

Member Function Documentation

static int vtkVolume::IsTypeOf ( const char * type )

static

virtual int vtkVolume::IsA ( const char * name )

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.

static vtkVolume* vtkVolume::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkVolume::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

vtkVolume* vtkVolume::NewInstance ( ) const

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.

static 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).

void vtkVolume::SetMapper ( vtkAbstractVolumeMapper * mapper )

Set/Get the volume mapper.

virtual vtkAbstractVolumeMapper* 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 ( )

Update the volume rendering pipeline by updating the volume mapper

double* vtkVolume::GetBounds ( )

virtual

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

Implements vtkProp3D.

void vtkVolume::GetBounds ( double bounds[6] )

inline

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

Definition at line 84 of file vtkVolume.h.

double vtkVolume::GetMinXBound ( )

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

double vtkVolume::GetMaxXBound ( )

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

double vtkVolume::GetMinYBound ( )

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

double vtkVolume::GetMaxYBound ( )

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

double vtkVolume::GetMinZBound ( )

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

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

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::RenderVolumetricGeometry ( 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 ( int )