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 int	IsA (const char *type)
vtkVolumeProperty *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	DeepCopy (vtkVolumeProperty *p)
unsigned long	GetMTime ()
void	UpdateMTimes ()

virtual void	SetIndependentComponents (int)
virtual int	GetIndependentComponents ()
virtual void	IndependentComponentsOn ()
virtual void	IndependentComponentsOff ()

virtual void	SetInterpolationType (int)
virtual int	GetInterpolationType ()
void	SetInterpolationTypeToNearest ()
void	SetInterpolationTypeToLinear ()
const char *	GetInterpolationTypeAsString (void)

virtual void	SetComponentWeight (int index, double value)
virtual double	GetComponentWeight (int index)

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

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

int	GetColorChannels (int index)
int	GetColorChannels ()

vtkPiecewiseFunction *	GetGrayTransferFunction (int index)
vtkPiecewiseFunction *	GetGrayTransferFunction ()

vtkColorTransferFunction *	GetRGBTransferFunction (int index)
vtkColorTransferFunction *	GetRGBTransferFunction ()

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

vtkPiecewiseFunction *	GetScalarOpacity (int index)
vtkPiecewiseFunction *	GetScalarOpacity ()

void	SetScalarOpacityUnitDistance (int index, double distance)
void	SetScalarOpacityUnitDistance (double distance)
double	GetScalarOpacityUnitDistance (int index)
double	GetScalarOpacityUnitDistance ()

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

vtkPiecewiseFunction *	GetGradientOpacity (int index)
vtkPiecewiseFunction *	GetGradientOpacity ()

virtual void	SetDisableGradientOpacity (int index, int value)
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 ()
vtkPiecewiseFunction *	GetStoredGradientOpacity (int index)
vtkPiecewiseFunction *	GetStoredGradientOpacity ()

void	SetShade (int index, int value)
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)
void	SetAmbient (double value)
double	GetAmbient (int index)
double	GetAmbient ()

void	SetDiffuse (int index, double value)
void	SetDiffuse (double value)
double	GetDiffuse (int index)
double	GetDiffuse ()

void	SetSpecular (int index, double value)
void	SetSpecular (double value)
double	GetSpecular (int index)
double	GetSpecular ()

void	SetSpecularPower (int index, double value)
void	SetSpecularPower (double value)
double	GetSpecularPower (int index)
double	GetSpecularPower ()

vtkTimeStamp	GetGradientOpacityMTime (int index)
vtkTimeStamp	GetGradientOpacityMTime ()

vtkTimeStamp	GetScalarOpacityMTime (int index)
vtkTimeStamp	GetScalarOpacityMTime ()

vtkTimeStamp	GetRGBTransferFunctionMTime (int index)
vtkTimeStamp	GetRGBTransferFunctionMTime ()

vtkTimeStamp	GetGrayTransferFunctionMTime (int index)
vtkTimeStamp	GetGrayTransferFunctionMTime ()
Static Public Member Functions
static vtkVolumeProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkVolumeProperty *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVolumeProperty ()
	~vtkVolumeProperty ()
virtual void	CreateDefaultGradientOpacity (int index)
Protected Attributes
int	IndependentComponents
double	ComponentWeight [VTK_MAX_VRCOMP]
int	InterpolationType
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	Shade [VTK_MAX_VRCOMP]
double	Ambient [VTK_MAX_VRCOMP]
double	Diffuse [VTK_MAX_VRCOMP]
double	Specular [VTK_MAX_VRCOMP]
double	SpecularPower [VTK_MAX_VRCOMP]

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

Member Typedef Documentation

typedef vtkObject vtkVolumeProperty::Superclass

Reimplemented from vtkObject.

Definition at line 63 of file vtkVolumeProperty.h.

Constructor & Destructor Documentation

vtkVolumeProperty::vtkVolumeProperty ( ) [protected]

vtkVolumeProperty::~vtkVolumeProperty ( ) [protected]

Member Function Documentation

static vtkVolumeProperty* vtkVolumeProperty::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkVolumeProperty::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkObject.

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

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

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkVolumeProperty::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkVolumeProperty* vtkVolumeProperty::NewInstance ( ) const

Reimplemented from vtkObject.

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.

void vtkVolumeProperty::DeepCopy ( vtkVolumeProperty * p )

unsigned long vtkVolumeProperty::GetMTime ( ) [virtual]

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

Reimplemented from vtkObject.

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 opacity transfer function. Normals will be generated 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. Normals will be generated from the fourth component.

virtual int 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 opacity transfer function. Normals will be generated 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. Normals will be generated from the fourth component.

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 opacity transfer function. Normals will be generated 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. Normals will be generated from the fourth component.

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 opacity transfer function. Normals will be generated 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. Normals will be generated from the fourth component.

virtual void vtkVolumeProperty::SetInterpolationType ( int ) [virtual]

Set the interpolation type for sampling a volume. Initial value is VTK_NEAREST_INTERPOLATION.

virtual int vtkVolumeProperty::GetInterpolationType ( ) [virtual]

Set the interpolation type for sampling a volume. Initial value is VTK_NEAREST_INTERPOLATION.

void vtkVolumeProperty::SetInterpolationTypeToNearest ( ) [inline]

Set the interpolation type for sampling a volume. Initial value is VTK_NEAREST_INTERPOLATION.

Definition at line 97 of file vtkVolumeProperty.h.

void vtkVolumeProperty::SetInterpolationTypeToLinear ( ) [inline]

Set the interpolation type for sampling a volume. Initial value is VTK_NEAREST_INTERPOLATION.

Definition at line 99 of file vtkVolumeProperty.h.

const char * vtkVolumeProperty::GetInterpolationTypeAsString ( void ) [inline]

Return the interpolation type as a descriptive character string.

Definition at line 372 of file vtkVolumeProperty.h.

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

Set/Get the scalar component weights

virtual double vtkVolumeProperty::GetComponentWeight ( int index ) [virtual]

Set/Get the scalar component weights

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.

void vtkVolumeProperty::SetColor ( vtkPiecewiseFunction * function ) [inline]

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.

Definition at line 115 of file vtkVolumeProperty.h.

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

void vtkVolumeProperty::SetColor ( vtkColorTransferFunction * function ) [inline]

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

Definition at line 124 of file vtkVolumeProperty.h.

int vtkVolumeProperty::GetColorChannels ( int index )

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

int vtkVolumeProperty::GetColorChannels ( ) [inline]

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

Definition at line 132 of file vtkVolumeProperty.h.

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.

vtkPiecewiseFunction* vtkVolumeProperty::GetGrayTransferFunction ( ) [inline]

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

Definition at line 140 of file vtkVolumeProperty.h.

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.

vtkColorTransferFunction* vtkVolumeProperty::GetRGBTransferFunction ( ) [inline]

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.

Definition at line 149 of file vtkVolumeProperty.h.

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.

void vtkVolumeProperty::SetScalarOpacity ( vtkPiecewiseFunction * function ) [inline]

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

Definition at line 157 of file vtkVolumeProperty.h.

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.

vtkPiecewiseFunction* vtkVolumeProperty::GetScalarOpacity ( ) [inline]

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.

Definition at line 166 of file vtkVolumeProperty.h.

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.

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

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.

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

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.

void vtkVolumeProperty::SetGradientOpacity ( vtkPiecewiseFunction * function ) [inline]

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

Definition at line 189 of file vtkVolumeProperty.h.

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.

vtkPiecewiseFunction* vtkVolumeProperty::GetGradientOpacity ( ) [inline]

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.

Definition at line 199 of file vtkVolumeProperty.h.

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

