vtkImageActor Class Reference
#include <vtkImageActor.h>
Inheritance diagram for vtkImageActor:
[legend]Collaboration diagram for vtkImageActor:
[legend]List of all members.
Detailed Description
draw an image (data & properties) in a rendered 3D scene
vtkImageActor is used to render an image in a 3D scene. The image is placed at the origin of the image, and its size is controlled by the image dimensions and image spacing. The orientation of the image is orthogonal to one of the x-y-z axes depending on which plane the image is defined in. vtkImageActor duplicates the functionality of combinations of other VTK classes in a convenient, single class.
- Warning:
- vtkImageData requires the image to be of type unsigned char. Use a filter like vtkImageShiftScale to convert to unsigned char (the method to use is SetOutputTypeToUnsignedChar()).
- See also:
- vtkImageData vtkProp vtkImageShiftScale
- Created by:
-
- CVS contributions (if > 5%):
- Martin, Ken (65%)
- Gobbi, David (22%)
- Schroeder, Will (8%)
- CVS logs (CVSweb):
.h (/Rendering/vtkImageActor
.h)
.cxx (/Rendering/vtkImageActor
.cxx)
- Examples:
- vtkImageActor (Examples)
- Tests:
- vtkImageActor (Tests)
Definition at line 61 of file vtkImageActor.h.
Member Typedef Documentation
Constructor & Destructor Documentation
vtkImageActor::vtkImageActor |
( |
|
) |
[protected] |
|
Member Function Documentation
virtual const char* vtkImageActor::GetClassName |
( |
|
) |
[virtual] |
|
int vtkImageActor::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.
Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor. |
virtual int vtkImageActor::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.
Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor. |
void vtkImageActor::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.
Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor. |
virtual void vtkImageActor::SetInput |
( |
vtkImageData * |
|
) |
[virtual] |
|
|
Set/Get the image data input for the image actor. |
|
Set/Get the image data input for the image actor. |
virtual int vtkImageActor::GetInterpolate |
( |
|
) |
[virtual] |
|
|
Turn on/off linear interpolation of the image when rendering. |
virtual void vtkImageActor::SetInterpolate |
( |
int |
|
) |
[virtual] |
|
|
Turn on/off linear interpolation of the image when rendering. |
virtual void vtkImageActor::InterpolateOn |
( |
|
) |
[virtual] |
|
|
Turn on/off linear interpolation of the image when rendering. |
virtual void vtkImageActor::InterpolateOff |
( |
|
) |
[virtual] |
|
|
Turn on/off linear interpolation of the image when rendering. |
virtual void vtkImageActor::SetOpacity |
( |
double |
|
) |
[virtual] |
|
|
Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent. |
virtual double vtkImageActor::GetOpacity |
( |
|
) |
[virtual] |
|
|
Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent. |
void vtkImageActor::SetDisplayExtent |
( |
int |
extent[6] |
) |
|
|
|
The image extent is generally set explicitly, but if not set it will be determined from the input image data. |
void vtkImageActor::SetDisplayExtent |
( |
int |
minX, |
|
|
int |
maxX, |
|
|
int |
minY, |
|
|
int |
maxY, |
|
|
int |
minZ, |
|
|
int |
maxZ |
|
) |
|
|
|
The image extent is generally set explicitly, but if not set it will be determined from the input image data. |
void vtkImageActor::GetDisplayExtent |
( |
int |
extent[6] |
) |
|
|
|
The image extent is generally set explicitly, but if not set it will be determined from the input image data. |
int* vtkImageActor::GetDisplayExtent |
( |
|
) |
[inline] |
|
|
The image extent is generally set explicitly, but if not set it will be determined from the input image data.
Definition at line 97 of file vtkImageActor.h. |
double* vtkImageActor::GetBounds |
( |
|
) |
[virtual] |
|
|
Get the bounds of this image actor. Either copy the bounds into a user provided array or return a pointer to an array. In either case the boudns is expressed as a 6-vector (xmin,xmax, ymin,ymax, zmin,zmax).
Implements vtkProp3D. |
void vtkImageActor::GetBounds |
( |
double |
bounds[6] |
) |
[inline] |
|
|
Get the bounds of this image actor. Either copy the bounds into a user provided array or return a pointer to an array. In either case the boudns is expressed as a 6-vector (xmin,xmax, ymin,ymax, zmin,zmax).
Reimplemented from vtkProp3D.
Definition at line 106 of file vtkImageActor.h. |
double* vtkImageActor::GetDisplayBounds |
( |
|
) |
|
|
|
Get the bounds of the data that is displayed by this image actor. If the transformation matrix for this actor is the identity matrix, this will return the same value as GetBounds. |
void vtkImageActor::GetDisplayBounds |
( |
double |
bounds[6] |
) |
|
|
|
Get the bounds of the data that is displayed by this image actor. If the transformation matrix for this actor is the identity matrix, this will return the same value as GetBounds. |
int vtkImageActor::GetSliceNumber |
( |
|
) |
|
|
|
Return a slice number computed from the display extent. |
int vtkImageActor::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.
Reimplemented from vtkProp. |
int vtkImageActor::RenderOpaqueGeometry |
( |
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.
Reimplemented from vtkProp. |
virtual void vtkImageActor::Render |
( |
vtkRenderer * |
|
) |
[inline, virtual] |
|
void vtkImageActor::SetZSlice |
( |
int |
z |
) |
[inline] |
|
|
Set/Get the current slice number. The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)
Definition at line 139 of file vtkImageActor.h. |
int vtkImageActor::GetZSlice |
( |
|
) |
[inline] |
|
int vtkImageActor::GetWholeZMin |
( |
|
) |
|
|
int vtkImageActor::GetWholeZMax |
( |
|
) |
|
|
Member Data Documentation
The documentation for this class was generated from the following file: