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:

[legend]Collaboration diagram for vtkWindow:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Render ()=0
virtual void	MakeCurrent ()

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 void	SetParentInfo (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 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 ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkWindow *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkWindow ()
	~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:: 2001/10/11 13:36:30

Revision:: 1.23

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

See also:: vtkImageWindow vtkRenderWindow vtkViewport

Examples:: vtkWindow (Examples)

Definition at line 62 of file vtkWindow.h.

Constructor & Destructor Documentation

vtkWindow::vtkWindow ( ) [protected]

vtkWindow::~vtkWindow ( ) [protected]

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 vtkImageWindow, vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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 vtkImageWindow, vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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 vtkImageWindow, vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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 vtkImageWindow, vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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 vtkImageWindow, vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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 vtkImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void vtkWindow::SetWindowId ( void * foo ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void vtkWindow::SetParentId ( void * foo ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkQuartzImageWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void* vtkWindow::GetGenericDisplayId ( ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void* vtkWindow::GetGenericWindowId ( ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void* vtkWindow::GetGenericParentId ( ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkQuartzImageWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void* vtkWindow::GetGenericContext ( ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void* vtkWindow::GetGenericDrawable ( ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void vtkWindow::SetParentInfo ( char * info ) [pure virtual]

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Reimplemented in vtkImageWindow, vtkRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual int* vtkWindow::GetPosition ( ) [virtual]

Set/Get the position in screen coordinates of the rendering window.
Reimplemented in vtkImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void vtkWindow::SetPosition ( int x,

int y

) [virtual]

Set/Get the position in screen coordinates of the rendering window.
Reimplemented in vtkImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.
Referenced by vtkXRenderWindow::SetPosition(), vtkXOpenGLRenderWindow::SetPosition(), vtkXMesaRenderWindow::SetPosition(), vtkWin32OpenGLRenderWindow::SetPosition(), and vtkImageWindow::SetPosition().

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

Set/Get the position in screen coordinates of the rendering window.
Reimplemented in vtkImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual int* vtkWindow::GetSize ( ) [virtual]

Set/Get the size of the window in screen coordinates.
Reimplemented in vtkImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void vtkWindow::SetSize ( int x,

int y

) [virtual]

Set/Get the size of the window in screen coordinates.
Reimplemented in vtkImageWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.
Referenced by Java_vtkPanel_SetSizeInternal(), vtkXOpenGLRenderWindow::SetSize(), vtkXMesaRenderWindow::SetSize(), vtkWin32OpenGLRenderWindow::SetSize(), and vtkImageWindow::SetSize().

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

Set/Get the size of the window in screen coordinates.
Reimplemented in vtkImageWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkWindow::SetMapped ( int ) [virtual]

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

virtual int vtkWindow::GetMapped ( ) [virtual]

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

virtual void vtkWindow::MappedOn ( ) [virtual]

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

virtual void vtkWindow::MappedOff ( ) [virtual]

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

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]

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 void vtkWindow::EraseOn ( ) [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 void vtkWindow::EraseOff ( ) [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 void vtkWindow::SetDoubleBuffer ( int ) [virtual]

Keep track of whether double buffering is on or off

virtual int vtkWindow::GetDoubleBuffer ( ) [virtual]

Keep track of whether double buffering is on or off

virtual void vtkWindow::DoubleBufferOn ( ) [virtual]

Keep track of whether double buffering is on or off

virtual void vtkWindow::DoubleBufferOff ( ) [virtual]

Keep track of whether double buffering is on or off

virtual char* vtkWindow::GetWindowName ( ) [virtual]

Get name of rendering window

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

Get name of rendering window
Reimplemented in vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

virtual void vtkWindow::Render ( ) [pure virtual]

Ask each viewport owned by this Window to render its image and synchronize this process.
Reimplemented in vtkImageWindow, vtkMesaImageWindow, vtkOpenGLImageWindow, vtkQuartzImageWindow, vtkRenderWindow, vtkWin32OpenGLImageWindow, vtkXMesaRenderWindow, vtkXOpenGLRenderWindow, and vtkXRenderWindow.

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 vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkWin32ImageWindow, vtkWin32OpenGLImageWindow, and vtkXImageWindow.
Definition at line 140 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]

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

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 vtkMesaImageWindow, vtkWin32OpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual int vtkWindow::GetOffScreenRendering ( ) [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.

virtual void vtkWindow::OffScreenRenderingOn ( ) [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.

virtual void vtkWindow::OffScreenRenderingOff ( ) [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.

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 vtkImageWindow, vtkMesaImageWindow, vtkMesaRenderWindow, vtkOpenGLImageWindow, vtkOpenGLRenderWindow, vtkQuartzImageWindow, vtkQuartzRenderWindow, vtkRenderWindow, vtkWin32OpenGLImageWindow, vtkWin32OpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.
Definition at line 162 of file vtkWindow.h.

Member Data Documentation

int vtkWindow::OffScreenRendering [protected]

Definition at line 165 of file vtkWindow.h.

char* vtkWindow::WindowName [protected]

Definition at line 169 of file vtkWindow.h.

int vtkWindow::Size[2] [protected]

Definition at line 170 of file vtkWindow.h.

int vtkWindow::Position[2] [protected]

Definition at line 171 of file vtkWindow.h.

int vtkWindow::Mapped [protected]

Definition at line 172 of file vtkWindow.h.

int vtkWindow::Erase [protected]

Definition at line 173 of file vtkWindow.h.

int vtkWindow::DoubleBuffer [protected]

Definition at line 174 of file vtkWindow.h.

int vtkWindow::DPI [protected]

Definition at line 175 of file vtkWindow.h.

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

Common/vtkWindow.h

Generated on Thu Mar 28 14:48:19 2002 for VTK by

vtkWindow Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation