represents the common properties for rendering a volume. More...

#include <vtkVolumeProperty.h>

Inheritance diagram for vtkVolumeProperty:

Collaboration diagram for vtkVolumeProperty:

Public Types
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.

vtkVolumeProperty *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	DeepCopy (vtkVolumeProperty *p)

vtkMTimeType	GetMTime () override
	Get the modified time for this object (or the properties registered with this object).

void	SetColor (int index, vtkPiecewiseFunction *function)
	Set the color of a volume to a gray level transfer function for the component indicated by index.

void	SetColor (vtkPiecewiseFunction *function)

void	SetColor (int index, vtkColorTransferFunction *function)
	Set the color of a volume to an RGB transfer function for the component indicated by index.

void	SetColor (vtkColorTransferFunction *function)

int	GetColorChannels (int index)
	Get the number of color channels in the transfer function for the given component.

int	GetColorChannels ()

vtkPiecewiseFunction *	GetGrayTransferFunction (int index)
	Get the gray transfer function.

vtkPiecewiseFunction *	GetGrayTransferFunction ()

void	SetGrayTransferFunction (int index, vtkPiecewiseFunction *function)

int	GetNumberOfGrayTransferFunctions ()

vtkColorTransferFunction *	GetRGBTransferFunction (int index)
	Get the RGB transfer function for the given component.

vtkColorTransferFunction *	GetRGBTransferFunction ()

void	SetRGBTransferFunction (int index, vtkColorTransferFunction *function)

int	GetNumberOfRGBTransferFunctions ()

void	SetScalarOpacity (int index, vtkPiecewiseFunction *function)
	Set the opacity of a volume to an opacity transfer function based on scalar value for the component indicated by index.

void	SetScalarOpacity (vtkPiecewiseFunction *function)

vtkPiecewiseFunction *	GetScalarOpacity (int index)
	Get the scalar opacity transfer function for the given component.

vtkPiecewiseFunction *	GetScalarOpacity ()

void	SetGradientOpacity (int index, vtkPiecewiseFunction *function)
	Set the opacity of a volume to an opacity transfer function based on gradient magnitude for the given component.

void	SetGradientOpacity (vtkPiecewiseFunction *function)

vtkPiecewiseFunction *	GetGradientOpacity (int index)
	Get the gradient magnitude opacity transfer function for the given component.

vtkPiecewiseFunction *	GetGradientOpacity ()

bool	HasGradientOpacity (int index=0)
	Check whether or not we have the gradient opacity.

bool	HasLabelGradientOpacity ()

vtkContourValues *	GetIsoSurfaceValues ()
	Get contour values for isosurface blending mode.

void	UpdateMTimes ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE UpdateMTimes performs a Modified() on all TimeStamps.

vtkTimeStamp	GetGradientOpacityMTime (int index)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the gradient opacity transfer function was set.

vtkTimeStamp	GetGradientOpacityMTime ()

vtkTimeStamp	GetScalarOpacityMTime (int index)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the scalar opacity transfer function was set.

vtkTimeStamp	GetScalarOpacityMTime ()

vtkTimeStamp	GetRGBTransferFunctionMTime (int index)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the RGBTransferFunction was set.

vtkTimeStamp	GetRGBTransferFunctionMTime ()

vtkTimeStamp	GetGrayTransferFunctionMTime (int index)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the GrayTransferFunction was set.

vtkTimeStamp	GetGrayTransferFunctionMTime ()

virtual vtkTimeStamp	GetLabelColorMTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that label color transfer functions were set.

virtual vtkTimeStamp	GetLabelScalarOpacityMTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that label scalar opacity transfer functions were set.

virtual vtkTimeStamp	GetLabelGradientOpacityMTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that label gradient opacity transfer functions were set.

std::size_t	GetNumberOfLabels ()
	Get the number of labels that are provided with transfer functions using either SetLabelColor, SetLabelScalarOpacity or SetLabelGradientOpacity.

std::set< int >	GetLabelMapLabels ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get access to the internal set that keeps track of labels.


virtual void	SetIndependentComponents (vtkTypeBool)
	Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

virtual vtkTypeBool	GetIndependentComponents ()
	Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

virtual void	IndependentComponentsOn ()
	Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

virtual void	IndependentComponentsOff ()
	Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.


virtual void	SetInterpolationType (int)
	Set the interpolation type for sampling a volume.

virtual int	GetInterpolationType ()
	Set the interpolation type for sampling a volume.

void	SetInterpolationTypeToNearest ()
	Set the interpolation type for sampling a volume.

void	SetInterpolationTypeToLinear ()
	Set the interpolation type for sampling a volume.

const char *	GetInterpolationTypeAsString ()
	Return the interpolation type as a descriptive character string.


virtual void	SetComponentWeight (int index, double value)
	Set/Get the scalar component weights.

virtual double	GetComponentWeight (int index)
	Set/Get the scalar component weights.


void	SetScalarOpacityFunction (int index, vtkPiecewiseFunction *function)
	Get/Set the scalar opacity transfer function for the given component.

vtkPiecewiseFunction *	GetScalarOpacityFunction (int index)
	Get/Set the scalar opacity transfer function for the given component.

int	GetNumberOfScalarOpacityFunctions ()
	Get/Set the scalar opacity transfer function for the given component.


void	SetScalarOpacityUnitDistance (int index, double distance)
	Set/Get the unit distance on which the scalar opacity transfer function is defined.

void	SetScalarOpacityUnitDistance (double distance)
	Set/Get the unit distance on which the scalar opacity transfer function is defined.

double	GetScalarOpacityUnitDistance (int index)
	Set/Get the unit distance on which the scalar opacity transfer function is defined.

double	GetScalarOpacityUnitDistance ()
	Set/Get the unit distance on which the scalar opacity transfer function is defined.


void	SetGradientOpacityFunction (int index, vtkPiecewiseFunction *function)
	Set/Get the gradient magnitude opacity transfer function for the given component.

vtkPiecewiseFunction *	GetGradientOpacityFunction (int index)
	Set/Get the gradient magnitude opacity transfer function for the given component.

int	GetNumberOfGradientOpacityFunctions ()
	Set/Get the gradient magnitude opacity transfer function for the given component.


virtual void	SetDisableGradientOpacity (int index, int value)
	Enable/Disable the gradient opacity function for the given component.

virtual void	SetDisableGradientOpacity (int value)
	Enable/Disable the gradient opacity function for the given component.

virtual void	DisableGradientOpacityOn (int index)
	Enable/Disable the gradient opacity function for the given component.

virtual void	DisableGradientOpacityOn ()
	Enable/Disable the gradient opacity function for the given component.

virtual void	DisableGradientOpacityOff (int index)
	Enable/Disable the gradient opacity function for the given component.

virtual void	DisableGradientOpacityOff ()
	Enable/Disable the gradient opacity function for the given component.

virtual int	GetDisableGradientOpacity (int index)
	Enable/Disable the gradient opacity function for the given component.

virtual int	GetDisableGradientOpacity ()
	Enable/Disable the gradient opacity function for the given component.

vtkPiecewiseFunction *	GetStoredGradientOpacity (int index)
	Enable/Disable the gradient opacity function for the given component.

vtkPiecewiseFunction *	GetStoredGradientOpacity ()
	Enable/Disable the gradient opacity function for the given component.


void	SetShade (int index, int value)
	Set/Get the shading of a volume.

void	SetShade (int value)
	Set/Get the shading of a volume.

int	GetShade (int index)
	Set/Get the shading of a volume.

int	GetShade ()
	Set/Get the shading of a volume.

void	ShadeOn (int index)
	Set/Get the shading of a volume.

void	ShadeOn ()
	Set/Get the shading of a volume.

void	ShadeOff (int index)
	Set/Get the shading of a volume.

void	ShadeOff ()
	Set/Get the shading of a volume.


void	SetAmbient (int index, double value)
	Set/Get the ambient lighting coefficient.

void	SetAmbient (double value)
	Set/Get the ambient lighting coefficient.

double	GetAmbient (int index)
	Set/Get the ambient lighting coefficient.

double	GetAmbient ()
	Set/Get the ambient lighting coefficient.


void	SetDiffuse (int index, double value)
	Set/Get the diffuse lighting coefficient.

void	SetDiffuse (double value)
	Set/Get the diffuse lighting coefficient.

double	GetDiffuse (int index)
	Set/Get the diffuse lighting coefficient.

double	GetDiffuse ()
	Set/Get the diffuse lighting coefficient.


void	SetSpecular (int index, double value)
	Set/Get the specular lighting coefficient.

void	SetSpecular (double value)
	Set/Get the specular lighting coefficient.

double	GetSpecular (int index)
	Set/Get the specular lighting coefficient.

double	GetSpecular ()
	Set/Get the specular lighting coefficient.


void	SetSpecularPower (int index, double value)
	Set/Get the specular power.

void	SetSpecularPower (double value)
	Set/Get the specular power.

double	GetSpecularPower (int index)
	Set/Get the specular power.

double	GetSpecularPower ()
	Set/Get the specular power.


virtual void	SetSliceFunction (vtkImplicitFunction *)
	Get/Set the function used for slicing.

virtual vtkImplicitFunction *	GetSliceFunction ()
	Get/Set the function used for slicing.


virtual void	SetScatteringAnisotropy (float)
	Get/Set the volume's scattering anisotropy.

virtual float	GetScatteringAnisotropy ()
	Get/Set the volume's scattering anisotropy.


virtual void	SetUseClippedVoxelIntensity (int)
	Set/Get whether to use a fixed intensity value for voxels in the clipped space for gradient calculations.

virtual int	GetUseClippedVoxelIntensity ()
	Set/Get whether to use a fixed intensity value for voxels in the clipped space for gradient calculations.

virtual void	UseClippedVoxelIntensityOn ()
	Set/Get whether to use a fixed intensity value for voxels in the clipped space for gradient calculations.

virtual void	UseClippedVoxelIntensityOff ()
	Set/Get whether to use a fixed intensity value for voxels in the clipped space for gradient calculations.


virtual void	SetClippedVoxelIntensity (double)
	Set/Get the intensity value for voxels in the clipped space for gradient computations (for shading and gradient based opacity modulation).

virtual double	GetClippedVoxelIntensity ()
	Set/Get the intensity value for voxels in the clipped space for gradient computations (for shading and gradient based opacity modulation).


void	SetLabelColor (int label, vtkColorTransferFunction *function)
	Set/Get the color transfer function for a label in the label map.

vtkColorTransferFunction *	GetLabelColor (int label)
	Set/Get the color transfer function for a label in the label map.


void	SetLabelScalarOpacity (int label, vtkPiecewiseFunction *function)
	Set/Get the opacity transfer function for a label in the label map.

vtkPiecewiseFunction *	GetLabelScalarOpacity (int label)
	Set/Get the opacity transfer function for a label in the label map.


void	SetLabelGradientOpacity (int label, vtkPiecewiseFunction *function)
	Set/Get the gradient opacity function for a label in the label map.

vtkPiecewiseFunction *	GetLabelGradientOpacity (int label)
	Set/Get the gradient opacity function for a label in the label map.

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 vtkVolumeProperty *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkVolumeProperty *	SafeDownCast (vtkObjectBase *o)

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

	vtkVolumeProperty ()

	~vtkVolumeProperty () override

vtkTimeStamp	GetTransferFunction2DMTime (int index)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time when the TransferFunction2D was set.

vtkTimeStamp	GetTransferFunction2DMTime ()

virtual void	CreateDefaultGradientOpacity (int index)

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
vtkTypeBool	IndependentComponents

double	ComponentWeight [VTK_MAX_VRCOMP]

int	InterpolationType

float	ScatteringAnisotropy = 0.0

int	ColorChannels [VTK_MAX_VRCOMP]

vtkPiecewiseFunction *	GrayTransferFunction [VTK_MAX_VRCOMP]

vtkTimeStamp	GrayTransferFunctionMTime [VTK_MAX_VRCOMP]

vtkColorTransferFunction *	RGBTransferFunction [VTK_MAX_VRCOMP]

vtkTimeStamp	RGBTransferFunctionMTime [VTK_MAX_VRCOMP]

vtkPiecewiseFunction *	ScalarOpacity [VTK_MAX_VRCOMP]

vtkTimeStamp	ScalarOpacityMTime [VTK_MAX_VRCOMP]

double	ScalarOpacityUnitDistance [VTK_MAX_VRCOMP]

vtkPiecewiseFunction *	GradientOpacity [VTK_MAX_VRCOMP]

vtkTimeStamp	GradientOpacityMTime [VTK_MAX_VRCOMP]

vtkPiecewiseFunction *	DefaultGradientOpacity [VTK_MAX_VRCOMP]

int	DisableGradientOpacity [VTK_MAX_VRCOMP]

int	TransferFunctionMode

vtkImageData *	TransferFunction2D [VTK_MAX_VRCOMP]

vtkTimeStamp	TransferFunction2DMTime [VTK_MAX_VRCOMP]

vtkTimeStamp	LabelColorMTime

vtkTimeStamp	LabelScalarOpacityMTime

vtkTimeStamp	LabelGradientOpacityMTime

int	Shade [VTK_MAX_VRCOMP]

double	Ambient [VTK_MAX_VRCOMP]

double	Diffuse [VTK_MAX_VRCOMP]

double	Specular [VTK_MAX_VRCOMP]

double	SpecularPower [VTK_MAX_VRCOMP]

double	ClippedVoxelIntensity

int	UseClippedVoxelIntensity

vtkNew< vtkContourValues >	IsoSurfaceValues
	Contour values for isosurface blend mode.

vtkSmartPointer< vtkImplicitFunction >	SliceFunction
	Function used for slice.

std::unordered_map< int, vtkColorTransferFunction * >	LabelColor
	Label map transfer functions.

std::unordered_map< int, vtkPiecewiseFunction * >	LabelScalarOpacity

std::unordered_map< int, vtkPiecewiseFunction * >	LabelGradientOpacity

std::set< int >	LabelMapLabels

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

enum	TransferMode { TF_1D = 0 , TF_2D }
	Color-opacity transfer function mode. More...

void	SetTransferFunction2D (int index, vtkImageData *function)
	Set/Get a 2D transfer function.

void	SetTransferFunction2D (vtkImageData *function)
	Color-opacity transfer function mode.

vtkImageData *	GetTransferFunction2D (int index)
	Color-opacity transfer function mode.

vtkImageData *	GetTransferFunction2D ()
	Color-opacity transfer function mode.

int	GetNumberOfTransferFunction2Ds ()
	Color-opacity transfer function mode.

virtual void	SetTransferFunctionMode (int)
	Color-opacity transfer function mode.

virtual int	GetTransferFunctionMode ()
	Color-opacity transfer function mode.

void	SetTransferFunctionModeTo1D ()
	Color-opacity transfer function mode.

void	SetTransferFunctionModeTo2D ()
	Color-opacity transfer function mode.

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 the common properties for rendering a volume.

vtkVolumeProperty is used to represent common properties associated with volume rendering. This includes properties for determining the type of interpolation to use when sampling a volume, the color of a volume, the scalar opacity of a volume, the gradient opacity of a volume, and the shading parameters of a volume.

Color, scalar opacity and gradient magnitude opacity transfer functions can be set as either 3 separate 1D functions or as a single 2D transfer function.

1D Transfer functions (vtkVolumeProperty::TF_1D) Color, scalar opacity and gradient magnitude opacity are defined by 1 vtkColorTransferFunction and 2 vtkPiecewiseFunctions respectively. When the scalar opacity or the gradient opacity of a volume is not set, then the function is defined to be a constant value of 1.0. When a scalar and gradient opacity are both set simultaneously, then the opacity is defined to be the product of the scalar opacity and gradient opacity transfer functions. 1D transfer functions is the legacy and default behavior.
2D Transfer functions (vtkVolumeProperty::TF_2D) Color and scalar/gradient magnitude opacity are defined by a 4-component vtkImageData instance mapping scalar value vs. gradient magnitude on its x and y axis respectively. This mode is only available if a 2D TF has been explicitly set (see SetTransferFunction2D).

Most properties can be set per "component" for volume mappers that support multiple independent components. If you are using 2 component data as LV or 4 component data as RGBV (as specified in the mapper) only the first scalar opacity and gradient opacity transfer functions will be used (and all color functions will be ignored). Omitting the index parameter on the Set/Get methods will access index = 0.

See also: vtkPiecewiseFunction vtkColorTransferFunction

Examples:: vtkVolumeProperty (Examples)

Online Examples:

MedicalDemo4

FixedPointVolumeRayCastMapperCT

IntermixedUnstructuredGrid

MinIntensityRendering

MultiBlockVolumeMapper

OpenVRVolume

RayCastIsosurface

SimpleRayCast

Tests:: vtkVolumeProperty (Tests)

Definition at line 159 of file vtkVolumeProperty.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkVolumeProperty::Superclass

Definition at line 163 of file vtkVolumeProperty.h.

Member Enumeration Documentation

◆ TransferMode

enum vtkVolumeProperty::TransferMode

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

Enumerator
TF_1D
TF_2D

Definition at line 369 of file vtkVolumeProperty.h.

Constructor & Destructor Documentation

◆ vtkVolumeProperty()

vtkVolumeProperty::vtkVolumeProperty ( )

protected

◆ ~vtkVolumeProperty()

vtkVolumeProperty::~vtkVolumeProperty ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkVolumeProperty * vtkVolumeProperty::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkVolumeProperty::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 vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVolumeProperty::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkVolumeProperty * vtkVolumeProperty::NewInstance ( ) const

◆ PrintSelf()

void vtkVolumeProperty::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 vtkObject.

◆ DeepCopy()

void vtkVolumeProperty::DeepCopy ( vtkVolumeProperty * p )

◆ GetMTime()

vtkMTimeType vtkVolumeProperty::GetMTime ( )

overridevirtual

Get the modified time for this object (or the properties registered with this object).

Reimplemented from vtkObject.

◆ SetIndependentComponents()

virtual void vtkVolumeProperty::SetIndependentComponents ( vtkTypeBool )

virtual

Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

Some volume Mappers can handle 1 to 4 component unsigned char or unsigned short data (see each mapper header file to determine functionality). If IndependentComponents is Off, then you must have either 2 or 4 component data. For 2 component data, the first is passed through the first color transfer function and the second component is passed through the first scalar opacity (and gradient opacity) transfer function. Normals will be generated off of the second component. When using gradient based opacity modulation, the gradients are computed off of the second component. For 4 component data, the first three will directly represent RGB (no lookup table). The fourth component will be passed through the first scalar opacity transfer function for opacity and first gradient opacity transfer function for gradient based opacity modulation. Normals will be generated from the fourth component. When using gradient based opacity modulation, the gradients are computed off of the fourth component.

◆ GetIndependentComponents()

virtual vtkTypeBool vtkVolumeProperty::GetIndependentComponents ( )

virtual

Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

Some volume Mappers can handle 1 to 4 component unsigned char or unsigned short data (see each mapper header file to determine functionality). If IndependentComponents is Off, then you must have either 2 or 4 component data. For 2 component data, the first is passed through the first color transfer function and the second component is passed through the first scalar opacity (and gradient opacity) transfer function. Normals will be generated off of the second component. When using gradient based opacity modulation, the gradients are computed off of the second component. For 4 component data, the first three will directly represent RGB (no lookup table). The fourth component will be passed through the first scalar opacity transfer function for opacity and first gradient opacity transfer function for gradient based opacity modulation. Normals will be generated from the fourth component. When using gradient based opacity modulation, the gradients are computed off of the fourth component.

◆ IndependentComponentsOn()

virtual void vtkVolumeProperty::IndependentComponentsOn ( )

virtual

Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

Some volume Mappers can handle 1 to 4 component unsigned char or unsigned short data (see each mapper header file to determine functionality). If IndependentComponents is Off, then you must have either 2 or 4 component data. For 2 component data, the first is passed through the first color transfer function and the second component is passed through the first scalar opacity (and gradient opacity) transfer function. Normals will be generated off of the second component. When using gradient based opacity modulation, the gradients are computed off of the second component. For 4 component data, the first three will directly represent RGB (no lookup table). The fourth component will be passed through the first scalar opacity transfer function for opacity and first gradient opacity transfer function for gradient based opacity modulation. Normals will be generated from the fourth component. When using gradient based opacity modulation, the gradients are computed off of the fourth component.

◆ IndependentComponentsOff()

virtual void vtkVolumeProperty::IndependentComponentsOff ( )

virtual

Does the data have independent components, or do some define color only? If IndependentComponents is On (the default) then each component will be independently passed through a lookup table to determine RGBA, shaded.

