---

vtkImageActor Class Reference

represents an image (data & properties) in a rendered scene. More...

#include <vtkImageActor.h>

Inheritance diagram for vtkImageActor:

[legend]Collaboration diagram for vtkImageActor:

[legend]List of all members.

Public Methods
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 ()
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 ()
float *	GetBounds ()
void	GetBounds (float bounds[6])
int	GetSliceNumber ()
int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual void	Load (vtkRenderer *)
Static Public Methods
int	IsTypeOf (const char *type)
vtkImageActor *	SafeDownCast (vtkObject *o)
vtkImageActor *	New ()
Protected Methods
	vtkImageActor ()
	~vtkImageActor ()
	vtkImageActor (const vtkImageActor &)
void	operator= (const vtkImageActor &)
Protected Attributes
int	Interpolate
vtkImageData *	Input
int	DisplayExtent [6]
float	Bounds [6]

---

Detailed Description

represents an image (data & properties) in a rendered scene.

Date:

2000/12/10 20:08:39

Revision:

1.6

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.

See also:

vtkImageData vtkProp

Examples:

vtkImageActor (examples)

Definition at line 69 of file vtkImageActor.h.

---

Constructor & Destructor Documentation

vtkImageActor::vtkImageActor (    )  [protected]

vtkImageActor::~vtkImageActor (    )  [protected]

vtkImageActor::vtkImageActor (  const vtkImageActor &    )  [inline, protected]

Definition at line 116 of file vtkImageActor.h.

---

Member Function Documentation

virtual const char* vtkImageActor::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 vtkProp. Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProp. 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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProp. Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.

vtkImageActor* vtkImageActor::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 vtkProp. 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 vtkProp.

vtkImageActor* vtkImageActor::New (    )  [static]

Instantiate the image actor. Reimplemented from vtkProp. 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]

virtual int vtkImageActor::GetInterpolate (    )  [virtual]

Turn on/off linear interpolation of the image when rendering.

virtual void vtkImageActor::SetInterpolate (  int    )  [virtual]

virtual void vtkImageActor::InterpolateOn (    )  [virtual]

virtual void vtkImageActor::InterpolateOff (    )  [virtual]

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 )

void vtkImageActor::GetDisplayExtent (  int    extent[6] )

int* vtkImageActor::GetDisplayExtent (    )  [inline]

Definition at line 93 of file vtkImageActor.h.

float* 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). Reimplemented from vtkProp.

void vtkImageActor::GetBounds (  float    bounds[6] )

int vtkImageActor::GetSliceNumber (    )

Return a slice number computed from the display extent.

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. int RenderTranslucentGeometry(vtkViewport *viewport); Reimplemented from vtkProp.

virtual void vtkImageActor::Load (  vtkRenderer *    ren )  [inline, virtual]

Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor. Definition at line 110 of file vtkImageActor.h.

void vtkImageActor::operator= (  const vtkImageActor &    )  [inline, protected]

Definition at line 117 of file vtkImageActor.h.

---

Member Data Documentation

int vtkImageActor::Interpolate [protected]

Definition at line 119 of file vtkImageActor.h.

vtkImageData* vtkImageActor::Input [protected]

Definition at line 120 of file vtkImageActor.h.

int vtkImageActor::DisplayExtent[6] [protected]

Definition at line 121 of file vtkImageActor.h.

float vtkImageActor::Bounds[6] [protected]

Definition at line 122 of file vtkImageActor.h.

---

The documentation for this class was generated from the following file:

• graphics/vtkImageActor.h

---