Man Page for vtkVolumeProperty
Table of Contents

NAME

vtkVolumeProperty - represents the common properties for rendering a volume.

SYNOPSIS


#include "/opt/vtk-c++/graphics/vtkVolumeProperty.h"

class VTK_EXPORT vtkVolumeProperty : public vtkObject

vtkVolumeProperty();
~vtkVolumeProperty();
static vtkVolumeProperty *New() {return new vtkVolumeProperty;};
const char *GetClassName() {return "vtkVolumeProperty";};
void PrintSelf(ostream& os, vtkIndent indent);
void Set InterpolationType( int);
VTK_NEAREST_INTERPOLATION, VTK_LINEAR_INTERPOLATION);
int GetInterpolationType();
void SetInterpolationTypeToNearest()
{this->SetInterpolationType(VTK_NEAREST_INTERPOLATION);};
void SetInterpolationTypeToLinear()
{this->SetInterpolationType(VTK_LINEAR_INTERPOLATION);};
char *GetInterpolationTypeAsString(void);
void SetColor( vtkPiecewiseFunction *function );
int GetColorChannels();
vtkPiecewiseFunction *GetGrayTransferFunction();
vtkTimeStamp GetGrayTransferFunctionMTime();
void SetColor( vtkColorTransferFunction *function );
vtkColorTransferFunction *GetRGBTransferFunction();
vtkTimeStamp GetRGBTransferFunctionMTime();
void SetOpacity( vtkPiecewiseFunction *function );
vtkPiecewiseFunction *GetOpacityTransferFunction();
vtkTimeStamp GetOpacityTransferFunctionMTime();
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();

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 opacity of a volume, and shading parameters of a volume.

SEE ALSO

vtkPiecewiseFunction vtkColorTransferFunction

DEFINED MACROS

VTK_NEAREST_INTERPOLATION
0 VTK_LINEAR_INTERPOLATION 1
VTK_NO_SHADE
0
VTK_FAST_SHADE
1 // Fastest shading algorithm avail.
VTK_BEST_SHADE
2 // Best shading algorithm available

SUMMARY

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

int GetColorChannels()
Set the color of a volume to a gray level transfer function. This will also set the ColorChannels to 1. Get the number of color channels in the transfer function

vtkTimeStamp GetGrayTransferFunctionMTime()
Get the gray transfer function. Get the time that the GrayTransferFunction was set

vtkTimeStamp GetRGBTransferFunctionMTime()
Set the color of a volume to an RGB transfer function. This will also set the ColorChannels to 3. Get the RGB transfer function. Get the time that the RGBTransferFunction was set

vtkTimeStamp GetOpacityTransferFunctionMTime()
Set the opacity of a volume to an opacity transfer function. Get the opacity transfer function. Get the time that the OpacityTransferFunction was set

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

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

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

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

void SetSpecularPower(float)
Set/Get the specular power.

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

vtkVolumeProperty()
Construct a new vtkVolumeProperty with default values

~vtkVolumeProperty()
Destruct a vtkVolumeProperty

void SetColor( vtkPiecewiseFunction *function )
Set the color of a volume to a gray transfer function

vtkPiecewiseFunction *GetGrayTransferFunction()
Get the currently set gray transfer function. Create one if none set.

void SetColor( vtkColorTransferFunction *function )
Set the color of a volume to an RGB transfer function

vtkColorTransferFunction *GetRGBTransferFunction()
Get the currently set RGB transfer function. Create one if none set.

void SetOpacity( vtkPiecewiseFunction *function )
Set the opacity of a volume to a transfer function

vtkPiecewiseFunction *GetOpacityTransferFunction()
Get the currently set opacity transfer function. Create one if none set.

void PrintSelf(ostream& os, vtkIndent indent)
Print the state of the volume property.


Table of Contents