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

vtkWindow Class Reference

window superclass for ImageWindow and RenderWindow. More...

#include <vtkWindow.h>

Inheritance diagram for vtkWindow:

Inheritance graph
[legend]
Collaboration diagram for vtkWindow:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
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 ()=0
virtual void SetWindowInfo (char *)=0
virtual int * GetPosition ()
virtual void SetPosition (int, int)
virtual void SetPosition (int a[2])
virtual int * GetSize ()
virtual void SetSize (int, int)
virtual void SetSize (int a[2])
virtual void SetMapped (int)
virtual int GetMapped ()
virtual void MappedOn ()
virtual void MappedOff ()
virtual void SetErase (int)
virtual int GetErase ()
virtual void EraseOn ()
virtual void EraseOff ()
virtual void SetDoubleBuffer (int)
virtual int GetDoubleBuffer ()
virtual void DoubleBufferOn ()
virtual void DoubleBufferOff ()
virtual char * GetWindowName ()
virtual void SetWindowName (char *)
virtual void Render ()=0
virtual unsigned char * GetPixelData (int, int, int, int, int)
virtual int GetDPI ()
virtual void SetDPI (int)
virtual void SetOffScreenRendering (int)
virtual int GetOffScreenRendering ()
virtual void OffScreenRenderingOn ()
virtual void OffScreenRenderingOff ()
virtual void MakeCurrent ()

Static Public Methods

int IsTypeOf (const char *type)
vtkWindow * SafeDownCast (vtkObject *o)

Protected Methods

 vtkWindow ()
 ~vtkWindow ()
 vtkWindow (const vtkWindow &)
void operator= (const vtkWindow &)

Protected Attributes

int OffScreenRendering
char * WindowName
int Size [2]
int Position [2]
int Mapped
int Erase
int DoubleBuffer
int DPI

Detailed Description

window superclass for ImageWindow and RenderWindow.

Date:
2000/12/10 20:08:22
Revision:
1.19

vtkWindow is an abstract object to specify the behavior of a rendering or imaging window. It contains vtkViewports.

See also:
vtkImageWindow vtkRenderWindow vtkViewport

Definition at line 58 of file vtkWindow.h.


Constructor & Destructor Documentation

vtkWindow::vtkWindow   [protected]
 

vtkWindow::~vtkWindow   [protected]
 

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

Definition at line 143 of file vtkWindow.h.


Member Function Documentation

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

Reimplemented in vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

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

Reimplemented in vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

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

Reimplemented in vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

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

Reimplemented in vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

void vtkWindow::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 vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

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

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented in vtkWin32OffscreenRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkWindow::SetWindowId void *    id [pure virtual]
 

Reimplemented in vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkWindow::SetParentId void *    id [pure virtual]
 

Reimplemented in vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkWindow::GetGenericDisplayId   [pure virtual]
 

Reimplemented in vtkWin32OffscreenRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkWindow::GetGenericWindowId   [pure virtual]
 

Reimplemented in vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkWindow::GetGenericParentId   [pure virtual]
 

Reimplemented in vtkWin32OffscreenRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkWindow::GetGenericContext   [pure virtual]
 

Reimplemented in vtkMesaRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void* vtkWindow::GetGenericDrawable   [pure virtual]
 

Reimplemented in vtkRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, and vtkXImageWindow.

virtual void vtkWindow::SetWindowInfo char *    info [pure virtual]
 

Reimplemented in vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, and vtkImageWindow.

virtual int* vtkWindow::GetPosition   [virtual]
 

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

Reimplemented in vtkWin32OffscreenRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkWindow::SetPosition int    x,
int    y
[virtual]
 

Reimplemented in vtkWin32OffscreenRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkImageWindow::SetPosition(), and vtkXRenderWindow::SetPosition().

virtual void vtkWindow::SetPosition int    a[2] [virtual]
 

Reimplemented in vtkXRenderWindow, vtkImageWindow, and vtkXImageWindow.

virtual int* vtkWindow::GetSize   [virtual]
 

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

Reimplemented in vtkWin32OffscreenRenderWindow, vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkWindow::SetSize int    x,
int    y
[virtual]
 

