VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkImageViewer Class Reference

Display a 2d image. More...

#include <vtkImageViewer.h>

Inherits vtkObject.

Collaboration diagram for vtkImageViewer:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImageViewerNewInstance () 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 ()
 

Static Public Member Functions

static vtkImageViewerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageViewerSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkImageViewer ()
 
 ~vtkImageViewer ()
 
vtkAlgorithmGetInputAlgorithm ()
 

Protected Attributes

vtkRenderWindow * RenderWindow
 
vtkRenderer * Renderer
 
vtkImageMapper * ImageMapper
 
vtkActor2D * Actor2D
 
int FirstRender
 
vtkRenderWindowInteractor * Interactor
 
vtkInteractorStyleImageInteractorStyle
 

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 *  type)
virtual
static vtkImageViewer* vtkImageViewer::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageViewer::NewInstanceInternal ( ) const
protectedvirtual
vtkImageViewer* vtkImageViewer::NewInstance ( ) const
void vtkImageViewer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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: