Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkVolumeProperty Class Reference

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

#include <vtkVolumeProperty.h>

Inheritance diagram for vtkVolumeProperty:

Inheritance graph
[legend]
Collaboration diagram for vtkVolumeProperty:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long GetMTime ()
void SetColor (vtkPiecewiseFunction *function)
void SetColor (vtkColorTransferFunction *function)
vtkPiecewiseFunctionGetGrayTransferFunction ()
vtkColorTransferFunctionGetRGBTransferFunction ()
void SetScalarOpacity (vtkPiecewiseFunction *function)
vtkPiecewiseFunctionGetScalarOpacity ()
void SetGradientOpacity (vtkPiecewiseFunction *function)
vtkPiecewiseFunctionGetGradientOpacity ()
void UpdateMTimes ()
virtual void SetInterpolationType (int)
virtual int GetInterpolationType ()
void SetInterpolationTypeToNearest ()
void SetInterpolationTypeToLinear ()
const char * GetInterpolationTypeAsString (void)
virtual int GetColorChannels ()
virtual void SetShade (int)
virtual int GetShade ()
virtual void ShadeOn ()
virtual void ShadeOff ()
virtual void SetAmbient (float)
virtual float GetAmbient ()
virtual void SetDiffuse (float)
virtual float GetDiffuse ()
virtual void SetSpecular (float)
virtual float GetSpecular ()
virtual void SetSpecularPower (float)
virtual float GetSpecularPower ()
virtual void SetRGBTextureCoefficient (float)
virtual float GetRGBTextureCoefficient ()
virtual vtkTimeStamp GetGradientOpacityMTime ()
virtual vtkTimeStamp GetScalarOpacityMTime ()
virtual vtkTimeStamp GetRGBTransferFunctionMTime ()
virtual vtkTimeStamp GetGrayTransferFunctionMTime ()

Static Public Methods

vtkVolumeProperty * New ()
int IsTypeOf (const char *type)
vtkVolumeProperty * SafeDownCast (vtkObject *o)

Protected Methods

 vtkVolumeProperty ()
 ~vtkVolumeProperty ()

Protected Attributes

int InterpolationType
int ColorChannels
vtkPiecewiseFunctionGrayTransferFunction
vtkTimeStamp GrayTransferFunctionMTime
vtkColorTransferFunctionRGBTransferFunction
vtkTimeStamp RGBTransferFunctionMTime
vtkPiecewiseFunctionScalarOpacity
vtkTimeStamp ScalarOpacityMTime
vtkPiecewiseFunctionGradientOpacity
vtkTimeStamp GradientOpacityMTime
int Shade
float Ambient
float Diffuse
float Specular
float SpecularPower
float RGBTextureCoefficient

Detailed Description

represents the common properties for rendering a volume.

Date:
2001/11/13 14:17:31
Revision:
1.32

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

Definition at line 83 of file vtkVolumeProperty.h.


Constructor & Destructor Documentation

vtkVolumeProperty::vtkVolumeProperty   [protected]
 

vtkVolumeProperty::~vtkVolumeProperty   [protected]
 


Member Function Documentation

vtkVolumeProperty* vtkVolumeProperty::New   [static]
 

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

Reimplemented from vtkObject.

virtual const char* vtkVolumeProperty::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

