vtkWindow Class Reference

#include <vtkWindow.h>

Inheritance diagram for vtkWindow:

Inheritance graph
[legend]
Collaboration diagram for vtkWindow:

Collaboration graph
[legend]

List of all members.


Detailed Description

window superclass for vtkRenderWindow

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

See also:
vtkRenderWindow vtkViewport
Examples:
vtkWindow (Examples)

Definition at line 35 of file vtkWindow.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int * GetActualSize ()
virtual int * GetScreenSize ()=0
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 (const char *)
virtual unsigned char * GetPixelData (int x, int y, int x2, int y2, int front)=0
virtual int GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data)=0
virtual int GetDPI ()
virtual void SetDPI (int)
virtual void SetOffScreenRendering (int)
virtual int GetOffScreenRendering ()
virtual void OffScreenRenderingOn ()
virtual void OffScreenRenderingOff ()
virtual void SetTileScale (int, int)
void SetTileScale (int[2])
virtual int * GetTileScale ()
virtual void GetTileScale (int &, int &)
virtual void GetTileScale (int[2])
void SetTileScale (int s)
virtual void SetTileViewport (double, double, double, double)
virtual void SetTileViewport (double[4])
virtual double * GetTileViewport ()
virtual void GetTileViewport (double &, double &, double &, double &)
virtual void GetTileViewport (double[4])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkWindowSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkWindow ()
 ~vtkWindow ()

Protected Attributes

int OffScreenRendering
char * WindowName
int Size [2]
int Position [2]
int Mapped
int Erase
int DoubleBuffer
int DPI
double TileViewport [4]
int TileSize [2]
int TileScale [2]

Member Typedef Documentation


Constructor & Destructor Documentation

vtkWindow::vtkWindow (  )  [protected]

vtkWindow::~vtkWindow (  )  [protected]


Member Function Documentation

virtual const char* vtkWindow::GetClassName (  )  [virtual]

static int vtkWindow::IsTypeOf ( const char *  name  )  [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 vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual int vtkWindow::IsA ( const char *  name  )  [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 vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

static vtkWindow* vtkWindow::SafeDownCast ( vtkObject o  )  [static]

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 vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

virtual void vtkWindow::SetPosition ( int  ,
int   
) [virtual]

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

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

Reimplemented in vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

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

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkWin32OpenGLRenderWindow, and vtkWinCEOpenGLRenderWindow.

virtual void vtkWindow::SetSize ( int  ,
int   
) [virtual]

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

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

Reimplemented in vtkCarbonRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

int* vtkWindow::GetActualSize (  ) 

GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale.

virtual int* vtkWindow::GetScreenSize (  )  [pure virtual]

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 ( const char *   )  [virtual]

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

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

Implemented in vtkRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual unsigned char* vtkWindow::GetPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front 
) [pure 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. (x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkWindow::GetPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkUnsignedCharArray data 
) [pure 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. (x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

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   )  [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 vtkCarbonRenderWindow, vtkOSOpenGLRenderWindow, 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 vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOSOpenGLRenderWindow, vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

Definition at line 145 of file vtkWindow.h.

virtual void vtkWindow::SetTileScale ( int  ,
int   
) [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

void vtkWindow::SetTileScale ( int  [2]  ) 

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

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

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

virtual void vtkWindow::GetTileScale ( int &  ,
int &   
) [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

virtual void vtkWindow::GetTileScale ( int  [2]  )  [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

void vtkWindow::SetTileScale ( int  s  )  [inline]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

Definition at line 155 of file vtkWindow.h.

virtual void vtkWindow::SetTileViewport ( double  ,
double  ,
double  ,
double   
) [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

virtual void vtkWindow::SetTileViewport ( double  [4]  )  [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

virtual double* vtkWindow::GetTileViewport (  )  [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

virtual void vtkWindow::GetTileViewport ( double &  ,
double &  ,
double &  ,
double &   
) [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.

virtual void vtkWindow::GetTileViewport ( double  [4]  )  [virtual]

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.


Member Data Documentation

Definition at line 157 of file vtkWindow.h.

char* vtkWindow::WindowName [protected]

Definition at line 165 of file vtkWindow.h.

int vtkWindow::Size[2] [protected]

Definition at line 166 of file vtkWindow.h.

int vtkWindow::Position[2] [protected]

Definition at line 167 of file vtkWindow.h.

int vtkWindow::Mapped [protected]

Definition at line 168 of file vtkWindow.h.

int vtkWindow::Erase [protected]

Definition at line 169 of file vtkWindow.h.

int vtkWindow::DoubleBuffer [protected]

Definition at line 170 of file vtkWindow.h.

int vtkWindow::DPI [protected]

Definition at line 171 of file vtkWindow.h.

double vtkWindow::TileViewport[4] [protected]

Definition at line 173 of file vtkWindow.h.

int vtkWindow::TileSize[2] [protected]

Definition at line 174 of file vtkWindow.h.

int vtkWindow::TileScale[2] [protected]

Definition at line 175 of file vtkWindow.h.


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

Generated on Mon Sep 27 19:02:08 2010 for VTK by  doxygen 1.5.6