represents an image in a 3D scene More...

#include <vtkImageSlice.h>

Inheritance diagram for vtkImageSlice:

Collaboration diagram for vtkImageSlice:

Public Types
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)

vtkImageSlice *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetMapper (vtkImageMapper3D *mapper)

virtual vtkImageMapper3D *	GetMapper ()

void	SetProperty (vtkImageProperty *property)

virtual vtkImageProperty *	GetProperty ()

void	Update ()

double *	GetBounds ()

void	GetBounds (double bounds[6])

double	GetMinXBound ()

double	GetMaxXBound ()

double	GetMinYBound ()

double	GetMaxYBound ()

double	GetMinZBound ()

double	GetMaxZBound ()

unsigned long int	GetMTime ()

unsigned long	GetRedrawMTime ()

void	ShallowCopy (vtkProp *prop)

void	GetImages (vtkPropCollection *)

virtual int	RenderOverlay (vtkViewport *viewport)

virtual int	RenderOpaqueGeometry (vtkViewport *viewport)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

virtual int	HasTranslucentPolygonalGeometry ()

virtual void	Render (vtkRenderer *)

void	ReleaseGraphicsResources (vtkWindow *win)

void	SetStackedImagePass (int pass)

Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	ShallowCopy (vtkProp *prop)

virtual void	SetPosition (double x, double y, double z)

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)

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 *	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 *	GetOrientation ()

