Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImageWindow Class Reference

a 2D display window. More...

#include <vtkImageWindow.h>

Inheritance diagram for vtkImageWindow:

Inheritance graph
[legend]
Collaboration diagram for vtkImageWindow:

Collaboration graph
[legend]
List of all members.

Public Methods

void PrintSelf (ostream &os, vtkIndent indent)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void SetPosition (int x, int y)=0
virtual void SetPosition (int a[2])
virtual int * GetPosition ()=0
virtual void GetPosition (int *x, int *y)
virtual void SetSize (int, int)=0
virtual void SetSize (int a[2])
virtual int * GetSize ()=0
virtual void GetSize (int *x, int *y)
virtual void SetDisplayId (void *)=0
virtual void SetWindowId (void *)=0
virtual void SetParentId (void *)=0
virtual void * GetGenericDisplayId ()=0
virtual void * GetGenericWindowId ()=0
virtual void * GetGenericParentId ()=0
virtual void * GetGenericContext ()=0
virtual void * GetGenericDrawable ()
virtual void SwapBuffers ()=0
virtual void Frame ()=0
virtual void SetWindowInfo (char *)
virtual void SetGrayScaleHint (int)
virtual int GetGrayScaleHint ()
virtual void GrayScaleHintOn ()
virtual void GrayScaleHintOff ()
void AddImager (vtkImager *im)
vtkImagerCollectionGetImagers ()
void RemoveImager (vtkImager *im)
virtual void Render ()
virtual void EraseWindow ()
virtual void SaveImageAsPPM ()
virtual int OpenPPMImageFile ()
virtual void WritePPMImageFile ()
virtual void ClosePPMImageFile ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void MakeCurrent ()

Static Public Methods

vtkImageWindow * New ()
int IsTypeOf (const char *type)
vtkImageWindow * SafeDownCast (vtkObject *o)

Protected Methods

 vtkImageWindow ()
 ~vtkImageWindow ()
 vtkImageWindow (const vtkImageWindow &)
void operator= (const vtkImageWindow &)
virtual void MakeDefaultWindow ()=0

Protected Attributes

vtkImagerCollectionImagers
int WindowCreated
int GrayScaleHint
char * FileName
FILE * PPMImageFilePtr

Detailed Description

a 2D display window.

Date:
2000/12/10 20:09:11
Revision:
1.24
Thanks:
Thanks to Matt Turek who developed this class.
vtkImageWindow contains 2D rendering in vtk. Typically a vtkImageWindow has some vtkImagers within it. The imagers in turn display images, Text etc. The concept is very similar to that of a RenderWindow for 3d.

See also:
vtkImager vtkWindow vtkRenderWindow
Examples:
vtkImageWindow (examples)

Definition at line 68 of file vtkImageWindow.h.


Constructor & Destructor Documentation

vtkImageWindow::vtkImageWindow   [protected]
 

vtkImageWindow::~vtkImageWindow   [protected]
 

vtkImageWindow::vtkImageWindow const vtkImageWindow &    [inline, protected]
 

Definition at line 157 of file vtkImageWindow.h.


Member Function Documentation

vtkImageWindow* vtkImageWindow::New   [static]
 

Creates a vtkImageWindow with background erasing disabled and gray scale hint off

Reimplemented from vtkObject.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

void vtkImageWindow::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 vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual const char* vtkImageWindow::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 vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

int vtkImageWindow::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 vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual int vtkImageWindow::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 vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

vtkImageWindow* vtkImageWindow::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 vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkImageWindow::SetPosition int    x,
int    y
[pure virtual]
 

Set the position of the window on the screen

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkXImageWindow::SetPosition().

virtual void vtkImageWindow::SetPosition int    a[2] [inline, virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkXImageWindow.

Definition at line 80 of file vtkImageWindow.h.

virtual int* vtkImageWindow::GetPosition   [pure virtual]
 

Get the position of the window on the screen

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkXImageWindow::GetPosition().

virtual void vtkImageWindow::GetPosition int *    x,
int *    y
[virtual]
 

Reimplemented in vtkXImageWindow.

virtual void vtkImageWindow::SetSize int    x,
int    y
[pure virtual]
 

Sets the size of a window in pixels.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkXImageWindow::SetSize().

virtual void vtkImageWindow::SetSize int    a[2] [inline, virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkXImageWindow.

Definition at line 88 of file vtkImageWindow.h.

virtual int* vtkImageWindow::GetSize   [pure virtual]
 

Returns the size of a window in pixels

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkXImageWindow::GetSize().

virtual void vtkImageWindow::GetSize int *    x,
int *    y
[virtual]
 

Reimplemented in vtkXImageWindow.

virtual void vtkImageWindow::SetDisplayId void *    foo [pure virtual]
 

These are here for using a tk window.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkImageWindow::SetWindowId void *    foo [pure virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkWin32OpenGLImageWindow::SetWindowId().

virtual void vtkImageWindow::SetParentId void *    foo [pure virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkWin32OpenGLImageWindow::SetParentId().

virtual void* vtkImageWindow::GetGenericDisplayId   [pure virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkImageWindow::GetGenericWindowId   [pure virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkImageWindow::GetGenericParentId   [pure virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkImageWindow::GetGenericContext   [pure virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkImageWindow::GetGenericDrawable   [inline, virtual]
 

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, and vtkXImageWindow.

Definition at line 102 of file vtkImageWindow.h.

virtual void vtkImageWindow::SwapBuffers   [pure virtual]
 

Swap the front and back buffers. This function is used to implement double buffering. The user shouldn't need to call this function. To enable double buffering, invoke DoubleBufferOn

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkImageWindow::Frame void    [pure virtual]
 

Flush the buffer and swap if necessary.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkImageWindow::SetWindowInfo char *    info [inline, virtual]
 

useful for scripting languages

Reimplemented from vtkWindow.

Definition at line 113 of file vtkImageWindow.h.

virtual void vtkImageWindow::SetGrayScaleHint int    [virtual]
 

By default this is a color viewer. GrayScaleHintOn will improve the appearance of gray scale images on some systems.

virtual int vtkImageWindow::GetGrayScaleHint   [virtual]
 

virtual void vtkImageWindow::GrayScaleHintOn   [virtual]
 

virtual void vtkImageWindow::GrayScaleHintOff   [virtual]
 

void vtkImageWindow::AddImager vtkImager   im
 

Add an imager to the window's list of imagers to be rendered.

vtkImagerCollection* vtkImageWindow::GetImagers   [inline]
 

Return the collection of imagers for this window.

Definition at line 126 of file vtkImageWindow.h.

void vtkImageWindow::RemoveImager vtkImager   im
 

Remove an imager from the window

virtual void vtkImageWindow::Render void    [virtual]
 

Draw the contents of the window

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, and vtkWin32OpenGLImageWindow.

virtual void vtkImageWindow::EraseWindow   [virtual]
 

Erase the window contents

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, and vtkXImageWindow.

Referenced by vtkOpenGLImageWindow::EraseWindow(), and vtkMesaImageWindow::EraseWindow().

virtual void vtkImageWindow::SaveImageAsPPM   [virtual]
 

Save the current image as a PPM file.

virtual int vtkImageWindow::OpenPPMImageFile   [virtual]
 

Open/Write/Close a PPM file

virtual void vtkImageWindow::WritePPMImageFile   [virtual]
 

virtual void vtkImageWindow::ClosePPMImageFile   [virtual]
 

virtual void vtkImageWindow::SetFileName const char *    [virtual]
 

Set/Get the FileName used for saving images. See the SaveImageAsPPM method.

virtual char* vtkImageWindow::GetFileName   [virtual]
 

virtual void vtkImageWindow::MakeCurrent   [inline, virtual]
 

Make this window current. Overridden in subclasses to do, for example, glXMakeCurrent or wglMakeCurrent

Reimplemented from vtkWindow.

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, and vtkWin32OpenGLImageWindow.

Definition at line 152 of file vtkImageWindow.h.

void vtkImageWindow::operator= const vtkImageWindow &    [inline, protected]
 

Definition at line 158 of file vtkImageWindow.h.

virtual void vtkImageWindow::MakeDefaultWindow   [protected, pure virtual]
 

Reimplemented in vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.


Member Data Documentation

vtkImagerCollection* vtkImageWindow::Imagers [protected]
 

Definition at line 160 of file vtkImageWindow.h.

int vtkImageWindow::WindowCreated [protected]
 

Definition at line 161 of file vtkImageWindow.h.

int vtkImageWindow::GrayScaleHint [protected]
 

Definition at line 162 of file vtkImageWindow.h.

char* vtkImageWindow::FileName [protected]
 

Definition at line 164 of file vtkImageWindow.h.

FILE* vtkImageWindow::PPMImageFilePtr [protected]
 

Definition at line 165 of file vtkImageWindow.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:49:08 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001