VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkVolumeProperty Class Reference

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

#include <vtkVolumeProperty.h>

Inheritance diagram for vtkVolumeProperty:
[legend]
Collaboration diagram for vtkVolumeProperty:
[legend]

Public Types

enum  TransferMode { TF_1D = 0, TF_2D }
 Color-opacity transfer function mode. More...
 
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. More...
 
vtkVolumePropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void DeepCopy (vtkVolumeProperty *p)
 
vtkMTimeType GetMTime () override
 Get the modified time for this object (or the properties registered with this object). More...
 
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. More...
 
virtual vtkTypeBool GetIndependentComponents ()
 
virtual void IndependentComponentsOn ()
 
virtual void IndependentComponentsOff ()
 
virtual void SetInterpolationType (int)
 Set the interpolation type for sampling a volume. More...
 
virtual int GetInterpolationType ()
 
void SetInterpolationTypeToNearest ()
 
void SetInterpolationTypeToLinear ()
 
const char * GetInterpolationTypeAsString (void)
 Return the interpolation type as a descriptive character string. More...
 
virtual void SetComponentWeight (int index, double value)
 Set/Get the scalar component weights. More...
 
virtual double GetComponentWeight (int index)
 
void SetColor (int index, vtkPiecewiseFunction *function)
 Set the color of a volume to a gray level transfer function for the component indicated by index. More...
 
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. More...
 
void SetColor (vtkColorTransferFunction *function)
 
int GetColorChannels (int index)
 Get the number of color channels in the transfer function for the given component. More...
 
int GetColorChannels ()
 
vtkPiecewiseFunctionGetGrayTransferFunction (int index)
 Get the gray transfer function. More...
 
vtkPiecewiseFunctionGetGrayTransferFunction ()
 
vtkColorTransferFunctionGetRGBTransferFunction (int index)
 Get the RGB transfer function for the given component. More...
 
vtkColorTransferFunctionGetRGBTransferFunction ()
 
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. More...
 
void SetScalarOpacity (vtkPiecewiseFunction *function)
 
vtkPiecewiseFunctionGetScalarOpacity (int index)
 Get the scalar opacity transfer function for the given component. More...
 
vtkPiecewiseFunctionGetScalarOpacity ()
 
void SetScalarOpacityUnitDistance (int index, double distance)
 Set/Get the unit distance on which the scalar opacity transfer function is defined. More...
 
void SetScalarOpacityUnitDistance (double distance)
 
double GetScalarOpacityUnitDistance (int index)
 
double GetScalarOpacityUnitDistance ()
 
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. More...
 
void SetGradientOpacity (vtkPiecewiseFunction *function)
 
void SetTransferFunction2D (int index, vtkImageData *function)
 Set/Get a 2D transfer function. More...
 
void SetTransferFunction2D (vtkImageData *function)
 
vtkImageDataGetTransferFunction2D (int index)
 
vtkImageDataGetTransferFunction2D ()
 
virtual void SetTransferFunctionMode (int)
 
virtual int GetTransferFunctionMode ()
 
vtkPiecewiseFunctionGetGradientOpacity (int index)
 Get the gradient magnitude opacity transfer function for the given component. More...
 
vtkPiecewiseFunctionGetGradientOpacity ()
 
virtual void SetDisableGradientOpacity (int index, int value)
 Enable/Disable the gradient opacity function for the given component. More...
 
virtual void SetDisableGradientOpacity (int value)
 
virtual void DisableGradientOpacityOn (int index)
 
virtual void DisableGradientOpacityOn ()
 
virtual void DisableGradientOpacityOff (int index)
 
virtual void DisableGradientOpacityOff ()
 
virtual int GetDisableGradientOpacity (int index)
 
virtual int GetDisableGradientOpacity ()
 
vtkPiecewiseFunctionGetStoredGradientOpacity (int index)
 
vtkPiecewiseFunctionGetStoredGradientOpacity ()
 
bool HasGradientOpacity (int index=0)
 Check whether or not we have the gradient opacity. More...
 
void SetShade (int index, int value)
 Set/Get the shading of a volume. More...
 
void SetShade (int value)
 
int GetShade (int index)
 
int GetShade ()
 
void ShadeOn (int index)
 
void ShadeOn ()
 
void ShadeOff (int index)
 
void ShadeOff ()
 
void SetAmbient (int index, double value)
 Set/Get the ambient lighting coefficient. More...
 
void SetAmbient (double value)
 
double GetAmbient (int index)
 
double GetAmbient ()
 
void SetDiffuse (int index, double value)
 Set/Get the diffuse lighting coefficient. More...
 
void SetDiffuse (double value)
 
double GetDiffuse (int index)
 
double GetDiffuse ()
 
void SetSpecular (int index, double value)
 Set/Get the specular lighting coefficient. More...
 
void SetSpecular (double value)
 
double GetSpecular (int index)
 
double GetSpecular ()
 
void SetSpecularPower (int index, double value)
 Set/Get the specular power. More...
 
void SetSpecularPower (double value)
 
double GetSpecularPower (int index)
 
double GetSpecularPower ()
 
vtkContourValuesGetIsoSurfaceValues ()
 Get contour values for isosurface blending mode. More...
 
void UpdateMTimes ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE UpdateMTimes performs a Modified() on all TimeStamps. More...
 
vtkTimeStamp GetGradientOpacityMTime (int index)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the gradient opacity transfer function was set. More...
 
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. More...
 
vtkTimeStamp GetScalarOpacityMTime ()
 
vtkTimeStamp GetRGBTransferFunctionMTime (int index)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the RGBTransferFunction was set. More...
 
vtkTimeStamp GetRGBTransferFunctionMTime ()
 
vtkTimeStamp GetGrayTransferFunctionMTime (int index)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the GrayTransferFunction was set. More...
 
vtkTimeStamp GetGrayTransferFunctionMTime ()
 
virtual void SetUseClippedVoxelIntensity (int)
 Set/Get whether to use a fixed intensity value for voxels in the clipped space for gradient calculations. More...
 
virtual int GetUseClippedVoxelIntensity ()
 
virtual void UseClippedVoxelIntensityOn ()
 
virtual void UseClippedVoxelIntensityOff ()
 
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). More...
 
virtual double GetClippedVoxelIntensity ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkVolumePropertyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumePropertySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVolumeProperty ()
 
 ~vtkVolumeProperty () override
 
vtkTimeStamp GetTransferFunction2DMTime (int index)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time when the TransferFunction2D was set. More...
 
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. More...
 
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

vtkTypeBool IndependentComponents
 
double ComponentWeight [VTK_MAX_VRCOMP]
 
int InterpolationType
 
int ColorChannels [VTK_MAX_VRCOMP]
 
vtkPiecewiseFunctionGrayTransferFunction [VTK_MAX_VRCOMP]
 
vtkTimeStamp GrayTransferFunctionMTime [VTK_MAX_VRCOMP]
 
vtkColorTransferFunctionRGBTransferFunction [VTK_MAX_VRCOMP]
 
vtkTimeStamp RGBTransferFunctionMTime [VTK_MAX_VRCOMP]
 
vtkPiecewiseFunctionScalarOpacity [VTK_MAX_VRCOMP]
 
vtkTimeStamp ScalarOpacityMTime [VTK_MAX_VRCOMP]
 
double ScalarOpacityUnitDistance [VTK_MAX_VRCOMP]
 
vtkPiecewiseFunctionGradientOpacity [VTK_MAX_VRCOMP]
 
vtkTimeStamp GradientOpacityMTime [VTK_MAX_VRCOMP]
 
vtkPiecewiseFunctionDefaultGradientOpacity [VTK_MAX_VRCOMP]
 
int DisableGradientOpacity [VTK_MAX_VRCOMP]
 
int TransferFunctionMode
 
vtkImageDataTransferFunction2D [VTK_MAX_VRCOMP]
 
vtkTimeStamp TransferFunction2DMTime [VTK_MAX_VRCOMP]
 
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< vtkContourValuesIsoSurfaceValues
 Contour values for isosurface blend mode. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.

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

Definition at line 68 of file vtkVolumeProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 72 of file vtkVolumeProperty.h.

Member Enumeration Documentation

◆ 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 245 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

◆ IndependentComponentsOn()

virtual void vtkVolumeProperty::IndependentComponentsOn ( )
virtual

◆ IndependentComponentsOff()

virtual void vtkVolumeProperty::IndependentComponentsOff ( )
virtual

◆ 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

◆ SetInterpolationTypeToNearest()

void vtkVolumeProperty::SetInterpolationTypeToNearest ( )
inline

Definition at line 117 of file vtkVolumeProperty.h.

◆ SetInterpolationTypeToLinear()

void vtkVolumeProperty::SetInterpolationTypeToLinear ( )
inline

Definition at line 119 of file vtkVolumeProperty.h.

◆ GetInterpolationTypeAsString()

const char * vtkVolumeProperty::GetInterpolationTypeAsString ( void  )
inline

Return the interpolation type as a descriptive character string.

Definition at line 534 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

◆ 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 139 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 149 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 157 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 166 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 175 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 183 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 192 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

Definition at line 203 of file vtkVolumeProperty.h.

◆ GetScalarOpacityUnitDistance() [1/2]

double vtkVolumeProperty::GetScalarOpacityUnitDistance ( int  index)

◆ GetScalarOpacityUnitDistance() [2/2]

double vtkVolumeProperty::GetScalarOpacityUnitDistance ( )
inline

Definition at line 206 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 216 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

Definition at line 227 of file vtkVolumeProperty.h.

◆ GetTransferFunction2D() [1/2]

vtkImageData* vtkVolumeProperty::GetTransferFunction2D ( int  index)

◆ GetTransferFunction2D() [2/2]

vtkImageData* vtkVolumeProperty::GetTransferFunction2D ( )
inline

Definition at line 233 of file vtkVolumeProperty.h.

◆ SetTransferFunctionMode()

virtual void vtkVolumeProperty::SetTransferFunctionMode ( int  )
virtual

◆ GetTransferFunctionMode()

virtual int vtkVolumeProperty::GetTransferFunctionMode ( )
virtual

◆ 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 264 of file vtkVolumeProperty.h.

◆ SetDisableGradientOpacity() [1/2]

virtual void vtkVolumeProperty::SetDisableGradientOpacity ( int  index,
int  value 
)
virtual

Enable/Disable the gradient opacity function for the given component.

If set to true, any call to GetGradientOpacity() will return a default function for this component. Note that the gradient opacity function is still stored, it is not set or reset and can be retrieved using GetStoredGradientOpacity().

◆ SetDisableGradientOpacity() [2/2]

virtual void vtkVolumeProperty::SetDisableGradientOpacity ( int  value)
inlinevirtual

Definition at line 276 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOn() [1/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOn ( int  index)
inlinevirtual

Definition at line 278 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOn() [2/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOn ( )
inlinevirtual

Definition at line 280 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOff() [1/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOff ( int  index)
inlinevirtual

Definition at line 282 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOff() [2/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOff ( )
inlinevirtual

Definition at line 284 of file vtkVolumeProperty.h.

◆ GetDisableGradientOpacity() [1/2]

virtual int vtkVolumeProperty::GetDisableGradientOpacity ( int  index)
virtual

◆ GetDisableGradientOpacity() [2/2]

virtual int vtkVolumeProperty::GetDisableGradientOpacity ( )
inlinevirtual

Definition at line 287 of file vtkVolumeProperty.h.

◆ GetStoredGradientOpacity() [1/2]

vtkPiecewiseFunction* vtkVolumeProperty::GetStoredGradientOpacity ( int  index)

◆ GetStoredGradientOpacity() [2/2]

vtkPiecewiseFunction* vtkVolumeProperty::GetStoredGradientOpacity ( )
inline

Definition at line 290 of file vtkVolumeProperty.h.

◆ HasGradientOpacity()

bool vtkVolumeProperty::HasGradientOpacity ( int  index = 0)
inline

Check whether or not we have the gradient opacity.

Checking gradient opacity via GetDisableGradientOpacity or GetGradientOpacity will not work as in the former case, GetDisableGradientOpacity returns false by default and in the later case, a default gradient opacity will be created.

Definition at line 300 of file vtkVolumeProperty.h.

◆ SetShade() [1/2]

void vtkVolumeProperty::SetShade ( int  index,
int  value 
)

Set/Get the shading of a volume.

If shading is turned off, then the mapper for the volume will not perform shading calculations. If shading is turned on, the mapper may perform shading calculations - in some cases shading does not apply (for example, in a maximum intensity projection) and therefore shading will not be performed even if this flag is on. For a compositing type of mapper, turning shading off is generally the same as setting ambient=1, diffuse=0, specular=0. Shading can be independently turned on/off per component.

Note
Shading is only supported for vtkVolumeMapper::COMPOSITE_BLEND. For minimum and maximum intensity blend modes, there is not necessarily one unique location along the ray through the volume where that minimum or maximum occurs. For average and additive blend modes, the value being visualized does not represent a location in the volume but rather a statistical measurement along the ray traversing through the volume, and hence shading is not applicable.
See also
vtkVolumeMapper::BlendModes

◆ SetShade() [2/2]

void vtkVolumeProperty::SetShade ( int  value)
inline

Definition at line 330 of file vtkVolumeProperty.h.

◆ GetShade() [1/2]

int vtkVolumeProperty::GetShade ( int  index)

◆ GetShade() [2/2]

int vtkVolumeProperty::GetShade ( )
inline

Definition at line 333 of file vtkVolumeProperty.h.

◆ ShadeOn() [1/2]

void vtkVolumeProperty::ShadeOn ( int  index)

◆ ShadeOn() [2/2]

void vtkVolumeProperty::ShadeOn ( )
inline

Definition at line 336 of file vtkVolumeProperty.h.

◆ ShadeOff() [1/2]

void vtkVolumeProperty::ShadeOff ( int  index)

◆ ShadeOff() [2/2]

void vtkVolumeProperty::ShadeOff ( )
inline

Definition at line 339 of file vtkVolumeProperty.h.

◆ SetAmbient() [1/2]

void vtkVolumeProperty::SetAmbient ( int  index,
double  value 
)

Set/Get the ambient lighting coefficient.

◆ SetAmbient() [2/2]

void vtkVolumeProperty::SetAmbient ( double  value)
inline

Definition at line 348 of file vtkVolumeProperty.h.

◆ GetAmbient() [1/2]

double vtkVolumeProperty::GetAmbient ( int  index)

◆ GetAmbient() [2/2]

double vtkVolumeProperty::GetAmbient ( )
inline

Definition at line 351 of file vtkVolumeProperty.h.

◆ SetDiffuse() [1/2]

void vtkVolumeProperty::SetDiffuse ( int  index,
double  value 
)

Set/Get the diffuse lighting coefficient.

◆ SetDiffuse() [2/2]

void vtkVolumeProperty::SetDiffuse ( double  value)
inline

Definition at line 360 of file vtkVolumeProperty.h.

◆ GetDiffuse() [1/2]

double vtkVolumeProperty::GetDiffuse ( int  index)

◆ GetDiffuse() [2/2]

double vtkVolumeProperty::GetDiffuse ( )
inline

Definition at line 363 of file vtkVolumeProperty.h.

◆ SetSpecular() [1/2]

void vtkVolumeProperty::SetSpecular ( int  index,
double  value 
)

Set/Get the specular lighting coefficient.

◆ SetSpecular() [2/2]

void vtkVolumeProperty::SetSpecular ( double  value)
inline

Definition at line 372 of file vtkVolumeProperty.h.

◆ GetSpecular() [1/2]

double vtkVolumeProperty::GetSpecular ( int  index)

◆ GetSpecular() [2/2]

double vtkVolumeProperty::GetSpecular ( )
inline

Definition at line 375 of file vtkVolumeProperty.h.

◆ SetSpecularPower() [1/2]

void vtkVolumeProperty::SetSpecularPower ( int  index,
double  value 
)

Set/Get the specular power.

◆ SetSpecularPower() [2/2]

void vtkVolumeProperty::SetSpecularPower ( double  value)
inline

Definition at line 384 of file vtkVolumeProperty.h.

◆ GetSpecularPower() [1/2]

double vtkVolumeProperty::GetSpecularPower ( int  index)

◆ GetSpecularPower() [2/2]

double vtkVolumeProperty::GetSpecularPower ( )
inline

Definition at line 387 of file vtkVolumeProperty.h.

◆ GetIsoSurfaceValues()

vtkContourValues* vtkVolumeProperty::GetIsoSurfaceValues ( )

Get contour values for isosurface blending mode.

Do not affect other blending modes.

◆ UpdateMTimes()

void vtkVolumeProperty::UpdateMTimes ( )

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

This is used by vtkVolume when the property is set, so that any other object that might have been caching information for the property will rebuild.

◆ GetGradientOpacityMTime() [1/2]

vtkTimeStamp vtkVolumeProperty::GetGradientOpacityMTime ( int  index)

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the gradient opacity transfer function was set.

◆ GetGradientOpacityMTime() [2/2]

vtkTimeStamp vtkVolumeProperty::GetGradientOpacityMTime ( )
inline

Definition at line 411 of file vtkVolumeProperty.h.

◆ GetScalarOpacityMTime() [1/2]

vtkTimeStamp vtkVolumeProperty::GetScalarOpacityMTime ( int  index)

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the scalar opacity transfer function was set.

◆ GetScalarOpacityMTime() [2/2]

vtkTimeStamp vtkVolumeProperty::GetScalarOpacityMTime ( )
inline

Definition at line 419 of file vtkVolumeProperty.h.

◆ GetRGBTransferFunctionMTime() [1/2]

vtkTimeStamp vtkVolumeProperty::GetRGBTransferFunctionMTime ( int  index)

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the RGBTransferFunction was set.

◆ GetRGBTransferFunctionMTime() [2/2]

vtkTimeStamp vtkVolumeProperty::GetRGBTransferFunctionMTime ( )
inline

Definition at line 427 of file vtkVolumeProperty.h.

◆ GetGrayTransferFunctionMTime() [1/2]

vtkTimeStamp vtkVolumeProperty::GetGrayTransferFunctionMTime ( int  index)

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time that the GrayTransferFunction was set.

◆ GetGrayTransferFunctionMTime() [2/2]

vtkTimeStamp vtkVolumeProperty::GetGrayTransferFunctionMTime ( )
inline

Definition at line 435 of file vtkVolumeProperty.h.

◆ SetUseClippedVoxelIntensity()

virtual void vtkVolumeProperty::SetUseClippedVoxelIntensity ( int  )
virtual

Set/Get whether to use a fixed intensity value for voxels in the clipped space for gradient calculations.

When UseClippedVoxelIntensity is enabled, the ClippedVoxelIntensity value will be used as intensity of clipped voxels. By default, this is false.

Note
This property is only used by the vtkGPUVolumeRayCastMapper for now.
See also
SetClippedVoxelIntensity

◆ GetUseClippedVoxelIntensity()

virtual int vtkVolumeProperty::GetUseClippedVoxelIntensity ( )
virtual

◆ UseClippedVoxelIntensityOn()

virtual void vtkVolumeProperty::UseClippedVoxelIntensityOn ( )
virtual

◆ UseClippedVoxelIntensityOff()

virtual void vtkVolumeProperty::UseClippedVoxelIntensityOff ( )
virtual

◆ SetClippedVoxelIntensity()

virtual void vtkVolumeProperty::SetClippedVoxelIntensity ( double  )
virtual

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

By default, this is set to VTK_DOUBLE_MIN.

Note
This value is only used when UseClippedVoxelIntensity is true.
This property is only used by the vtkGPUVolumeRayCastMapper for now.
See also
SetUseClippedVoxelIntensity

◆ GetClippedVoxelIntensity()

virtual double vtkVolumeProperty::GetClippedVoxelIntensity ( )
virtual

◆ GetTransferFunction2DMTime() [1/2]

vtkTimeStamp vtkVolumeProperty::GetTransferFunction2DMTime ( int  index)
protected

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Get the time when the TransferFunction2D was set.

◆ GetTransferFunction2DMTime() [2/2]

vtkTimeStamp vtkVolumeProperty::GetTransferFunction2DMTime ( )
inlineprotected

Definition at line 477 of file vtkVolumeProperty.h.

◆ CreateDefaultGradientOpacity()

virtual void vtkVolumeProperty::CreateDefaultGradientOpacity ( int  index)
protectedvirtual

Member Data Documentation

◆ IndependentComponents

vtkTypeBool vtkVolumeProperty::IndependentComponents
protected

Definition at line 484 of file vtkVolumeProperty.h.

◆ ComponentWeight

double vtkVolumeProperty::ComponentWeight[VTK_MAX_VRCOMP]
protected

Definition at line 485 of file vtkVolumeProperty.h.

◆ InterpolationType

int vtkVolumeProperty::InterpolationType
protected

Definition at line 487 of file vtkVolumeProperty.h.

◆ ColorChannels

int vtkVolumeProperty::ColorChannels[VTK_MAX_VRCOMP]
protected

Definition at line 489 of file vtkVolumeProperty.h.

◆ GrayTransferFunction

vtkPiecewiseFunction* vtkVolumeProperty::GrayTransferFunction[VTK_MAX_VRCOMP]
protected

Definition at line 491 of file vtkVolumeProperty.h.

◆ GrayTransferFunctionMTime

vtkTimeStamp vtkVolumeProperty::GrayTransferFunctionMTime[VTK_MAX_VRCOMP]
protected

Definition at line 492 of file vtkVolumeProperty.h.

◆ RGBTransferFunction

vtkColorTransferFunction* vtkVolumeProperty::RGBTransferFunction[VTK_MAX_VRCOMP]
protected

Definition at line 494 of file vtkVolumeProperty.h.

◆ RGBTransferFunctionMTime

vtkTimeStamp vtkVolumeProperty::RGBTransferFunctionMTime[VTK_MAX_VRCOMP]
protected

Definition at line 495 of file vtkVolumeProperty.h.

◆ ScalarOpacity

vtkPiecewiseFunction* vtkVolumeProperty::ScalarOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 497 of file vtkVolumeProperty.h.

◆ ScalarOpacityMTime

vtkTimeStamp vtkVolumeProperty::ScalarOpacityMTime[VTK_MAX_VRCOMP]
protected

Definition at line 498 of file vtkVolumeProperty.h.

◆ ScalarOpacityUnitDistance

double vtkVolumeProperty::ScalarOpacityUnitDistance[VTK_MAX_VRCOMP]
protected

Definition at line 499 of file vtkVolumeProperty.h.

◆ GradientOpacity

vtkPiecewiseFunction* vtkVolumeProperty::GradientOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 501 of file vtkVolumeProperty.h.

◆ GradientOpacityMTime

vtkTimeStamp vtkVolumeProperty::GradientOpacityMTime[VTK_MAX_VRCOMP]
protected

Definition at line 502 of file vtkVolumeProperty.h.

◆ DefaultGradientOpacity

vtkPiecewiseFunction* vtkVolumeProperty::DefaultGradientOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 504 of file vtkVolumeProperty.h.

◆ DisableGradientOpacity

int vtkVolumeProperty::DisableGradientOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 505 of file vtkVolumeProperty.h.

◆ TransferFunctionMode

int vtkVolumeProperty::TransferFunctionMode
protected

Definition at line 507 of file vtkVolumeProperty.h.

◆ TransferFunction2D

vtkImageData* vtkVolumeProperty::TransferFunction2D[VTK_MAX_VRCOMP]
protected

Definition at line 508 of file vtkVolumeProperty.h.

◆ TransferFunction2DMTime

vtkTimeStamp vtkVolumeProperty::TransferFunction2DMTime[VTK_MAX_VRCOMP]
protected

Definition at line 509 of file vtkVolumeProperty.h.

◆ Shade

int vtkVolumeProperty::Shade[VTK_MAX_VRCOMP]
protected

Definition at line 511 of file vtkVolumeProperty.h.

◆ Ambient

double vtkVolumeProperty::Ambient[VTK_MAX_VRCOMP]
protected

Definition at line 512 of file vtkVolumeProperty.h.

◆ Diffuse

double vtkVolumeProperty::Diffuse[VTK_MAX_VRCOMP]
protected

Definition at line 513 of file vtkVolumeProperty.h.

◆ Specular

double vtkVolumeProperty::Specular[VTK_MAX_VRCOMP]
protected

Definition at line 514 of file vtkVolumeProperty.h.

◆ SpecularPower

double vtkVolumeProperty::SpecularPower[VTK_MAX_VRCOMP]
protected

Definition at line 515 of file vtkVolumeProperty.h.

◆ ClippedVoxelIntensity

double vtkVolumeProperty::ClippedVoxelIntensity
protected

Definition at line 517 of file vtkVolumeProperty.h.

◆ UseClippedVoxelIntensity

int vtkVolumeProperty::UseClippedVoxelIntensity
protected

Definition at line 518 of file vtkVolumeProperty.h.

◆ IsoSurfaceValues

vtkNew<vtkContourValues> vtkVolumeProperty::IsoSurfaceValues
protected

Contour values for isosurface blend mode.

Definition at line 523 of file vtkVolumeProperty.h.


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