vtkImageActor Class Reference

draw an image in a rendered 3D scene More...

#include <vtkImageActor.h>

Inheritance diagram for vtkImageActor:

Collaboration diagram for vtkImageActor:

Public Types
typedef vtkImageSlice	Superclass
Public Types inherited from vtkImageSlice
typedef vtkProp3D	Superclass
Public Types inherited from vtkProp3D
typedef vtkProp	Superclass
Public Types inherited from vtkProp
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkImageActor *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	HasTranslucentPolygonalGeometry ()
virtual void	SetInputData (vtkImageData *)
virtual vtkImageData *	GetInput ()
virtual void	SetInterpolate (int)
virtual int	GetInterpolate ()
virtual void	InterpolateOn ()
virtual void	InterpolateOff ()
virtual void	SetOpacity (double)
virtual double	GetOpacity ()
double	GetOpacityMinValue ()
double	GetOpacityMaxValue ()
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 ()
void	SetZSlice (int z)
int	GetZSlice ()
int	GetWholeZMin ()
int	GetWholeZMax ()
Public Member Functions inherited from vtkImageSlice
vtkImageSlice *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Update ()
unsigned long int	GetMTime ()
unsigned long	GetRedrawMTime ()
void	ShallowCopy (vtkProp *prop)
void	GetImages (vtkPropCollection *)
virtual void	Render (vtkRenderer *)
void	ReleaseGraphicsResources (vtkWindow *win)
void	SetStackedImagePass (int pass)
void	SetMapper (vtkImageMapper3D *mapper)
virtual vtkImageMapper3D *	GetMapper ()
void	SetProperty (vtkImageProperty *property)
virtual vtkImageProperty *	GetProperty ()
double *	GetBounds ()
void	GetBounds (double bounds[6])
double	GetMinXBound ()
double	GetMaxXBound ()
double	GetMinYBound ()
double	GetMaxYBound ()
double	GetMinZBound ()
double	GetMaxZBound ()
virtual int	RenderOverlay (vtkViewport *viewport)
virtual int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	ShallowCopy (vtkProp *prop)
virtual void	SetPosition (double pos[3])
virtual double *	GetPosition ()
virtual void	GetPosition (double data[3])
void	AddPosition (double deltaPosition[3])
void	AddPosition (double deltaX, double deltaY, double deltaZ)
double *	GetCenter ()
double *	GetXRange ()
double *	GetYRange ()
double *	GetZRange ()
double	GetLength ()
void	RotateX (double)
void	RotateY (double)
void	RotateZ (double)
void	RotateWXYZ (double w, double x, double y, double z)
void	SetOrientation (double x, double y, double z)
void	SetOrientation (double orientation[3])
double *	GetOrientationWXYZ ()
void	AddOrientation (double x, double y, double z)
void	AddOrientation (double orentation[3])
void	PokeMatrix (vtkMatrix4x4 *matrix)
void	InitPathTraversal ()
unsigned long int	GetMTime ()
unsigned long int	GetUserTransformMatrixMTime ()
virtual void	ComputeMatrix ()
virtual void	SetPosition (double x, double y, double z)
virtual void	SetOrigin (double x, double y, double z)
virtual void	SetOrigin (const double pos[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double data[3])
virtual void	SetScale (double x, double y, double z)
virtual void	SetScale (double scale[3])
virtual double *	GetScale ()
virtual void	GetScale (double data[3])
void	SetScale (double s)
void	SetUserTransform (vtkLinearTransform *transform)
virtual vtkLinearTransform *	GetUserTransform ()
void	SetUserMatrix (vtkMatrix4x4 *matrix)
vtkMatrix4x4 *	GetUserMatrix ()
virtual void	GetMatrix (vtkMatrix4x4 *m)
virtual void	GetMatrix (double m[16])
void	GetBounds (double bounds[6])
double *	GetOrientation ()
void	GetOrientation (double orentation[3])
vtkMatrix4x4 *	GetMatrix ()
virtual int	GetIsIdentity ()
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
virtual void	Pick ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
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 vtkAssemblyPath *	GetNextPath ()
virtual int	GetNumberOfPaths ()
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkInformation *	GetPropertyKeys ()
virtual void	SetPropertyKeys (vtkInformation *keys)
virtual int	RenderVolumetricGeometry (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)
vtkObject *	GetConsumer (int i)
int	IsConsumer (vtkObject *c)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
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 vtkImageActor *	SafeDownCast (vtkObjectBase *o)
static vtkImageActor *	New ()
Static Public Member Functions inherited from vtkImageSlice
static int	IsTypeOf (const char *type)
static vtkImageSlice *	SafeDownCast (vtkObjectBase *o)
static vtkImageSlice *	New ()
Static Public Member Functions inherited from vtkProp3D
static int	IsTypeOf (const char *type)
static vtkProp3D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageActor ()
	~vtkImageActor ()
vtkAlgorithm *	GetInputAlgorithm ()
Protected Member Functions inherited from vtkImageSlice
	vtkImageSlice ()
	~vtkImageSlice ()
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static int	GetOrientationFromExtent (const int extent[6])

Protected Attributes
int	DisplayExtent [6]
double	DisplayBounds [6]
Protected Attributes inherited from vtkImageSlice
vtkImageMapper3D *	Mapper
vtkImageProperty *	Property
Protected Attributes inherited from vtkProp3D
vtkLinearTransform *	UserTransform
vtkMatrix4x4 *	UserMatrix
vtkMatrix4x4 *	Matrix
vtkTimeStamp	MatrixMTime
double	Origin [3]
double	Position [3]
double	Orientation [3]
double	Scale [3]
double	Center [3]
vtkTransform *	Transform
double	Bounds [6]
vtkProp3D *	CachedProp3D
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
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

draw an image 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. This class has been mostly superseded by the vtkImageSlice class, which provides more functionality than vtkImageActor.

See also

vtkImageData vtkImageSliceMapper vtkImageProperty

Examples:

vtkImageActor (Examples)

Tests:

vtkImageActor (Tests)

Definition at line 48 of file vtkImageActor.h.

Member Typedef Documentation

typedef vtkImageSlice vtkImageActor::Superclass

Definition at line 51 of file vtkImageActor.h.

Constructor & Destructor Documentation

vtkImageActor::vtkImageActor ( )

protected

vtkImageActor::~vtkImageActor ( )

protected

Member Function Documentation

static int vtkImageActor::IsTypeOf ( const char *  type )

static

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 vtkImageSlice.

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

static

virtual vtkObjectBase* vtkImageActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageSlice.

vtkImageActor* vtkImageActor::NewInstance

(

)

const

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 vtkObject.

static vtkImageActor* vtkImageActor::New ( )

static

Instantiate the image actor.

virtual void vtkImageActor::SetInputData ( vtkImageData *  )

virtual

Set/Get the image data input for the image actor. This is for backwards compatibility, for a proper pipeline connection you should use GetMapper()->SetInputConnection() instead.

virtual vtkImageData* vtkImageActor::GetInput ( )

virtual

Set/Get the image data input for the image actor. This is for backwards compatibility, for a proper pipeline connection you should use GetMapper()->SetInputConnection() instead.

virtual void vtkImageActor::SetInterpolate ( int  )

virtual

Turn on/off linear interpolation of the image when rendering. More options are available in the Property of the image actor.

virtual int vtkImageActor::GetInterpolate ( )

virtual

Turn on/off linear interpolation of the image when rendering. More options are available in the Property of the image actor.

virtual void vtkImageActor::InterpolateOn ( )

virtual

Turn on/off linear interpolation of the image when rendering. More options are available in the Property of the image actor.

virtual void vtkImageActor::InterpolateOff ( )

virtual

Turn on/off linear interpolation of the image when rendering. More options are available in the Property of the image actor.

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.

double vtkImageActor::GetOpacityMinValue ( )

inline

Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

Definition at line 78 of file vtkImageActor.h.

double vtkImageActor::GetOpacityMaxValue ( )

inline

Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

Definition at line 79 of file vtkImageActor.h.

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 89 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).

Definition at line 98 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.

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 125 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 129 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)

virtual int vtkImageActor::HasTranslucentPolygonalGeometry ( )

virtual

Internal method, should only be used by rendering. Does this prop have some translucent polygonal geometry?

Reimplemented from vtkImageSlice.

static int vtkImageActor::GetOrientationFromExtent ( const int  extent[6] )

staticprotected

Guess the orientation from the extent. The orientation will be Z unless the extent is single-slice in one of the other directions.

vtkAlgorithm* vtkImageActor::GetInputAlgorithm ( )

protected

Member Data Documentation

int vtkImageActor::DisplayExtent[6]

protected

Definition at line 146 of file vtkImageActor.h.

double vtkImageActor::DisplayBounds[6]

protected

Definition at line 147 of file vtkImageActor.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkImageActor.h