Documentation for vtkVolumeProperty

vtkVolumeProperty - represents the common properties for rendering a volume.

Super Class: vtkObject

Description:

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

 

See Also:

vtkPiecewiseFunction vtkColorTransferFunction

 

Methods:

void vtkVolumeProperty ()
void vtkVolumeProperty ()
static vtkVolumeProperty *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetInterpolationType (int )
int GetInterpolationType ()
void SetInterpolationTypeToNearest ()
void SetInterpolationTypeToLinear ()
char *GetInterpolationTypeAsString ()
unsigned long GetMTime ()
void SetColor (vtkPiecewiseFunction *)
int GetColorChannels ()
vtkPiecewiseFunction *GetGrayTransferFunction ()
vtkTimeStamp GetGrayTransferFunctionMTime ()
void SetColor (vtkColorTransferFunction *)
vtkColorTransferFunction *GetRGBTransferFunction ()
vtkTimeStamp GetRGBTransferFunctionMTime ()
void SetScalarOpacity (vtkPiecewiseFunction *)
vtkPiecewiseFunction *GetScalarOpacity ()
vtkTimeStamp GetScalarOpacityMTime ()
void SetGradientOpacity (vtkPiecewiseFunction *)
vtkPiecewiseFunction *GetGradientOpacity ()
vtkTimeStamp GetGradientOpacityMTime ()
void SetShade (int )
int GetShade ()
void ShadeOn ()
void ShadeOff ()
void SetAmbient (float )
float GetAmbient ()
void SetDiffuse (float )
float GetDiffuse ()
void SetSpecular (float )
float GetSpecular ()
void SetSpecularPower (float )
float GetSpecularPower ()
void SetGradientOpacityScale (float )
float GetGradientOpacityScale ()
void SetGradientOpacityBias (float )
float GetGradientOpacityBias ()

 

Detailed Method Descriptions:

Set the interpolation type for sampling a volume.

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

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

unsigned long GetMTime ()

Set the color of a volume to a gray level transfer function. This will also set the ColorChannels to 1.

void SetColor (vtkPiecewiseFunction *)

Get the number of color channels in the transfer function

int GetColorChannels ()

Get the gray transfer function.

vtkPiecewiseFunction *GetGrayTransferFunction ()

Get the time that the GrayTransferFunction was set

vtkTimeStamp GetGrayTransferFunctionMTime ()

Set the color of a volume to an RGB transfer function. This will also set the ColorChannels to 3.

void SetColor (vtkColorTransferFunction *)

Get the RGB transfer function.

vtkColorTransferFunction *GetRGBTransferFunction ()

Get the time that the RGBTransferFunction was set

vtkTimeStamp GetRGBTransferFunctionMTime ()

Set the opacity of a volume to an opacity transfer function based on scalar value.

void SetScalarOpacity (vtkPiecewiseFunction *)

Get the scalar opacity transfer function.

vtkPiecewiseFunction *GetScalarOpacity ()

Get the time that the scalar opacity transfer function was set.

vtkTimeStamp GetScalarOpacityMTime ()

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

void SetGradientOpacity (vtkPiecewiseFunction *)

Get the gradient magnitude opacity transfer function.

vtkPiecewiseFunction *GetGradientOpacity ()

Get the time that the gradient opacity transfer function was set

vtkTimeStamp GetGradientOpacityMTime ()

Set/Get the shading of a volume.

void SetShade (int )
int GetShade ()
void ShadeOn ()
void ShadeOff ()

Set/Get the ambient lighting coefficient.

void SetAmbient (float )
float GetAmbient ()

Set/Get the diffuse lighting coefficient.

void SetDiffuse (float )
float GetDiffuse ()

Set/Get the specular lighting coefficient.

void SetSpecular (float )
float GetSpecular ()

Set/Get the specular power.

void SetSpecularPower (float )
float GetSpecularPower ()

Set/Get the gradient magnitude opacity scale.

void SetGradientOpacityScale (float )
float GetGradientOpacityScale ()

Set/Get the gradient magnitude opacity bias.

void SetGradientOpacityBias (float )
float GetGradientOpacityBias ()