void	GetOrientation (double orentation[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 ()

vtkMatrix4x4 *	GetMatrix ()

virtual int	GetIsIdentity ()

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

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	Pick ()

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 bool	HasKeys (vtkInformation *requiredKeys)

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 void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

int	GetReferenceCount ()

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

Static Public Member Functions
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

	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 &)

Protected Attributes
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

represents an image in a 3D scene

vtkImageSlice is used to represent an image in a 3D scene. It displays the image either as a slice or as a projection from the camera's perspective. Adjusting the position and orientation of the slice is done by adjusting the focal point and direction of the camera, or alternatively the slice can be set manually in vtkImageMapper3D. The lookup table and window/leve are set in vtkImageProperty. Prop3D methods such as SetPosition() and RotateWXYZ() change the position and orientation of the data with respect to VTK world coordinates.

Thanks:: Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.

See also: vtkImageMapper3D vtkImageProperty vtkProp3D

Examples:: vtkImageSlice (Examples)

Tests:: vtkImageSlice (Tests)

Definition at line 51 of file vtkImageSlice.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp3D vtkImageSlice::Superclass

Definition at line 54 of file vtkImageSlice.h.

Constructor & Destructor Documentation

◆ vtkImageSlice()

vtkImageSlice::vtkImageSlice ( )

protected

◆ ~vtkImageSlice()

vtkImageSlice::~vtkImageSlice ( )

protected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkImageSlice::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 vtkImageStack, and vtkImageActor.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageSlice::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

Reimplemented in vtkImageStack, and vtkImageActor.

◆ NewInstance()

vtkImageSlice* vtkImageSlice::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkImageStack.

◆ New()

static vtkImageSlice* vtkImageSlice::New ( )

static

Creates an Image with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pickable=1 dragable=1 orientation=(0,0,0).

◆ SetMapper()

void vtkImageSlice::SetMapper ( vtkImageMapper3D * mapper )

Set/Get the mapper.

◆ GetMapper()

virtual vtkImageMapper3D* vtkImageSlice::GetMapper ( )

virtual

Reimplemented in vtkImageStack.

◆ SetProperty()

void vtkImageSlice::SetProperty ( vtkImageProperty * property )

Set/Get the image display properties.

◆ GetProperty()

virtual vtkImageProperty* vtkImageSlice::GetProperty ( )

virtual

Reimplemented in vtkImageStack.

◆ Update()

void vtkImageSlice::Update ( )

Update the rendering pipeline by updating the ImageMapper

◆ GetBounds() [1/2]

double* vtkImageSlice::GetBounds ( )

virtual

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

Implements vtkProp3D.

Reimplemented in vtkImageStack.

◆ GetBounds() [2/2]

void vtkImageSlice::GetBounds ( double bounds[6] )

inline

Definition at line 81 of file vtkImageSlice.h.

◆ GetMinXBound()

double vtkImageSlice::GetMinXBound ( )

◆ GetMaxXBound()

double vtkImageSlice::GetMaxXBound ( )

◆ GetMinYBound()

double vtkImageSlice::GetMinYBound ( )

◆ GetMaxYBound()

double vtkImageSlice::GetMaxYBound ( )

◆ GetMinZBound()

double vtkImageSlice::GetMinZBound ( )

◆ GetMaxZBound()

double vtkImageSlice::GetMaxZBound ( )

◆ GetMTime()

unsigned long int vtkImageSlice::GetMTime ( )

virtual

Return the MTime also considering the property etc.

Reimplemented from vtkObject.

Reimplemented in vtkImageStack.

◆ GetRedrawMTime()

unsigned long vtkImageSlice::GetRedrawMTime ( )

virtual

Return the mtime of anything that would cause the rendered image to appear differently. Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, mappers, etc.

Reimplemented from vtkProp.

Reimplemented in vtkImageStack.

◆ ShallowCopy()

void vtkImageSlice::ShallowCopy ( vtkProp * prop )

virtual

Shallow copy of this vtkImageSlice. Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

Reimplemented in vtkImageStack.

◆ GetImages()

void vtkImageSlice::GetImages ( vtkPropCollection * )

For some exporters and other other operations we must be able to collect all the actors, volumes, and images. These methods are used in that process.

◆ RenderOverlay()

virtual int vtkImageSlice::RenderOverlay ( vtkViewport * viewport )

virtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkImageStack.

◆ RenderOpaqueGeometry()

virtual int vtkImageSlice::RenderOpaqueGeometry ( vtkViewport * )

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented from vtkProp.

Reimplemented in vtkImageStack.

◆ RenderTranslucentPolygonalGeometry()

virtual int vtkImageSlice::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

virtual

Reimplemented from vtkProp.

Reimplemented in vtkImageStack.

◆ HasTranslucentPolygonalGeometry()

virtual int vtkImageSlice::HasTranslucentPolygonalGeometry ( )

virtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

Reimplemented in vtkImageStack, and vtkImageActor.

◆ Render()

virtual void vtkImageSlice::Render ( vtkRenderer * )

virtual

This causes the image and its mapper to be rendered. Note that a side effect of this method is that the pipeline will be updated.

◆ ReleaseGraphicsResources()

void vtkImageSlice::ReleaseGraphicsResources ( vtkWindow * win )

virtual

Release any resources held by this prop.

Reimplemented from vtkProp.

Reimplemented in vtkImageStack.

◆ SetStackedImagePass()

void vtkImageSlice::SetStackedImagePass ( int pass )

For stacked image rendering, set the pass. The first pass renders just the backing polygon, the second pass renders the image, and the third pass renders the depth buffer. Set to -1 to render all of these in the same pass.

Member Data Documentation

◆ Mapper

vtkImageMapper3D* vtkImageSlice::Mapper

protected

Definition at line 135 of file vtkImageSlice.h.

◆ Property

vtkImageProperty* vtkImageSlice::Property

protected

Definition at line 136 of file vtkImageSlice.h.

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

dox/opt/build/vtk6-6.3.0+dfsg2/Rendering/Core/vtkImageSlice.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkImageSlice()

◆ ~vtkImageSlice()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetMapper()

◆ GetMapper()

◆ SetProperty()

◆ GetProperty()

◆ Update()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetMinXBound()

◆ GetMaxXBound()

◆ GetMinYBound()

◆ GetMaxYBound()

◆ GetMinZBound()

◆ GetMaxZBound()

◆ GetMTime()

◆ GetRedrawMTime()

◆ ShallowCopy()

◆ GetImages()

◆ RenderOverlay()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ HasTranslucentPolygonalGeometry()

◆ Render()

◆ ReleaseGraphicsResources()

◆ SetStackedImagePass()

Member Data Documentation

◆ Mapper

◆ Property