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

typedef vtkObject Superclass
 

Public Member Functions

virtual int 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)
 Methods invoked by print to print information about the object including superclasses. More...
 
void DeepCopy (vtkVolumeProperty *p)
 
vtkMTimeType GetMTime ()
 Get the modified time for this object (or the properties registered with this object). More...
 
virtual void SetIndependentComponents (int)
 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 int 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)
 
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 ()
 
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 ()
 
- 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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 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 int 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 ()
 
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=NULL)
 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

int 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 Shade [VTK_MAX_VRCOMP]
 
double Ambient [VTK_MAX_VRCOMP]
 
double Diffuse [VTK_MAX_VRCOMP]
 
double Specular [VTK_MAX_VRCOMP]
 
double SpecularPower [VTK_MAX_VRCOMP]
 
- 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.

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.

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)
Tests:
vtkVolumeProperty (Tests)

Definition at line 60 of file vtkVolumeProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkVolumeProperty.h.

Constructor & Destructor Documentation

◆ vtkVolumeProperty()

vtkVolumeProperty::vtkVolumeProperty ( )
protected

◆ ~vtkVolumeProperty()

vtkVolumeProperty::~vtkVolumeProperty ( )
protected

Member Function Documentation

◆ New()

static vtkVolumeProperty* vtkVolumeProperty::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual int 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 
)
virtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ DeepCopy()

void vtkVolumeProperty::DeepCopy ( vtkVolumeProperty p)

◆ GetMTime()

vtkMTimeType vtkVolumeProperty::GetMTime ( )
virtual

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

Reimplemented from vtkObject.

◆ SetIndependentComponents()

virtual void vtkVolumeProperty::SetIndependentComponents ( int  )
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 int 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 109 of file vtkVolumeProperty.h.

◆ SetInterpolationTypeToLinear()

void vtkVolumeProperty::SetInterpolationTypeToLinear ( )
inline

Definition at line 111 of file vtkVolumeProperty.h.

◆ GetInterpolationTypeAsString()

const char * vtkVolumeProperty::GetInterpolationTypeAsString ( void  )
inline

Return the interpolation type as a descriptive character string.

Definition at line 427 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 131 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 141 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 149 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 158 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 167 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 175 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 184 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 195 of file vtkVolumeProperty.h.

◆ GetScalarOpacityUnitDistance() [1/2]

double vtkVolumeProperty::GetScalarOpacityUnitDistance ( int  index)

◆ GetScalarOpacityUnitDistance() [2/2]

double vtkVolumeProperty::GetScalarOpacityUnitDistance ( )
inline

