vtkVolume Class Reference
#include <vtkVolume.h>
Inheritance diagram for vtkVolume:
[legend]Collaboration diagram for vtkVolume:
[legend]List of all members.
Detailed Description
represents a volume (data & properties) in a rendered scene
vtkVolume is used to represent a volumetric entity in a rendering scene. It inherits functions related to the volume's position, orientation and origin from vtkProp3D. The volume maintains a reference to the volumetric data (i.e., the volume mapper). The volume also contains a reference to a volume property which contains all common volume rendering parameters.
- See also:
- vtkAbstractVolumeMapper vtkVolumeProperty vtkProp3D
- Created by:
-
- CVS contributions (if > 5%):
- Avila, Lisa (61%)
- Martin, Ken (22%)
- CVS logs (CVSweb):
/Rendering/vtkVolume.h)/Rendering/vtkVolume.cxx)
- Examples:
- vtkVolume (Examples)
- Tests:
- vtkVolume (Tests)
Definition at line 59 of file vtkVolume.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkVolume::vtkVolume |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkVolume::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkVolume::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkProp3D. |
| virtual int vtkVolume::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkProp3D. |
| void vtkVolume::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 vtkProp3D. |
|
|
Creates a Volume with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pickable=1 dragable=1 orientation=(0,0,0).
Reimplemented from vtkObject. |
|
|
Set/Get the volume mapper. |
|
|
Set/Get the volume mapper. |
|
|
Set/Get the volume property. |
|
|
Set/Get the volume property. |
|
|
For some exporters and other other operations we must be able to collect all the actors or volumes. This method is used in that process.
Reimplemented from vtkProp. |
| void vtkVolume::Update |
( |
|
) |
|
|
|
|
Update the volume rendering pipeline by updating the volume mapper |
| double* vtkVolume::GetBounds |
( |
|
) |
[virtual] |
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.
Implements vtkProp3D. |
| void vtkVolume::GetBounds |
( |
double |
bounds[6] |
) |
[inline] |
|
| double vtkVolume::GetMinXBound |
( |
|
) |
|
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. |
| double vtkVolume::GetMaxXBound |
( |
|
) |
|
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. |
| double vtkVolume::GetMinYBound |
( |
|
) |
|
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. |
| double vtkVolume::GetMaxYBound |
( |
|
) |
|
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. |
| double vtkVolume::GetMinZBound |
( |
|
) |
|
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. |
| double vtkVolume::GetMaxZBound |
( |
|
) |
|
|
|
|
Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. |
| unsigned long int vtkVolume::GetMTime |
( |
|
) |
[virtual] |
|
|
|
Return the MTime also considering the property etc.
Reimplemented from vtkProp3D. |
| unsigned long vtkVolume::GetRedrawMTime |
( |
|
) |
[virtual] |
|
|
|
Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, mappers, etc.
Reimplemented from vtkProp. |
| void vtkVolume::ShallowCopy |
( |
vtkProp * |
prop |
) |
[virtual] |
|
|
|
Shallow copy of this vtkVolume. Overloads the virtual vtkProp method.
Reimplemented from vtkProp3D. |
| int vtkVolume::RenderTranslucentGeometry |
( |
vtkViewport * |
viewport |
) |
[virtual] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods. Depending on the mapper type, the volume may be rendered using this method (FRAMEBUFFER volume such as texture mapping will be rendered this way)
Reimplemented from vtkProp. |
| void vtkVolume::ReleaseGraphicsResources |
( |
vtkWindow * |
|
) |
[virtual] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this volume. The parameter window could be used to determine which graphic resources to release.
Reimplemented from vtkProp. |
| float* vtkVolume::GetCorrectedScalarOpacityArray |
( |
int |
|
) |
|
|
| float* vtkVolume::GetCorrectedScalarOpacityArray |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 133 of file vtkVolume.h. |
| float* vtkVolume::GetScalarOpacityArray |
( |
int |
|
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| float* vtkVolume::GetScalarOpacityArray |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 141 of file vtkVolume.h. |
| float* vtkVolume::GetGradientOpacityArray |
( |
int |
|
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| float* vtkVolume::GetGradientOpacityArray |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 148 of file vtkVolume.h. |
| float* vtkVolume::GetGrayArray |
( |
int |
|
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| float* vtkVolume::GetGrayArray |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 155 of file vtkVolume.h. |
| float* vtkVolume::GetRGBArray |
( |
int |
|
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| float* vtkVolume::GetRGBArray |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 162 of file vtkVolume.h. |
| float vtkVolume::GetGradientOpacityConstant |
( |
int |
|
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| float vtkVolume::GetGradientOpacityConstant |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 169 of file vtkVolume.h. |
| float vtkVolume::GetArraySize |
( |
|
) |
[inline] |
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
Definition at line 175 of file vtkVolume.h. |
| void vtkVolume::UpdateTransferFunctions |
( |
vtkRenderer * |
ren |
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| void vtkVolume::UpdateScalarOpacityforSampleSize |
( |
vtkRenderer * |
ren, |
|
|
float |
sample_distance |
|
) |
|
|
|
|
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS |
| float vtkVolume::ComputeScreenCoverage |
( |
vtkViewport * |
vp |
) |
[protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file: