---

vtkImageViewer Class Reference

Display a 2d image. More...

#include <vtkImageViewer.h>

Inheritance diagram for vtkImageViewer:

[legend]Collaboration diagram for vtkImageViewer:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
char *	GetWindowName ()
virtual void	Render (void)
vtkImageMapper *	GetImageMapper ()
vtkActor2D *	GetActor2D ()
vtkRenderWindow *	GetRenderWindow ()
vtkRenderer *	GetRenderer ()
void	SetInput (vtkImageData *in)
vtkImageData *	GetInput ()
int	GetWholeZMin ()
int	GetWholeZMax ()
int	GetZSlice ()
void	SetZSlice (int s)
float	GetColorWindow ()
float	GetColorLevel ()
void	SetColorWindow (float s)
void	SetColorLevel (float s)
void	SetDisplayId (void *a)
void	SetWindowId (void *a)
void	SetParentId (void *a)
int	GetGrayScaleHint ()
void	SetGrayScaleHint (int a)
void	GrayScaleHintOn ()
void	GrayScaleHintOff ()
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])
vtkImageWindow *	GetImageWindow ()
vtkImager *	GetImager ()
Static Public Methods
vtkImageViewer *	New ()
int	IsTypeOf (const char *type)
vtkImageViewer *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageViewer ()
	~vtkImageViewer ()
Protected Attributes
vtkRenderWindow *	RenderWindow
vtkRenderer *	Renderer
vtkImageMapper *	ImageMapper
vtkActor2D *	Actor2D

---

Detailed Description

Display a 2d image.

Date:

2001/10/17 13:27:35

Revision:

1.44

Thanks:

Thanks to C. Charles Law who developed this class.

vtkImageViewer is a convenience class for displaying a 2d image. It packages up the functionality found in vtkImageWindow, vtkImager, 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:

vtkImageWindow vtkImager vtkImageMapper vtkActor2D

Examples:

vtkImageViewer (Examples)

Tests:

vtkImageViewer (Tests)

Definition at line 71 of file vtkImageViewer.h.

---

Constructor & Destructor Documentation

vtkImageViewer::vtkImageViewer (    )  [protected]

vtkImageViewer::~vtkImageViewer (    )  [protected]

---

Member Function Documentation

vtkImageViewer* vtkImageViewer::New (    )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject.

virtual const char* vtkImageViewer::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 vtkObject.

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

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

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

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 80 of file vtkImageViewer.h.

virtual void vtkImageViewer::Render (  void    )  [virtual]

Render the resulting image.

void vtkImageViewer::SetInput (  vtkImageData *    in )  [inline]

Set/Get the input to the viewer. Definition at line 87 of file vtkImageViewer.h.

vtkImageData* vtkImageViewer::GetInput (    )  [inline]

Set/Get the input to the viewer. Definition at line 88 of file vtkImageViewer.h.

int vtkImageViewer::GetWholeZMin (    )  [inline]

What is the possible Min/ Max z slices available. Definition at line 93 of file vtkImageViewer.h.

int vtkImageViewer::GetWholeZMax (    )  [inline]

What is the possible Min/ Max z slices available. Definition at line 94 of file vtkImageViewer.h.

int vtkImageViewer::GetZSlice (    )  [inline]

Set/Get the current Z Slice to display Definition at line 99 of file vtkImageViewer.h.

void vtkImageViewer::SetZSlice (  int    s )  [inline]

Set/Get the current Z Slice to display Definition at line 100 of file vtkImageViewer.h.

float vtkImageViewer::GetColorWindow (    )  [inline]

Sets window/level for mapping pixels to colors. Definition at line 105 of file vtkImageViewer.h.

float vtkImageViewer::GetColorLevel (    )  [inline]

Sets window/level for mapping pixels to colors. Definition at line 106 of file vtkImageViewer.h.

void vtkImageViewer::SetColorWindow (  float    s )  [inline]

Sets window/level for mapping pixels to colors. Definition at line 107 of file vtkImageViewer.h.

void vtkImageViewer::SetColorLevel (  float    s )  [inline]

Sets window/level for mapping pixels to colors. Definition at line 108 of file vtkImageViewer.h.

void vtkImageViewer::SetDisplayId (  void *    a )  [inline]

These are here for using a tk window. Definition at line 113 of file vtkImageViewer.h.

void vtkImageViewer::SetWindowId (  void *    a )  [inline]

These are here for using a tk window. Definition at line 114 of file vtkImageViewer.h.

void vtkImageViewer::SetParentId (  void *    a )  [inline]

These are here for using a tk window. Definition at line 115 of file vtkImageViewer.h.

int vtkImageViewer::GetGrayScaleHint (    )  [inline]

By default this is a color viewer. GrayScaleHintOn will improve the appearance of gray scale images on some systems. Definition at line 121 of file vtkImageViewer.h.

void vtkImageViewer::SetGrayScaleHint (  int    a )  [inline]

By default this is a color viewer. GrayScaleHintOn will improve the appearance of gray scale images on some systems. Definition at line 123 of file vtkImageViewer.h.

void vtkImageViewer::GrayScaleHintOn (    )  [inline]

By default this is a color viewer. GrayScaleHintOn will improve the appearance of gray scale images on some systems. Definition at line 125 of file vtkImageViewer.h.

void vtkImageViewer::GrayScaleHintOff (    )  [inline]

By default this is a color viewer. GrayScaleHintOn will improve the appearance of gray scale images on some systems. Definition at line 127 of file vtkImageViewer.h.

int* vtkImageViewer::GetPosition (    )  [inline]

Set/Get the position in screen coordinates of the rendering window. Definition at line 133 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 134 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. Definition at line 140 of file vtkImageViewer.h.

void vtkImageViewer::SetSize (  int    a, int    b )  [inline]

Set/Get the size of the window in screen coordinates. Definition at line 141 of file vtkImageViewer.h.

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

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

vtkImageWindow* vtkImageViewer::GetImageWindow (    )  [inline]

Get the internal Window Imager and Mapper Definition at line 147 of file vtkImageViewer.h.

vtkImager* vtkImageViewer::GetImager (    )  [inline]

Get the internal Window Imager and Mapper Definition at line 149 of file vtkImageViewer.h.

vtkImageMapper* vtkImageViewer::GetImageMapper (    )  [inline]

Definition at line 153 of file vtkImageViewer.h.

vtkActor2D* vtkImageViewer::GetActor2D (    )  [inline]

Definition at line 154 of file vtkImageViewer.h.

vtkRenderWindow* vtkImageViewer::GetRenderWindow (    )  [inline]

Definition at line 155 of file vtkImageViewer.h.

vtkRenderer* vtkImageViewer::GetRenderer (    )  [inline]

Definition at line 156 of file vtkImageViewer.h.

---

Member Data Documentation

vtkRenderWindow* vtkImageViewer::RenderWindow [protected]

Definition at line 162 of file vtkImageViewer.h.

vtkRenderer* vtkImageViewer::Renderer [protected]

Definition at line 163 of file vtkImageViewer.h.

vtkImageMapper* vtkImageViewer::ImageMapper [protected]

Definition at line 164 of file vtkImageViewer.h.

vtkActor2D* vtkImageViewer::Actor2D [protected]

Definition at line 165 of file vtkImageViewer.h.

---

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

• Rendering/vtkImageViewer.h

---