Definition at line 198 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 208 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 220 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 232 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOn() [1/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOn ( int  index)
inlinevirtual

Definition at line 234 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOn() [2/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOn ( )
inlinevirtual

Definition at line 236 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOff() [1/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOff ( int  index)
inlinevirtual

Definition at line 238 of file vtkVolumeProperty.h.

◆ DisableGradientOpacityOff() [2/2]

virtual void vtkVolumeProperty::DisableGradientOpacityOff ( )
inlinevirtual

Definition at line 240 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 243 of file vtkVolumeProperty.h.

◆ GetStoredGradientOpacity() [1/2]

vtkPiecewiseFunction* vtkVolumeProperty::GetStoredGradientOpacity ( int  index)

◆ GetStoredGradientOpacity() [2/2]

vtkPiecewiseFunction* vtkVolumeProperty::GetStoredGradientOpacity ( )
inline

Definition at line 246 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 256 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 282 of file vtkVolumeProperty.h.

◆ GetShade() [1/2]

int vtkVolumeProperty::GetShade ( int  index)

◆ GetShade() [2/2]

int vtkVolumeProperty::GetShade ( )
inline

Definition at line 285 of file vtkVolumeProperty.h.

◆ ShadeOn() [1/2]

void vtkVolumeProperty::ShadeOn ( int  index)

◆ ShadeOn() [2/2]

void vtkVolumeProperty::ShadeOn ( )
inline

Definition at line 288 of file vtkVolumeProperty.h.

◆ ShadeOff() [1/2]

void vtkVolumeProperty::ShadeOff ( int  index)

◆ ShadeOff() [2/2]

void vtkVolumeProperty::ShadeOff ( )
inline

Definition at line 291 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 300 of file vtkVolumeProperty.h.

◆ GetAmbient() [1/2]

double vtkVolumeProperty::GetAmbient ( int  index)

◆ GetAmbient() [2/2]

double vtkVolumeProperty::GetAmbient ( )
inline

Definition at line 303 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 312 of file vtkVolumeProperty.h.

◆ GetDiffuse() [1/2]

double vtkVolumeProperty::GetDiffuse ( int  index)

◆ GetDiffuse() [2/2]

double vtkVolumeProperty::GetDiffuse ( )
inline

Definition at line 315 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 324 of file vtkVolumeProperty.h.

◆ GetSpecular() [1/2]

double vtkVolumeProperty::GetSpecular ( int  index)

◆ GetSpecular() [2/2]

double vtkVolumeProperty::GetSpecular ( )
inline

Definition at line 327 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 336 of file vtkVolumeProperty.h.

◆ GetSpecularPower() [1/2]

double vtkVolumeProperty::GetSpecularPower ( int  index)

◆ GetSpecularPower() [2/2]

double vtkVolumeProperty::GetSpecularPower ( )
inline

Definition at line 339 of file vtkVolumeProperty.h.

◆ 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 357 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 365 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 373 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 381 of file vtkVolumeProperty.h.

◆ CreateDefaultGradientOpacity()

virtual void vtkVolumeProperty::CreateDefaultGradientOpacity ( int  index)
protectedvirtual

Member Data Documentation

◆ IndependentComponents

int vtkVolumeProperty::IndependentComponents
protected

Definition at line 388 of file vtkVolumeProperty.h.

◆ ComponentWeight

double vtkVolumeProperty::ComponentWeight[VTK_MAX_VRCOMP]
protected

Definition at line 389 of file vtkVolumeProperty.h.

◆ InterpolationType

int vtkVolumeProperty::InterpolationType
protected

Definition at line 391 of file vtkVolumeProperty.h.

◆ ColorChannels

int vtkVolumeProperty::ColorChannels[VTK_MAX_VRCOMP]
protected

Definition at line 393 of file vtkVolumeProperty.h.

◆ GrayTransferFunction

vtkPiecewiseFunction* vtkVolumeProperty::GrayTransferFunction[VTK_MAX_VRCOMP]
protected

Definition at line 395 of file vtkVolumeProperty.h.

◆ GrayTransferFunctionMTime

vtkTimeStamp vtkVolumeProperty::GrayTransferFunctionMTime[VTK_MAX_VRCOMP]
protected

Definition at line 396 of file vtkVolumeProperty.h.

◆ RGBTransferFunction

vtkColorTransferFunction* vtkVolumeProperty::RGBTransferFunction[VTK_MAX_VRCOMP]
protected

Definition at line 398 of file vtkVolumeProperty.h.

◆ RGBTransferFunctionMTime

vtkTimeStamp vtkVolumeProperty::RGBTransferFunctionMTime[VTK_MAX_VRCOMP]
protected

Definition at line 399 of file vtkVolumeProperty.h.

◆ ScalarOpacity

vtkPiecewiseFunction* vtkVolumeProperty::ScalarOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 401 of file vtkVolumeProperty.h.

◆ ScalarOpacityMTime

vtkTimeStamp vtkVolumeProperty::ScalarOpacityMTime[VTK_MAX_VRCOMP]
protected

Definition at line 402 of file vtkVolumeProperty.h.

◆ ScalarOpacityUnitDistance

double vtkVolumeProperty::ScalarOpacityUnitDistance[VTK_MAX_VRCOMP]
protected

Definition at line 403 of file vtkVolumeProperty.h.

◆ GradientOpacity

vtkPiecewiseFunction* vtkVolumeProperty::GradientOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 405 of file vtkVolumeProperty.h.

◆ GradientOpacityMTime

vtkTimeStamp vtkVolumeProperty::GradientOpacityMTime[VTK_MAX_VRCOMP]
protected

Definition at line 406 of file vtkVolumeProperty.h.

◆ DefaultGradientOpacity

vtkPiecewiseFunction* vtkVolumeProperty::DefaultGradientOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 407 of file vtkVolumeProperty.h.

◆ DisableGradientOpacity

int vtkVolumeProperty::DisableGradientOpacity[VTK_MAX_VRCOMP]
protected

Definition at line 408 of file vtkVolumeProperty.h.

◆ Shade

int vtkVolumeProperty::Shade[VTK_MAX_VRCOMP]
protected

Definition at line 410 of file vtkVolumeProperty.h.

◆ Ambient

double vtkVolumeProperty::Ambient[VTK_MAX_VRCOMP]
protected

Definition at line 411 of file vtkVolumeProperty.h.

◆ Diffuse

double vtkVolumeProperty::Diffuse[VTK_MAX_VRCOMP]
protected

Definition at line 412 of file vtkVolumeProperty.h.

◆ Specular

double vtkVolumeProperty::Specular[VTK_MAX_VRCOMP]
protected

Definition at line 413 of file vtkVolumeProperty.h.

◆ SpecularPower

double vtkVolumeProperty::SpecularPower[VTK_MAX_VRCOMP]
protected

Definition at line 414 of file vtkVolumeProperty.h.


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