int vtkVolumeProperty::IsTypeOf const char *    type [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 *    type [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.

vtkVolumeProperty* vtkVolumeProperty::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

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.

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::SetInterpolationType int    [virtual]
 

Set the interpolation type for sampling a volume.

virtual int vtkVolumeProperty::GetInterpolationType   [virtual]
 

Set the interpolation type for sampling a volume.

void vtkVolumeProperty::SetInterpolationTypeToNearest   [inline]
 

Set the interpolation type for sampling a volume.

Definition at line 100 of file vtkVolumeProperty.h.

void vtkVolumeProperty::SetInterpolationTypeToLinear   [inline]
 

Set the interpolation type for sampling a volume.

Definition at line 102 of file vtkVolumeProperty.h.

const char * vtkVolumeProperty::GetInterpolationTypeAsString void    [inline]
 

Return the interpolation type as a descriptive character string.

Definition at line 252 of file vtkVolumeProperty.h.

void vtkVolumeProperty::SetColor vtkPiecewiseFunction   function
 

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

void vtkVolumeProperty::SetColor vtkColorTransferFunction   function
 

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

virtual int vtkVolumeProperty::GetColorChannels   [virtual]
 

Get the number of color channels in the transfer function

vtkPiecewiseFunction* vtkVolumeProperty::GetGrayTransferFunction  
 

Get the gray transfer function.

vtkColorTransferFunction* vtkVolumeProperty::GetRGBTransferFunction  
 

Get the RGB transfer function.

void vtkVolumeProperty::SetScalarOpacity vtkPiecewiseFunction   function
 

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

vtkPiecewiseFunction* vtkVolumeProperty::GetScalarOpacity  
 

Get the scalar opacity transfer function.

void vtkVolumeProperty::SetGradientOpacity vtkPiecewiseFunction   function
 

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

vtkPiecewiseFunction* vtkVolumeProperty::GetGradientOpacity  
 

Get the gradient magnitude opacity transfer function.

virtual void vtkVolumeProperty::SetShade int    [virtual]
 

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.

virtual int vtkVolumeProperty::GetShade   [virtual]
 

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.

virtual void vtkVolumeProperty::ShadeOn   [virtual]
 

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.

virtual void vtkVolumeProperty::ShadeOff   [virtual]
 

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.

virtual void vtkVolumeProperty::SetAmbient float    [virtual]
 

Set/Get the ambient lighting coefficient.

virtual float vtkVolumeProperty::GetAmbient   [virtual]
 

Set/Get the ambient lighting coefficient.

virtual void vtkVolumeProperty::SetDiffuse float    [virtual]
 

Set/Get the diffuse lighting coefficient.

virtual float vtkVolumeProperty::GetDiffuse   [virtual]
 

Set/Get the diffuse lighting coefficient.

virtual void vtkVolumeProperty::SetSpecular float    [virtual]
 

Set/Get the specular lighting coefficient.

virtual float vtkVolumeProperty::GetSpecular   [virtual]
 

Set/Get the specular lighting coefficient.

virtual void vtkVolumeProperty::SetSpecularPower float    [virtual]
 

Set/Get the specular power.

virtual float vtkVolumeProperty::GetSpecularPower   [virtual]
 

Set/Get the specular power.

virtual void vtkVolumeProperty::SetRGBTextureCoefficient float    [virtual]
 

Set/Get the texture coefficient. This controls how much of the color comes from the color transfer function and how much comes from the RGB texture, with RGBTextureCoefficient used for the texture and (1 - RGBTextureCoefficient) used for the transfer function.

virtual float vtkVolumeProperty::GetRGBTextureCoefficient   [virtual]
 

Set/Get the texture coefficient. This controls how much of the color comes from the color transfer function and how much comes from the RGB texture, with RGBTextureCoefficient used for the texture and (1 - RGBTextureCoefficient) used for the transfer function.

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.

virtual vtkTimeStamp vtkVolumeProperty::GetGradientOpacityMTime   [virtual]
 

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

virtual vtkTimeStamp vtkVolumeProperty::GetScalarOpacityMTime   [virtual]
 

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

virtual vtkTimeStamp vtkVolumeProperty::GetRGBTransferFunctionMTime   [virtual]
 

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

virtual vtkTimeStamp vtkVolumeProperty::GetGrayTransferFunctionMTime   [virtual]
 

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


Member Data Documentation

int vtkVolumeProperty::InterpolationType [protected]
 

Definition at line 224 of file vtkVolumeProperty.h.

int vtkVolumeProperty::ColorChannels [protected]
 

Definition at line 226 of file vtkVolumeProperty.h.

vtkPiecewiseFunction* vtkVolumeProperty::GrayTransferFunction [protected]
 

Definition at line 228 of file vtkVolumeProperty.h.

vtkTimeStamp vtkVolumeProperty::GrayTransferFunctionMTime [protected]
 

Definition at line 229 of file vtkVolumeProperty.h.

vtkColorTransferFunction* vtkVolumeProperty::RGBTransferFunction [protected]
 

Definition at line 231 of file vtkVolumeProperty.h.

vtkTimeStamp vtkVolumeProperty::RGBTransferFunctionMTime [protected]
 

Definition at line 232 of file vtkVolumeProperty.h.

vtkPiecewiseFunction* vtkVolumeProperty::ScalarOpacity [protected]
 

Definition at line 234 of file vtkVolumeProperty.h.

vtkTimeStamp vtkVolumeProperty::ScalarOpacityMTime [protected]
 

Definition at line 235 of file vtkVolumeProperty.h.

vtkPiecewiseFunction* vtkVolumeProperty::GradientOpacity [protected]
 

Definition at line 237 of file vtkVolumeProperty.h.

vtkTimeStamp vtkVolumeProperty::GradientOpacityMTime [protected]
 

Definition at line 238 of file vtkVolumeProperty.h.

int vtkVolumeProperty::Shade [protected]
 

Definition at line 240 of file vtkVolumeProperty.h.

float vtkVolumeProperty::Ambient [protected]
 

Definition at line 241 of file vtkVolumeProperty.h.

float vtkVolumeProperty::Diffuse [protected]
 

Definition at line 242 of file vtkVolumeProperty.h.

float vtkVolumeProperty::Specular [protected]
 

Definition at line 243 of file vtkVolumeProperty.h.

float vtkVolumeProperty::SpecularPower [protected]
 

Definition at line 244 of file vtkVolumeProperty.h.

float vtkVolumeProperty::RGBTextureCoefficient [protected]
 

Definition at line 245 of file vtkVolumeProperty.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:45:38 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001