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:
[legend]Collaboration diagram for vtkVolumeProperty:
[legend]List of all members.
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] |
|
| void vtkVolumeProperty::SetInterpolationTypeToLinear |
( |
|
) |
[inline] |
|
| const char * vtkVolumeProperty::GetInterpolationTypeAsString |
( |
void |
|
) |
[inline] |
|
|
|
Return the interpolation type as a descriptive character string.
Definition at line 252 of file vtkVolumeProperty.h. |
|
|
Set the color of a volume to a gray level transfer function. This will also set the ColorChannels to 1. |
|
|
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 |
|
|
Get the gray transfer function. |
|
|
Get the RGB transfer function. |
|
|
Set the opacity of a volume to an opacity transfer function based on scalar value. |
|
|
Get the scalar opacity transfer function. |
|
|
Set the opacity of a volume to an opacity transfer function based on gradient magnitude. |
|
|
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]
|
|
int vtkVolumeProperty::ColorChannels [protected]
|
|
vtkTimeStamp vtkVolumeProperty::GrayTransferFunctionMTime [protected]
|
|
vtkTimeStamp vtkVolumeProperty::RGBTransferFunctionMTime [protected]
|
|
vtkTimeStamp vtkVolumeProperty::ScalarOpacityMTime [protected]
|
|
vtkTimeStamp vtkVolumeProperty::GradientOpacityMTime [protected]
|
|
int vtkVolumeProperty::Shade [protected]
|
|
float vtkVolumeProperty::Ambient [protected]
|
|
float vtkVolumeProperty::Diffuse [protected]
|
|
float vtkVolumeProperty::Specular [protected]
|
|
float vtkVolumeProperty::SpecularPower [protected]
|
|
float vtkVolumeProperty::RGBTextureCoefficient [protected]
|
|
The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:45:38 2002 for VTK by
1.2.11.1 written by Dimitri van Heesch,
© 1997-2001