Some volume Mappers can handle 1 to 4 component unsigned char or unsigned short data (see each mapper header file to determine functionality). If IndependentComponents is Off, then you must have either 2 or 4 component data. For 2 component data, the first is passed through the first color transfer function and the second component is passed through the first scalar opacity (and gradient opacity) transfer function. Normals will be generated off of the second component. When using gradient based opacity modulation, the gradients are computed off of the second component. For 4 component data, the first three will directly represent RGB (no lookup table). The fourth component will be passed through the first scalar opacity transfer function for opacity and first gradient opacity transfer function for gradient based opacity modulation. Normals will be generated from the fourth component. When using gradient based opacity modulation, the gradients are computed off of the fourth component.

◆ SetInterpolationType()

virtual void vtkVolumeProperty::SetInterpolationType ( int )

virtual

Set the interpolation type for sampling a volume.

Initial value is VTK_NEAREST_INTERPOLATION.

◆ GetInterpolationType()

virtual int vtkVolumeProperty::GetInterpolationType ( )

virtual

Set the interpolation type for sampling a volume.

Initial value is VTK_NEAREST_INTERPOLATION.

◆ SetInterpolationTypeToNearest()

void vtkVolumeProperty::SetInterpolationTypeToNearest ( )

inline

Set the interpolation type for sampling a volume.

Initial value is VTK_NEAREST_INTERPOLATION.

Definition at line 207 of file vtkVolumeProperty.h.

◆ SetInterpolationTypeToLinear()

void vtkVolumeProperty::SetInterpolationTypeToLinear ( )

inline

Set the interpolation type for sampling a volume.

Initial value is VTK_NEAREST_INTERPOLATION.

Definition at line 208 of file vtkVolumeProperty.h.

◆ GetInterpolationTypeAsString()

const char * vtkVolumeProperty::GetInterpolationTypeAsString ( )

inline

Return the interpolation type as a descriptive character string.

Definition at line 738 of file vtkVolumeProperty.h.

◆ SetComponentWeight()

virtual void vtkVolumeProperty::SetComponentWeight	(	int	index,
		double	value
	)

virtual

Set/Get the scalar component weights.

Clamped between the range of (0.0, 1.0)

◆ GetComponentWeight()

virtual double vtkVolumeProperty::GetComponentWeight ( int index )

virtual

Set/Get the scalar component weights.

Clamped between the range of (0.0, 1.0)

◆ SetColor() [1/4]

void vtkVolumeProperty::SetColor	(	int	index,
		vtkPiecewiseFunction *	function
	)

Set the color of a volume to a gray level transfer function for the component indicated by index.

This will set the color channels for this component to 1.

◆ SetColor() [2/4]

void vtkVolumeProperty::SetColor ( vtkPiecewiseFunction * function )

inline

Definition at line 227 of file vtkVolumeProperty.h.

◆ SetColor() [3/4]

void vtkVolumeProperty::SetColor	(	int	index,
		vtkColorTransferFunction *	function
	)

Set the color of a volume to an RGB transfer function for the component indicated by index.

This will set the color channels for this component to 3. This will also recompute the color channels

◆ SetColor() [4/4]

void vtkVolumeProperty::SetColor ( vtkColorTransferFunction * function )

inline

Definition at line 236 of file vtkVolumeProperty.h.

◆ GetColorChannels() [1/2]

int vtkVolumeProperty::GetColorChannels ( int index )

Get the number of color channels in the transfer function for the given component.

◆ GetColorChannels() [2/2]

int vtkVolumeProperty::GetColorChannels ( )

inline

Definition at line 243 of file vtkVolumeProperty.h.

◆ GetGrayTransferFunction() [1/2]

vtkPiecewiseFunction * vtkVolumeProperty::GetGrayTransferFunction ( int index )

Get the gray transfer function.

If no transfer function has been set for this component, a default one is created and returned.

◆ GetGrayTransferFunction() [2/2]

vtkPiecewiseFunction * vtkVolumeProperty::GetGrayTransferFunction ( )

inline

Definition at line 252 of file vtkVolumeProperty.h.

◆ SetGrayTransferFunction()

void vtkVolumeProperty::SetGrayTransferFunction	(	int	index,
		vtkPiecewiseFunction *	function
	)

inline

Definition at line 253 of file vtkVolumeProperty.h.

◆ GetNumberOfGrayTransferFunctions()

int vtkVolumeProperty::GetNumberOfGrayTransferFunctions ( )

inline

Definition at line 257 of file vtkVolumeProperty.h.

◆ GetRGBTransferFunction() [1/2]

vtkColorTransferFunction * vtkVolumeProperty::GetRGBTransferFunction ( int index )

Get the RGB transfer function for the given component.

If no transfer function has been set for this component, a default one is created and returned.

◆ GetRGBTransferFunction() [2/2]

vtkColorTransferFunction * vtkVolumeProperty::GetRGBTransferFunction ( )

inline

Definition at line 266 of file vtkVolumeProperty.h.

◆ SetRGBTransferFunction()

void vtkVolumeProperty::SetRGBTransferFunction	(	int	index,
		vtkColorTransferFunction *	function
	)

inline

Definition at line 267 of file vtkVolumeProperty.h.

◆ GetNumberOfRGBTransferFunctions()

int vtkVolumeProperty::GetNumberOfRGBTransferFunctions ( )

inline

Definition at line 271 of file vtkVolumeProperty.h.

◆ SetScalarOpacity() [1/2]

void vtkVolumeProperty::SetScalarOpacity	(	int	index,
		vtkPiecewiseFunction *	function
	)

Set the opacity of a volume to an opacity transfer function based on scalar value for the component indicated by index.

◆ SetScalarOpacity() [2/2]

void vtkVolumeProperty::SetScalarOpacity ( vtkPiecewiseFunction * function )

inline

Definition at line 280 of file vtkVolumeProperty.h.

◆ GetScalarOpacity() [1/2]

vtkPiecewiseFunction * vtkVolumeProperty::GetScalarOpacity ( int index )

Get the scalar opacity transfer function for the given component.

If no transfer function has been set for this component, a default one is created and returned.

◆ GetScalarOpacity() [2/2]

vtkPiecewiseFunction * vtkVolumeProperty::GetScalarOpacity ( )

inline

Definition at line 290 of file vtkVolumeProperty.h.

◆ SetScalarOpacityFunction()

void vtkVolumeProperty::SetScalarOpacityFunction	(	int	index,
		vtkPiecewiseFunction *	function
	)

inline

Get/Set the scalar opacity transfer function for the given component.

If no transfer function has been set for this component, returns nullptr.

Definition at line 297 of file vtkVolumeProperty.h.

◆ GetScalarOpacityFunction()

vtkPiecewiseFunction * vtkVolumeProperty::GetScalarOpacityFunction ( int index )

inline

Get/Set the scalar opacity transfer function for the given component.

If no transfer function has been set for this component, returns nullptr.

Definition at line 301 of file vtkVolumeProperty.h.

◆ GetNumberOfScalarOpacityFunctions()

int vtkVolumeProperty::GetNumberOfScalarOpacityFunctions ( )

inline

Get/Set the scalar opacity transfer function for the given component.

If no transfer function has been set for this component, returns nullptr.

Definition at line 302 of file vtkVolumeProperty.h.

◆ SetScalarOpacityUnitDistance() [1/2]

void vtkVolumeProperty::SetScalarOpacityUnitDistance	(	int	index,
		double	distance
	)

Set/Get the unit distance on which the scalar opacity transfer function is defined.

By default this is 1.0, meaning that over a distance of 1.0 units, a given opacity (from the transfer function) is accumulated. This is adjusted for the actual sampling distance during rendering.

◆ SetScalarOpacityUnitDistance() [2/2]

void vtkVolumeProperty::SetScalarOpacityUnitDistance ( double distance )

inline

Set/Get the unit distance on which the scalar opacity transfer function is defined.

By default this is 1.0, meaning that over a distance of 1.0 units, a given opacity (from the transfer function) is accumulated. This is adjusted for the actual sampling distance during rendering.

Definition at line 314 of file vtkVolumeProperty.h.

◆ GetScalarOpacityUnitDistance() [1/2]

double vtkVolumeProperty::GetScalarOpacityUnitDistance ( int index )

Set/Get the unit distance on which the scalar opacity transfer function is defined.

By default this is 1.0, meaning that over a distance of 1.0 units, a given opacity (from the transfer function) is accumulated. This is adjusted for the actual sampling distance during rendering.

◆ GetScalarOpacityUnitDistance() [2/2]

double vtkVolumeProperty::GetScalarOpacityUnitDistance ( )

inline

Set/Get the unit distance on which the scalar opacity transfer function is defined.

By default this is 1.0, meaning that over a distance of 1.0 units, a given opacity (from the transfer function) is accumulated. This is adjusted for the actual sampling distance during rendering.

Definition at line 320 of file vtkVolumeProperty.h.

◆ SetGradientOpacity() [1/2]

void vtkVolumeProperty::SetGradientOpacity	(	int	index,
		vtkPiecewiseFunction *	function
	)

Set the opacity of a volume to an opacity transfer function based on gradient magnitude for the given component.

◆ SetGradientOpacity() [2/2]

void vtkVolumeProperty::SetGradientOpacity ( vtkPiecewiseFunction * function )

inline

Definition at line 330 of file vtkVolumeProperty.h.

◆ SetGradientOpacityFunction()

void vtkVolumeProperty::SetGradientOpacityFunction	(	int	index,
		vtkPiecewiseFunction *	function
	)

inline

Set/Get the gradient magnitude opacity transfer function for the given component.

If no transfer function has been set for this component, returns nullptr.

Definition at line 338 of file vtkVolumeProperty.h.

◆ GetGradientOpacityFunction()

vtkPiecewiseFunction * vtkVolumeProperty::GetGradientOpacityFunction ( int index )

inline

Set/Get the gradient magnitude opacity transfer function for the given component.

If no transfer function has been set for this component, returns nullptr.

Definition at line 342 of file vtkVolumeProperty.h.

◆ GetNumberOfGradientOpacityFunctions()

int vtkVolumeProperty::GetNumberOfGradientOpacityFunctions ( )

inline

Set/Get the gradient magnitude opacity transfer function for the given component.

If no transfer function has been set for this component, returns nullptr.

Definition at line 343 of file vtkVolumeProperty.h.

◆ SetTransferFunction2D() [1/2]

void vtkVolumeProperty::SetTransferFunction2D	(	int	index,
		vtkImageData *	function
	)

Set/Get a 2D transfer function.

Volume mappers interpret the x-axis of of this transfer function as scalar value and the y-axis as gradient magnitude. The value at (X, Y) corresponds to the color and opacity for a salar value of X and a gradient magnitude of Y.

◆ SetTransferFunction2D() [2/2]

void vtkVolumeProperty::SetTransferFunction2D ( vtkImageData * function )

inline

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

Definition at line 355 of file vtkVolumeProperty.h.

◆ GetTransferFunction2D() [1/2]

vtkImageData * vtkVolumeProperty::GetTransferFunction2D ( int index )

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

◆ GetTransferFunction2D() [2/2]

vtkImageData * vtkVolumeProperty::GetTransferFunction2D ( )

inline

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

Definition at line 359 of file vtkVolumeProperty.h.

◆ GetNumberOfTransferFunction2Ds()

int vtkVolumeProperty::GetNumberOfTransferFunction2Ds ( )

inline

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

Definition at line 360 of file vtkVolumeProperty.h.

◆ SetTransferFunctionMode()

virtual void vtkVolumeProperty::SetTransferFunctionMode ( int )

virtual

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

◆ GetTransferFunctionMode()

virtual int vtkVolumeProperty::GetTransferFunctionMode ( )

virtual

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

◆ SetTransferFunctionModeTo1D()

void vtkVolumeProperty::SetTransferFunctionModeTo1D ( )

inline

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

Definition at line 377 of file vtkVolumeProperty.h.

◆ SetTransferFunctionModeTo2D()

void vtkVolumeProperty::SetTransferFunctionModeTo2D ( )

inline

Color-opacity transfer function mode.

TF_1D is its default value.

TF_1D Mappers will use 3 separate 1D functions for color, scalar opacity and gradient mag. opacity.
TF_2D Mappers will use a single 2D function for color and scalar/gradient mag. opacity.

Definition at line 378 of file vtkVolumeProperty.h.

◆ GetGradientOpacity() [1/2]

vtkPiecewiseFunction * vtkVolumeProperty::GetGradientOpacity ( int index )

Get the gradient magnitude opacity transfer function for the given component.

If no transfer function has been set for this component, a default one is created and returned. This default function is always returned if DisableGradientOpacity is On for that component.

◆ GetGradientOpacity() [2/2]

vtkPiecewiseFunction * vtkVolumeProperty::GetGradientOpacity ( )

inline

Definition at line 392 of file vtkVolumeProperty.h.