VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageActor Class Reference

draw an image (data & properties) in a rendered 3D scene More...

#include <vtkImageActor.h>

Inheritance diagram for vtkImageActor:
[legend]
Collaboration diagram for vtkImageActor:
[legend]

List of all members.

Public Types

typedef vtkProp3D Superclass
- Public Types inherited from vtkProp3D
- Public Types inherited from vtkProp
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (vtkImageData *)
virtual vtkImageDataGetInput ()
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 ()
- Public Member Functions inherited from vtkProp3D
void ShallowCopy (vtkProp *prop)
void SetScale (double s)
double * GetCenter ()
double * GetXRange ()
double * GetYRange ()
double * GetZRange ()
double GetLength ()
void RotateX (double)
void RotateY (double)
void RotateZ (double)
void RotateWXYZ (double, double, double, double)
void SetOrientation (double, double, double)
void SetOrientation (double a[3])
double * GetOrientationWXYZ ()
void AddOrientation (double, double, double)
void AddOrientation (double a[3])
void PokeMatrix (vtkMatrix4x4 *matrix)
void InitPathTraversal ()
unsigned long int GetMTime ()
unsigned long int GetUserTransformMatrixMTime ()
virtual void ComputeMatrix ()
virtual void SetPosition (double _arg1, double _arg2, double _arg3)
virtual void SetPosition (double _arg[3])
virtual double * GetPosition ()
virtual void GetPosition (double data[3])
void AddPosition (double deltaPosition[3])
void AddPosition (double deltaX, double deltaY, double deltaZ)
virtual void SetOrigin (double _arg1, double _arg2, double _arg3)
virtual void SetOrigin (double _arg[3])
virtual double * GetOrigin ()
virtual void GetOrigin (double data[3])
virtual void SetScale (double _arg1, double _arg2, double _arg3)
virtual void SetScale (double _arg[3])
virtual double * GetScale ()
virtual void GetScale (double data[3])
void SetUserTransform (vtkLinearTransform *transform)
virtual vtkLinearTransformGetUserTransform ()
void SetUserMatrix (vtkMatrix4x4 *matrix)
vtkMatrix4x4GetUserMatrix ()
virtual void GetMatrix (vtkMatrix4x4 *m)
virtual void GetMatrix (double m[16])
double * GetOrientation ()
void GetOrientation (double o[3])
vtkMatrix4x4GetMatrix ()
virtual int GetIsIdentity ()
- Public Member Functions inherited from vtkProp
virtual void Pick ()
virtual unsigned long GetRedrawMTime ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void GetActors (vtkPropCollection *)
virtual void GetActors2D (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()
virtual void SetPickable (int)
virtual int GetPickable ()
virtual void PickableOn ()
virtual void PickableOff ()
virtual void SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
virtual void SetUseBounds (bool)
virtual bool GetUseBounds ()
virtual void UseBoundsOn ()
virtual void UseBoundsOff ()
virtual vtkAssemblyPathGetNextPath ()
virtual int GetNumberOfPaths ()
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkInformationGetPropertyKeys ()
virtual void SetPropertyKeys (vtkInformation *keys)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual int RenderOverlay (vtkViewport *)
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double GetEstimatedRenderTime (vtkViewport *)
virtual double GetEstimatedRenderTime ()
virtual void SetEstimatedRenderTime (double t)
virtual void RestoreEstimatedRenderTime ()
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double GetAllocatedRenderTime ()
void SetRenderTimeMultiplier (double t)
virtual double GetRenderTimeMultiplier ()
virtual bool GetSupportsSelection ()
virtual int GetNumberOfConsumers ()
void AddConsumer (vtkObject *c)
void RemoveConsumer (vtkObject *c)
vtkObjectGetConsumer (int i)
int IsConsumer (vtkObject *c)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImageActorSafeDownCast (vtkObject *o)
static vtkImageActorNew ()

Protected Member Functions

 vtkImageActor ()
 ~vtkImageActor ()
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 ~vtkProp3D ()
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 ~vtkProp ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int Interpolate
double Opacity
vtkImageDataInput
int DisplayExtent [6]
int ComputedDisplayExtent [6]
double DisplayBounds [6]
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
vtkMatrix4x4UserMatrix
vtkMatrix4x4Matrix
vtkTimeStamp MatrixMTime
double Origin [3]
double Position [3]
double Orientation [3]
double Scale [3]
double Center [3]
vtkTransformTransform
double Bounds [6]
vtkProp3DCachedProp3D
int IsIdentity
- Protected Attributes inherited from vtkProp
int Visibility
int Pickable
int Dragable
bool UseBounds
double AllocatedRenderTime
double EstimatedRenderTime
double SavedEstimatedRenderTime
double RenderTimeMultiplier
int NumberOfConsumers
vtkObject ** Consumers
vtkAssemblyPathsPaths
vtkInformationPropertyKeys
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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
Examples:
vtkImageActor (Examples)
Tests:
vtkImageActor (Tests)

Definition at line 49 of file vtkImageActor.h.


Member Typedef Documentation

Reimplemented from vtkProp3D.

Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.

Definition at line 52 of file vtkImageActor.h.


Constructor & Destructor Documentation

vtkImageActor::vtkImageActor ( )
protected
vtkImageActor::~vtkImageActor ( )
protected

Member Function Documentation

virtual const char* vtkImageActor::GetClassName ( )
virtual

Reimplemented from vtkProp3D.

Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

Reimplemented in vtkMesaImageActor, and vtkOpenGLImageActor.

static vtkImageActor* vtkImageActor::SafeDownCast ( vtkObject o)
static

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.

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 85 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 94 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 )
inlinevirtual

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 120 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 137 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 141 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 150 of file vtkImageActor.h.

double vtkImageActor::Opacity
protected

Definition at line 151 of file vtkImageActor.h.

vtkImageData* vtkImageActor::Input
protected

Definition at line 152 of file vtkImageActor.h.

int vtkImageActor::DisplayExtent[6]
protected

Definition at line 153 of file vtkImageActor.h.

int vtkImageActor::ComputedDisplayExtent[6]
protected

Definition at line 154 of file vtkImageActor.h.

double vtkImageActor::DisplayBounds[6]
protected

Definition at line 155 of file vtkImageActor.h.


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