Display a 2d image. More...

#include <vtkImageViewer.h>

Inheritance diagram for vtkImageViewer:

Collaboration diagram for vtkImageViewer:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkImageViewer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

char *	GetWindowName ()

virtual void	Render (void)

void	SetupInteractor (vtkRenderWindowInteractor *)


void	SetInputData (vtkImageData *in)

vtkImageData *	GetInput ()

virtual void	SetInputConnection (vtkAlgorithmOutput *input)


int	GetWholeZMin ()

int	GetWholeZMax ()


int	GetZSlice ()

void	SetZSlice (int s)


double	GetColorWindow ()

double	GetColorLevel ()

void	SetColorWindow (double s)

void	SetColorLevel (double s)


void	SetDisplayId (void *a)

void	SetWindowId (void *a)

void	SetParentId (void *a)


int *	GetPosition ()

void	SetPosition (int a, int b)

virtual void	SetPosition (int a[2])


int *	GetSize ()

void	SetSize (int a, int b)

virtual void	SetSize (int a[2])


virtual vtkRenderWindow *	GetRenderWindow ()

virtual vtkRenderer *	GetRenderer ()

virtual vtkImageMapper *	GetImageMapper ()

virtual vtkActor2D *	GetActor2D ()


void	SetOffScreenRendering (int)

int	GetOffScreenRendering ()

void	OffScreenRenderingOn ()

void	OffScreenRenderingOff ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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 vtkImageViewer *	New ()

static int	IsTypeOf (const char *type)

static vtkImageViewer *	SafeDownCast (vtkObjectBase *o)

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

	vtkImageViewer ()

	~vtkImageViewer ()

vtkAlgorithm *	GetInputAlgorithm ()

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
vtkRenderWindow *	RenderWindow

vtkRenderer *	Renderer

vtkImageMapper *	ImageMapper

vtkActor2D *	Actor2D

int	FirstRender

vtkRenderWindowInteractor *	Interactor

vtkInteractorStyleImage *	InteractorStyle

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkImageViewerCallback

Detailed Description

Display a 2d image.

vtkImageViewer is a convenience class for displaying a 2d image. It packages up the functionality found in vtkRenderWindow, vtkRenderer, vtkActor2D and vtkImageMapper into a single easy to use class. Behind the scenes these four classes are actually used to to provide the required functionality. vtkImageViewer is simply a wrapper around them.

See also: vtkRenderWindow vtkRenderer vtkImageMapper vtkActor2D

Examples:: vtkImageViewer (Examples)

Tests:: vtkImageViewer (Tests)

Definition at line 45 of file vtkImageViewer.h.

Member Typedef Documentation

typedef vtkObject vtkImageViewer::Superclass

Definition at line 50 of file vtkImageViewer.h.

Constructor & Destructor Documentation

vtkImageViewer::vtkImageViewer ( )

protected

vtkImageViewer::~vtkImageViewer ( )

protected

Member Function Documentation

static vtkImageViewer* vtkImageViewer::New ( )

static

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

static

virtual int vtkImageViewer::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 vtkObject.

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

static

virtual vtkObjectBase* vtkImageViewer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkImageViewer* vtkImageViewer::NewInstance ( ) const

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

char* vtkImageViewer::GetWindowName ( )

inline

Get name of rendering window

Definition at line 54 of file vtkImageViewer.h.

virtual void vtkImageViewer::Render ( void )

virtual

Render the resulting image.

void vtkImageViewer::SetInputData ( vtkImageData * in )

inline

Set/Get the input to the viewer.

Definition at line 61 of file vtkImageViewer.h.

vtkImageData* vtkImageViewer::GetInput ( )

inline

Set/Get the input to the viewer.

Definition at line 62 of file vtkImageViewer.h.

virtual void vtkImageViewer::SetInputConnection ( vtkAlgorithmOutput * input )

inlinevirtual

Set/Get the input to the viewer.

Definition at line 63 of file vtkImageViewer.h.

int vtkImageViewer::GetWholeZMin ( )

inline

What is the possible Min/ Max z slices available.

Definition at line 69 of file vtkImageViewer.h.

int vtkImageViewer::GetWholeZMax ( )

inline

What is the possible Min/ Max z slices available.

Definition at line 70 of file vtkImageViewer.h.

int vtkImageViewer::GetZSlice ( )

inline

Set/Get the current Z Slice to display

Definition at line 75 of file vtkImageViewer.h.

