vtkVolume Class Reference

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
enum	CoordinateSystems { WORLD = 0 , PHYSICAL = 1 , DEVICE = 2 }
	Specify the coordinate system that this prop is relative to. More...
Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkVolume *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	GetVolumes (vtkPropCollection *vc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
void	Update ()
	Update the volume rendering pipeline by updating the volume mapper.
vtkMTimeType	GetMTime () override
	Return the MTime also considering the property etc.
vtkMTimeType	GetRedrawMTime () override
	Return the mtime of anything that would cause the rendered image to appear differently.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkVolume.
int	RenderVolumetricGeometry (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods.
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this volume.
float *	GetCorrectedScalarOpacityArray (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
float *	GetCorrectedScalarOpacityArray ()
float *	GetScalarOpacityArray (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
float *	GetScalarOpacityArray ()
float *	GetGradientOpacityArray (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
float *	GetGradientOpacityArray ()
float *	GetGrayArray (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
float *	GetGrayArray ()
float *	GetRGBArray (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
float *	GetRGBArray ()
float	GetGradientOpacityConstant (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
float	GetGradientOpacityConstant ()
float	GetArraySize ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
void	UpdateTransferFunctions (vtkRenderer *ren)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
void	UpdateScalarOpacityforSampleSize (vtkRenderer *ren, float sample_distance)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
bool	GetSupportsSelection () override
	Used by vtkHardwareSelector to determine if the prop supports hardware selection.
void	SetMapper (vtkAbstractVolumeMapper *mapper)
	Set/Get the volume mapper.
virtual vtkAbstractVolumeMapper *	GetMapper ()
	Set/Get the volume mapper.
virtual void	SetProperty (vtkVolumeProperty *property)
	Set/Get the volume property.
virtual vtkVolumeProperty *	GetProperty ()
	Set/Get the volume property.
double *	GetBounds () override
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
void	GetBounds (double bounds[6])
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double	GetMinXBound ()
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double	GetMaxXBound ()
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double	GetMinYBound ()
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double	GetMaxYBound ()
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double	GetMinZBound ()
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
double	GetMaxZBound ()
	Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
Public Member Functions inherited from vtkProp3D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp3D.
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)
void	SetScale (double s)
	Method to set the scale isotropically.
virtual void	SetPropertiesFromModelToWorldMatrix (vtkMatrix4x4 *modelToWorld)
	Set the position, scale, orientation from a provided model to world matrix.
double *	GetCenter ()
	Get the center of the bounding box in world coordinates.
double *	GetXRange ()
	Get the Prop3D's x range in world coordinates.
double *	GetYRange ()
	Get the Prop3D's y range in world coordinates.
double *	GetZRange ()
	Get the Prop3D's z range in world coordinates.
double	GetLength ()
	Get the length of the diagonal of the bounding box.
void	RotateX (double)
	Rotate the Prop3D in degrees about the X axis using the right hand rule.
void	RotateY (double)
	Rotate the Prop3D in degrees about the Y axis using the right hand rule.
void	RotateZ (double)
	Rotate the Prop3D in degrees about the Z axis using the right hand rule.
void	RotateWXYZ (double w, double x, double y, double z)
	Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments.
void	SetOrientation (double x, double y, double z)
	Sets the orientation of the Prop3D.
void	SetOrientation (double orientation[3])
	Sets the orientation of the Prop3D.
double *	GetOrientationWXYZ ()
	Returns the WXYZ orientation of the Prop3D.
void	AddOrientation (double x, double y, double z)
	Add to the current orientation.
void	AddOrientation (double orentation[3])
	Add to the current orientation.
void	PokeMatrix (vtkMatrix4x4 *matrix) override
	This method modifies the vtkProp3D so that its transformation state is set to the matrix specified.
void	InitPathTraversal () override
	Overload vtkProp's method for setting up assembly paths.
vtkMTimeType	GetMTime () override
	Get the vtkProp3D's mtime.
vtkMTimeType	GetUserTransformMatrixMTime ()
	Get the modified time of the user matrix or user transform.
virtual void	SetPosition (double x, double y, double z)
	Set/Get/Add the position of the Prop3D in world coordinates.
virtual void	SetOrigin (double x, double y, double z)
	Set/Get the origin of the Prop3D.
virtual void	SetOrigin (const double pos[3])
	Set/Get the origin of the Prop3D.
virtual double *	GetOrigin ()
	Set/Get the origin of the Prop3D.
virtual void	GetOrigin (double data[3])
	Set/Get the origin of the Prop3D.
virtual void	SetScale (double x, double y, double z)
	Set/Get the scale of the actor.
virtual void	SetScale (double scale[3])
	Set/Get the scale of the actor.
virtual double *	GetScale ()
	Set/Get the scale of the actor.
virtual void	GetScale (double data[3])
	Set/Get the scale of the actor.
void	SetUserTransform (vtkLinearTransform *transform)
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
virtual vtkLinearTransform *	GetUserTransform ()
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
void	SetUserMatrix (vtkMatrix4x4 *matrix)
	The UserMatrix can be used in place of UserTransform.
vtkMatrix4x4 *	GetUserMatrix ()
	The UserMatrix can be used in place of UserTransform.
virtual void	GetMatrix (vtkMatrix4x4 *result)
	Return a reference to the Prop3D's 4x4 composite matrix.
virtual void	GetMatrix (double result[16])
	Return a reference to the Prop3D's 4x4 composite matrix.
virtual void	GetModelToWorldMatrix (vtkMatrix4x4 *result)
	Return a reference to the Prop3D's Model to World matrix.
void	GetBounds (double bounds[6])
	Return a reference to the Prop3D's composite transform.
double *	GetOrientation ()
	Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.
void	GetOrientation (double orentation[3])
	Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.
virtual void	ComputeMatrix ()
	Generate the matrix based on ivars.
vtkMatrix4x4 *	GetMatrix () override
	Get a pointer to an internal vtkMatrix4x4.
virtual vtkTypeBool	GetIsIdentity ()
	Is the matrix for this actor identity.
void	SetCoordinateSystemRenderer (vtkRenderer *ren)
	Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.
vtkRenderer *	GetCoordinateSystemRenderer ()
	Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.
virtual void	SetCoordinateSystemDevice (int)
	Specify the device to be used when the coordinate system is set to DEVICE.
virtual int	GetCoordinateSystemDevice ()
	Specify the device to be used when the coordinate system is set to DEVICE.
void	SetCoordinateSystemToWorld ()
	Specify the coordinate system that this prop is relative to.
void	SetCoordinateSystemToPhysical ()
	Specify the coordinate system that this prop is relative to.
void	SetCoordinateSystemToDevice ()
	Specify the coordinate system that this prop is relative to.
void	SetCoordinateSystem (CoordinateSystems val)
	Specify the coordinate system that this prop is relative to.
virtual CoordinateSystems	GetCoordinateSystem ()
	Specify the coordinate system that this prop is relative to.
const char *	GetCoordinateSystemAsString ()
	Specify the coordinate system that this prop is relative to.
Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.
virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.
virtual void	PokeMatrix (vtkMatrix4x4 *matrix)
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
virtual vtkMatrix4x4 *	GetMatrix ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.
virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.
virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
virtual double	GetEstimatedRenderTime (vtkViewport *)
	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.
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vp)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
virtual double	GetRenderTimeMultiplier ()
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers
virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.
virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.
virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.
virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.
virtual void	PickableOn ()
	Set/Get the pickable instance variable.
virtual void	PickableOff ()
	Set/Get the pickable instance variable.
virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.
virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.
virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.
virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.
virtual void	SetAllocatedRenderTime (double t, vtkViewport *v)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.
virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
virtual int	GetNumberOfConsumers ()
	Get the number of consumers.
void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.
int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.
virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.
virtual bool	IsRenderingTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkVolume *	SafeDownCast (vtkObjectBase *o)
static vtkVolume *	New ()
	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 Public Member Functions inherited from vtkProp3D
static vtkTypeBool	IsTypeOf (const char *type)
static vtkProp3D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProp
static vtkTypeBool	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVolume ()
	~vtkVolume () override
double	ComputeScreenCoverage (vtkViewport *vp)
Protected Member Functions inherited from vtkProp3D
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProp3D ()
	~vtkProp3D () override
Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProp ()
	~vtkProp () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	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
vtkTypeBool	IsIdentity
int	CoordinateSystemDevice
CoordinateSystems	CoordinateSystem = WORLD
vtkWeakPointer< vtkRenderer >	CoordinateSystemRenderer
vtkNew< vtkMatrix4x4 >	TempMatrix4x4
Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility
vtkTypeBool	Pickable
vtkTypeBool	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
vtkShaderProperty *	ShaderProperty
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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)

Online Examples:

MedicalDemo4

FixedPointVolumeRayCastMapperCT

IntermixedUnstructuredGrid

MinIntensityRendering

MultiBlockVolumeMapper

OpenVRVolume

RayCastIsosurface

SimpleRayCast

Tests:

vtkVolume (Tests)

Definition at line 129 of file vtkVolume.h.

Member Typedef Documentation

Superclass

typedef vtkProp3D vtkVolume::Superclass

Definition at line 132 of file vtkVolume.h.

Constructor & Destructor Documentation

vtkVolume()

vtkVolume::vtkVolume ( )

protected

~vtkVolume()

vtkVolume::~vtkVolume ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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.

Reimplemented in vtkMultiVolume.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkVolume::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

Reimplemented in vtkMultiVolume.

NewInstance()

vtkVolume * vtkVolume::NewInstance

(

)

const

PrintSelf()

void vtkVolume::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

New()

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

SetMapper()

void vtkVolume::SetMapper

(

vtkAbstractVolumeMapper *

mapper

)

Set/Get the volume mapper.

GetMapper()

virtual vtkAbstractVolumeMapper * vtkVolume::GetMapper ( )

virtual

Set/Get the volume mapper.

SetProperty()

virtual void vtkVolume::SetProperty ( vtkVolumeProperty *  property )

virtual

Set/Get the volume property.

Reimplemented in vtkMultiVolume.

GetProperty()

virtual vtkVolumeProperty * vtkVolume::GetProperty ( )

virtual

Set/Get the volume property.

Reimplemented in vtkMultiVolume.

GetVolumes()

void vtkVolume::GetVolumes ( vtkPropCollection *  vc )

overridevirtual

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.

Update()

void vtkVolume::Update

(

)

Update the volume rendering pipeline by updating the volume mapper.

GetBounds() [1/2]

double * vtkVolume::GetBounds ( )

overridevirtual

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

Implements vtkProp3D.

GetBounds() [2/2]

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 176 of file vtkVolume.h.

GetMinXBound()

double vtkVolume::GetMinXBound

(

)

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

GetMaxXBound()

double vtkVolume::GetMaxXBound

(

)

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

GetMinYBound()

double vtkVolume::GetMinYBound

(

)

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

GetMaxYBound()

double vtkVolume::GetMaxYBound

(

)

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

GetMinZBound()

double vtkVolume::GetMinZBound

(

)

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

GetMaxZBound()

double vtkVolume::GetMaxZBound

(

)

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

GetMTime()

vtkMTimeType vtkVolume::GetMTime ( )

overridevirtual

Return the MTime also considering the property etc.

Reimplemented from vtkProp3D.

GetRedrawMTime()

vtkMTimeType vtkVolume::GetRedrawMTime ( )

overridevirtual

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.

ShallowCopy()

void vtkVolume::ShallowCopy ( vtkProp *  prop )

overridevirtual

Shallow copy of this vtkVolume.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp3D.

RenderVolumetricGeometry()

int vtkVolume::RenderVolumetricGeometry ( vtkViewport *  viewport )

overridevirtual

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.

ReleaseGraphicsResources()

void vtkVolume::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

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.

GetCorrectedScalarOpacityArray() [1/2]

float * vtkVolume::GetCorrectedScalarOpacityArray

(

int

)

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

GetCorrectedScalarOpacityArray() [2/2]

float * vtkVolume::GetCorrectedScalarOpacityArray ( )

inline

Definition at line 226 of file vtkVolume.h.

GetScalarOpacityArray() [1/2]

float * vtkVolume::GetScalarOpacityArray

(

int

)

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

GetScalarOpacityArray() [2/2]

float * vtkVolume::GetScalarOpacityArray ( )

inline

Definition at line 233 of file vtkVolume.h.

GetGradientOpacityArray() [1/2]

float * vtkVolume::GetGradientOpacityArray

(

int

)

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

GetGradientOpacityArray() [2/2]

float * vtkVolume::GetGradientOpacityArray ( )

inline

Definition at line 240 of file vtkVolume.h.

GetGrayArray() [1/2]

float * vtkVolume::GetGrayArray

(

int

)

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

GetGrayArray() [2/2]

float * vtkVolume::GetGrayArray ( )

inline

Definition at line 247 of file vtkVolume.h.

GetRGBArray() [1/2]

float * vtkVolume::GetRGBArray

(

int

)

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

GetRGBArray() [2/2]

float * vtkVolume::GetRGBArray ( )

inline

Definition at line 254 of file vtkVolume.h.

GetGradientOpacityConstant() [1/2]

float vtkVolume::GetGradientOpacityConstant

(

int

)

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

GetGradientOpacityConstant() [2/2]

float vtkVolume::GetGradientOpacityConstant ( )

inline

Definition at line 261 of file vtkVolume.h.

GetArraySize()

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 267 of file vtkVolume.h.

UpdateTransferFunctions()

void vtkVolume::UpdateTransferFunctions

(

vtkRenderer *

ren

)

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

UpdateScalarOpacityforSampleSize()

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.

GetSupportsSelection()

bool vtkVolume::GetSupportsSelection ( )

inlineoverridevirtual

Used by vtkHardwareSelector to determine if the prop supports hardware selection.

Warning

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

Reimplemented from vtkProp.

Definition at line 288 of file vtkVolume.h.

ComputeScreenCoverage()

double vtkVolume::ComputeScreenCoverage ( vtkViewport *  vp )

protected

Member Data Documentation

Mapper

vtkAbstractVolumeMapper* vtkVolume::Mapper

protected

Definition at line 294 of file vtkVolume.h.

Property

vtkVolumeProperty* vtkVolume::Property

protected

Definition at line 295 of file vtkVolume.h.

RGBArray

float* vtkVolume::RGBArray[VTK_MAX_VRCOMP]

protected

Definition at line 301 of file vtkVolume.h.

RGBArrayMTime

vtkTimeStamp vtkVolume::RGBArrayMTime[VTK_MAX_VRCOMP]

protected

Definition at line 302 of file vtkVolume.h.

GrayArray

float* vtkVolume::GrayArray[VTK_MAX_VRCOMP]

protected

Definition at line 308 of file vtkVolume.h.

GrayArrayMTime

vtkTimeStamp vtkVolume::GrayArrayMTime[VTK_MAX_VRCOMP]

protected

Definition at line 309 of file vtkVolume.h.

ScalarOpacityArray

float* vtkVolume::ScalarOpacityArray[VTK_MAX_VRCOMP]

protected

Definition at line 315 of file vtkVolume.h.

ScalarOpacityArrayMTime

vtkTimeStamp vtkVolume::ScalarOpacityArrayMTime[VTK_MAX_VRCOMP]

protected

Definition at line 316 of file vtkVolume.h.

CorrectedScalarOpacityArray

float* vtkVolume::CorrectedScalarOpacityArray[VTK_MAX_VRCOMP]

protected

Definition at line 322 of file vtkVolume.h.

CorrectedScalarOpacityArrayMTime

vtkTimeStamp vtkVolume::CorrectedScalarOpacityArrayMTime[VTK_MAX_VRCOMP]

protected

Definition at line 323 of file vtkVolume.h.

CorrectedStepSize

float vtkVolume::CorrectedStepSize

protected

Definition at line 329 of file vtkVolume.h.

ArraySize

int vtkVolume::ArraySize

protected

Definition at line 332 of file vtkVolume.h.

GradientOpacityArray

float vtkVolume::GradientOpacityArray[VTK_MAX_VRCOMP][256]

protected

Definition at line 335 of file vtkVolume.h.

GradientOpacityConstant

float vtkVolume::GradientOpacityConstant[VTK_MAX_VRCOMP]

protected

Definition at line 336 of file vtkVolume.h.

GradientOpacityArrayMTime

vtkTimeStamp vtkVolume::GradientOpacityArrayMTime[VTK_MAX_VRCOMP]

protected

Definition at line 337 of file vtkVolume.h.

---

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

• Rendering/Core/vtkVolume.h