virtual void vtkVolumeProperty::SetDisableGradientOpacity ( int value ) [inline, 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().

Definition at line 210 of file vtkVolumeProperty.h.

virtual void vtkVolumeProperty::DisableGradientOpacityOn ( int index ) [inline, 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().

Definition at line 212 of file vtkVolumeProperty.h.

virtual void vtkVolumeProperty::DisableGradientOpacityOn ( ) [inline, 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().

Definition at line 214 of file vtkVolumeProperty.h.

virtual void vtkVolumeProperty::DisableGradientOpacityOff ( int index ) [inline, 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().

Definition at line 216 of file vtkVolumeProperty.h.

virtual void vtkVolumeProperty::DisableGradientOpacityOff ( ) [inline, 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().

Definition at line 218 of file vtkVolumeProperty.h.

virtual int vtkVolumeProperty::GetDisableGradientOpacity ( int index ) [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().

virtual int vtkVolumeProperty::GetDisableGradientOpacity ( ) [inline, 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().

Definition at line 221 of file vtkVolumeProperty.h.

vtkPiecewiseFunction* vtkVolumeProperty::GetStoredGradientOpacity ( int index )

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

vtkPiecewiseFunction* vtkVolumeProperty::GetStoredGradientOpacity ( ) [inline]

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

Definition at line 224 of file vtkVolumeProperty.h.

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.

void vtkVolumeProperty::SetShade ( int value ) [inline]

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.

Definition at line 238 of file vtkVolumeProperty.h.

int vtkVolumeProperty::GetShade ( int index )

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.

int vtkVolumeProperty::GetShade ( ) [inline]

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.

Definition at line 241 of file vtkVolumeProperty.h.

void vtkVolumeProperty::ShadeOn ( int index )

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.

void vtkVolumeProperty::ShadeOn ( ) [inline]

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.

Definition at line 244 of file vtkVolumeProperty.h.

void vtkVolumeProperty::ShadeOff ( int index )

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.

void vtkVolumeProperty::ShadeOff ( ) [inline]

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.

Definition at line 247 of file vtkVolumeProperty.h.

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

Set/Get the ambient lighting coefficient.

void vtkVolumeProperty::SetAmbient ( double value ) [inline]

Set/Get the ambient lighting coefficient.

Definition at line 254 of file vtkVolumeProperty.h.

double vtkVolumeProperty::GetAmbient ( int index )

Set/Get the ambient lighting coefficient.

double vtkVolumeProperty::GetAmbient ( ) [inline]

Set/Get the ambient lighting coefficient.

Definition at line 257 of file vtkVolumeProperty.h.

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

Set/Get the diffuse lighting coefficient.

void vtkVolumeProperty::SetDiffuse ( double value ) [inline]

Set/Get the diffuse lighting coefficient.

Definition at line 264 of file vtkVolumeProperty.h.

double vtkVolumeProperty::GetDiffuse ( int index )

Set/Get the diffuse lighting coefficient.

double vtkVolumeProperty::GetDiffuse ( ) [inline]

Set/Get the diffuse lighting coefficient.

Definition at line 267 of file vtkVolumeProperty.h.

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

Set/Get the specular lighting coefficient.

void vtkVolumeProperty::SetSpecular ( double value ) [inline]

Set/Get the specular lighting coefficient.

Definition at line 274 of file vtkVolumeProperty.h.

double vtkVolumeProperty::GetSpecular ( int index )

Set/Get the specular lighting coefficient.

double vtkVolumeProperty::GetSpecular ( ) [inline]

Set/Get the specular lighting coefficient.

Definition at line 277 of file vtkVolumeProperty.h.

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

Set/Get the specular power.

void vtkVolumeProperty::SetSpecularPower ( double value ) [inline]

Set/Get the specular power.

Definition at line 284 of file vtkVolumeProperty.h.

double vtkVolumeProperty::GetSpecularPower ( int index )

Set/Get the specular power.

double vtkVolumeProperty::GetSpecularPower ( ) [inline]

Set/Get the specular power.

Definition at line 287 of file vtkVolumeProperty.h.

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.

vtkTimeStamp vtkVolumeProperty::GetGradientOpacityMTime ( int index )

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

vtkTimeStamp vtkVolumeProperty::GetGradientOpacityMTime ( ) [inline]

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

Definition at line 302 of file vtkVolumeProperty.h.

vtkTimeStamp vtkVolumeProperty::GetScalarOpacityMTime ( int index )

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

vtkTimeStamp vtkVolumeProperty::GetScalarOpacityMTime ( ) [inline]

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

Definition at line 310 of file vtkVolumeProperty.h.

vtkTimeStamp vtkVolumeProperty::GetRGBTransferFunctionMTime ( int index )

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