Reimplemented in vtkWin32OffscreenRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Referenced by vtkImageWindow::SetSize(), vtkOpenGLRenderWindow::SetSize(), and vtkMesaRenderWindow::SetSize().

virtual void vtkWindow::SetSize int    a[2] [virtual]
 

Reimplemented in vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkImageWindow, and vtkXImageWindow.

virtual void vtkWindow::SetMapped int    [virtual]
 

Keep track of whether the rendering window has been mapped to screen.

virtual int vtkWindow::GetMapped   [virtual]
 

virtual void vtkWindow::MappedOn   [virtual]
 

virtual void vtkWindow::MappedOff   [virtual]
 

virtual void vtkWindow::SetErase int    [virtual]
 

Turn on/off erasing the screen between images. This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to prevent you from swapping buffers between exposures.

virtual int vtkWindow::GetErase   [virtual]
 

virtual void vtkWindow::EraseOn   [virtual]
 

virtual void vtkWindow::EraseOff   [virtual]
 

virtual void vtkWindow::SetDoubleBuffer int    [virtual]
 

Keep track of whether double buffering is on or off

virtual int vtkWindow::GetDoubleBuffer   [virtual]
 

virtual void vtkWindow::DoubleBufferOn   [virtual]
 

virtual void vtkWindow::DoubleBufferOff   [virtual]
 

virtual char* vtkWindow::GetWindowName   [virtual]
 

Get name of rendering window

virtual void vtkWindow::SetWindowName char *    name [virtual]
 

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXRenderWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

virtual void vtkWindow::Render   [pure virtual]
 

Ask each viewport owned by this Window to render its image and synchronize this process.

Reimplemented in vtkRenderWindow, vtkXRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, and vtkWin32OpenGLImageWindow.

virtual unsigned char* vtkWindow::GetPixelData int    x,
int    y,
int    x2,
int    y2,
int    front
[inline, virtual]
 

Get the pixel data of an image, transmitted as RGBRGBRGB. The front argument indicates if the front buffer should be used or the back buffer. It is the caller's responsibility to delete the resulting array. It is very important to realize that the memory in this array is organized from the bottom of the window to the top. The origin of the screen is in the lower left corner. The y axis increases as you go up the screen. So the storage of pixels is from left to right and from bottom to top.

Reimplemented in vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.

Definition at line 120 of file vtkWindow.h.

virtual int vtkWindow::GetDPI   [virtual]
 

Return a best estimate to the dots per inch of the display device being rendered (or printed).

virtual void vtkWindow::SetDPI int    [virtual]
 

virtual void vtkWindow::SetOffScreenRendering int    i [virtual]
 

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.

Reimplemented in vtkMesaRenderWindow, and vtkMesaImageWindow.

virtual int vtkWindow::GetOffScreenRendering   [virtual]
 

virtual void vtkWindow::OffScreenRenderingOn   [virtual]
 

virtual void vtkWindow::OffScreenRenderingOff   [virtual]
 

virtual void vtkWindow::MakeCurrent   [inline, virtual]
 

Make the window current. May be overridden in subclasses to do for example a glXMakeCurrent or a wglMakeCurrent.

Reimplemented in vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, and vtkWin32OpenGLImageWindow.

Definition at line 137 of file vtkWindow.h.

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

Definition at line 144 of file vtkWindow.h.


Member Data Documentation

int vtkWindow::OffScreenRendering [protected]
 

Definition at line 140 of file vtkWindow.h.

char* vtkWindow::WindowName [protected]
 

Definition at line 146 of file vtkWindow.h.

int vtkWindow::Size[2] [protected]
 

Definition at line 147 of file vtkWindow.h.

int vtkWindow::Position[2] [protected]
 

Definition at line 148 of file vtkWindow.h.

int vtkWindow::Mapped [protected]
 

Definition at line 149 of file vtkWindow.h.

int vtkWindow::Erase [protected]
 

Definition at line 150 of file vtkWindow.h.

int vtkWindow::DoubleBuffer [protected]
 

Definition at line 151 of file vtkWindow.h.

int vtkWindow::DPI [protected]
 

Definition at line 152 of file vtkWindow.h.


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