void vtkImageViewer::SetZSlice ( int s )

inline

Set/Get the current Z Slice to display

Definition at line 76 of file vtkImageViewer.h.

double vtkImageViewer::GetColorWindow ( )

inline

Sets window/level for mapping pixels to colors.

Definition at line 81 of file vtkImageViewer.h.

double vtkImageViewer::GetColorLevel ( )

inline

Sets window/level for mapping pixels to colors.

Definition at line 82 of file vtkImageViewer.h.

void vtkImageViewer::SetColorWindow ( double s )

inline

Sets window/level for mapping pixels to colors.

Definition at line 83 of file vtkImageViewer.h.

void vtkImageViewer::SetColorLevel ( double s )

inline

Sets window/level for mapping pixels to colors.

Definition at line 84 of file vtkImageViewer.h.

void vtkImageViewer::SetDisplayId ( void * a )

inline

These are here for using a tk window.

Definition at line 89 of file vtkImageViewer.h.

void vtkImageViewer::SetWindowId ( void * a )

inline

These are here for using a tk window.

Definition at line 90 of file vtkImageViewer.h.

void vtkImageViewer::SetParentId ( void * a )

inline

These are here for using a tk window.

Definition at line 91 of file vtkImageViewer.h.

int* vtkImageViewer::GetPosition ( )

inline

Set/Get the position in screen coordinates of the rendering window.

Definition at line 96 of file vtkImageViewer.h.

void vtkImageViewer::SetPosition	(	int	a,
		int	b
	)

inline

Set/Get the position in screen coordinates of the rendering window.

Definition at line 97 of file vtkImageViewer.h.

virtual void vtkImageViewer::SetPosition ( int a[2] )

virtual

Set/Get the position in screen coordinates of the rendering window.

int* vtkImageViewer::GetSize ( )

inline

Set/Get the size of the window in screen coordinates in pixels.

Definition at line 103 of file vtkImageViewer.h.

void vtkImageViewer::SetSize	(	int	a,
		int	b
	)

inline

Set/Get the size of the window in screen coordinates in pixels.

Definition at line 104 of file vtkImageViewer.h.

virtual void vtkImageViewer::SetSize ( int a[2] )

virtual

Set/Get the size of the window in screen coordinates in pixels.

virtual vtkRenderWindow* vtkImageViewer::GetRenderWindow ( )

virtual

Get the internal objects

virtual vtkRenderer* vtkImageViewer::GetRenderer ( )

virtual

Get the internal objects

virtual vtkImageMapper* vtkImageViewer::GetImageMapper ( )

virtual

Get the internal objects

virtual vtkActor2D* vtkImageViewer::GetActor2D ( )

virtual

Get the internal objects

void vtkImageViewer::SetupInteractor ( vtkRenderWindowInteractor * )

Create and attach an interactor for this window

void vtkImageViewer::SetOffScreenRendering ( int )

Create a window in memory instead of on the screen. This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

int vtkImageViewer::GetOffScreenRendering ( )

Create a window in memory instead of on the screen. This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

void vtkImageViewer::OffScreenRenderingOn ( )

Create a window in memory instead of on the screen. This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

void vtkImageViewer::OffScreenRenderingOff ( )

Create a window in memory instead of on the screen. This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

vtkAlgorithm* vtkImageViewer::GetInputAlgorithm ( )

protected

Friends And Related Function Documentation

friend class vtkImageViewerCallback

friend

Definition at line 141 of file vtkImageViewer.h.

Member Data Documentation

vtkRenderWindow* vtkImageViewer::RenderWindow

protected

Definition at line 133 of file vtkImageViewer.h.

vtkRenderer* vtkImageViewer::Renderer

protected

Definition at line 134 of file vtkImageViewer.h.

vtkImageMapper* vtkImageViewer::ImageMapper

protected

Definition at line 135 of file vtkImageViewer.h.

vtkActor2D* vtkImageViewer::Actor2D

protected

Definition at line 136 of file vtkImageViewer.h.

int vtkImageViewer::FirstRender

protected

Definition at line 137 of file vtkImageViewer.h.

vtkRenderWindowInteractor* vtkImageViewer::Interactor

protected

Definition at line 138 of file vtkImageViewer.h.

vtkInteractorStyleImage* vtkImageViewer::InteractorStyle

protected

Definition at line 139 of file vtkImageViewer.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Image/vtkImageViewer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation