vtkImageActor Class Reference
#include <vtkImageActor.h>
Detailed Description
draw an image (data & properties) in a rendered 3D scenevtkImageActor 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
- Tests:
- vtkImageActor (Tests)
Definition at line 46 of file vtkImageActor.h.
Public Types | |
| typedef vtkProp3D | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetInput (vtkImageData *) |
| virtual vtkImageData * | GetInput () |
| virtual int | GetInterpolate () |
| virtual void | SetInterpolate (int) |
| virtual void | InterpolateOn () |
| virtual void | InterpolateOff () |
| virtual void | SetOpacity (double) |
| virtual double | GetOpacity () |
| void | SetDisplayExtent (int extent[6]) |
| void | SetDisplayExtent (int minX, int maxX, int minY, int maxY, int minZ, int maxZ) |
| void | GetDisplayExtent (int extent[6]) |
| int * | GetDisplayExtent () |
| double * | GetBounds () |
| void | GetBounds (double bounds[6]) |
| double * | GetDisplayBounds () |
| void | GetDisplayBounds (double bounds[6]) |
| int | GetSliceNumber () |
| int | GetSliceNumberMax () |
| int | GetSliceNumberMin () |
| virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *viewport) |
| int | RenderOpaqueGeometry (vtkViewport *viewport) |
| virtual void | Render (vtkRenderer *) |
| virtual int | HasTranslucentPolygonalGeometry () |
| void | SetZSlice (int z) |
| int | GetZSlice () |
| int | GetWholeZMin () |
| int | GetWholeZMax () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkImageActor * | SafeDownCast (vtkObject *o) |
| static vtkImageActor * | New () |
Protected Member Functions | |
| vtkImageActor () | |
| ~vtkImageActor () | |
Protected Attributes | |
| int | Interpolate |
| double | Opacity |
| vtkImageData * | Input |
| int | DisplayExtent [6] |
| int | ComputedDisplayExtent [6] |
| double | DisplayBounds [6] |
Member Typedef Documentation
| typedef vtkProp3D vtkImageActor::Superclass |
Reimplemented from vtkProp3D.
Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.
Definition at line 49 of file vtkImageActor.h.
Constructor & Destructor Documentation
| vtkImageActor::vtkImageActor | ( | ) | [protected] |
| vtkImageActor::~vtkImageActor | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkImageActor::GetClassName | ( | ) | [virtual] |
| static int vtkImageActor::IsTypeOf | ( | const char * | name | ) | [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 * | name | ) | [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.
| static vtkImageActor* vtkImageActor::SafeDownCast | ( | vtkObject * | o | ) | [static] |
| 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.
| static vtkImageActor* vtkImageActor::New | ( | ) | [static] |
Instantiate the image actor.
Reimplemented from vtkObject.
Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.
| virtual void vtkImageActor::SetInput | ( | vtkImageData * | ) | [virtual] |
Set/Get the image data input for the image actor.
| virtual vtkImageData* vtkImageActor::GetInput | ( | ) | [virtual] |
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 82 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 91 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 the slice number (& min/max slice number) computed from the display extent.
| int vtkImageActor::GetSliceNumberMax | ( | ) |
Return the slice number (& min/max slice number) computed from the display extent.
| int vtkImageActor::GetSliceNumberMin | ( | ) |
Return the slice number (& min/max slice number) computed from the display extent.
| virtual int vtkImageActor::RenderTranslucentPolygonalGeometry | ( | 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] |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods.
Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.
Definition at line 117 of file vtkImageActor.h.
| virtual int vtkImageActor::HasTranslucentPolygonalGeometry | ( | ) | [virtual] |
Does this prop have some translucent polygonal geometry?
Reimplemented from vtkProp.
| 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 134 of file vtkImageActor.h.
| int vtkImageActor::GetZSlice | ( | ) | [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 138 of file vtkImageActor.h.
| int vtkImageActor::GetWholeZMin | ( | ) |
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)
| int vtkImageActor::GetWholeZMax | ( | ) |
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)
Member Data Documentation
int vtkImageActor::Interpolate [protected] |
Definition at line 147 of file vtkImageActor.h.
double vtkImageActor::Opacity [protected] |
Definition at line 148 of file vtkImageActor.h.
vtkImageData* vtkImageActor::Input [protected] |
Definition at line 149 of file vtkImageActor.h.
int vtkImageActor::DisplayExtent[6] [protected] |
Definition at line 150 of file vtkImageActor.h.
int vtkImageActor::ComputedDisplayExtent[6] [protected] |
Definition at line 151 of file vtkImageActor.h.
double vtkImageActor::DisplayBounds[6] [protected] |
Definition at line 152 of file vtkImageActor.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkImageActor.h
