VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWindow Class Referenceabstract

window superclass for vtkRenderWindow More...

#include <vtkWindow.h>

Inheritance diagram for vtkWindow:
[legend]
Collaboration diagram for vtkWindow:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
intGetActualSize ()
 
virtual intGetScreenSize ()=0
 
virtual void Render ()=0
 
virtual bool DetectDPI ()
 
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 intGetPosition ()
 
virtual void SetPosition (int, int)
 
virtual void SetPosition (int a[2])
 
virtual intGetSize ()
 
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 intGetTileScale ()
 
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 doubleGetTileViewport ()
 
virtual void GetTileViewport (double &, double &, double &, double &)
 
virtual void GetTileViewport (double[4])
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWindow ()
 
 ~vtkWindow ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 36 of file vtkWindow.h.

Member Typedef Documentation

Definition at line 39 of file vtkWindow.h.

Constructor & Destructor Documentation

vtkWindow::vtkWindow ( )
protected
vtkWindow::~vtkWindow ( )
protected

Member Function Documentation

static int vtkWindow::IsTypeOf ( const char *  type)
static
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 vtkRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, and vtkEGLRenderWindow.

static vtkWindow* vtkWindow::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkWindow::NewInstanceInternal ( ) const
protectedvirtual
vtkWindow* vtkWindow::NewInstance ( ) const
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 vtkRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, and vtkEGLRenderWindow.

virtual void vtkWindow::SetDisplayId ( void *  )
pure virtual
virtual void vtkWindow::SetWindowId ( void *  )
pure virtual
virtual void vtkWindow::SetParentId ( void *  )
pure virtual
virtual void* vtkWindow::GetGenericDisplayId ( )
pure virtual
virtual void* vtkWindow::GetGenericWindowId ( )
pure virtual
virtual void* vtkWindow::GetGenericParentId ( )
pure virtual
virtual void* vtkWindow::GetGenericContext ( )
pure virtual
virtual void* vtkWindow::GetGenericDrawable ( )
pure virtual
virtual void vtkWindow::SetWindowInfo ( char *  )
pure virtual
virtual void vtkWindow::SetParentInfo ( char *  )
pure virtual
virtual int* vtkWindow::GetPosition ( )
virtual
virtual void vtkWindow::SetPosition ( int  ,
int   
)
virtual
virtual void vtkWindow::SetPosition ( int  a[2])
virtual
virtual int* vtkWindow::GetSize ( )
virtual

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

Reimplemented in vtkCocoaRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

virtual void vtkWindow::SetSize ( int  ,
int   
)
virtual
virtual void vtkWindow::SetSize ( int  a[2])
virtual
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 vtkXOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkEGLRenderWindow, vtkRenderWindow, vtkExternalOpenGLRenderWindow, and vtkOpenGLRenderWindow.

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 vtkOpenGLRenderWindow, 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 vtkOpenGLRenderWindow, 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 bool vtkWindow::DetectDPI ( )
inlinevirtual

Attempt to detect and set the DPI of the display device by querying the system. Note that this is not supported on all backends, and this method will return false if the DPI could not be detected. Use GetDPI() to inspect the detected value.

Reimplemented in vtkWin32OpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 139 of file vtkWindow.h.

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 vtkXOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkOSOpenGLRenderWindow, and vtkEGLRenderWindow.

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.

Reimplemented in vtkEGLRenderWindow.

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 ( )
inlinevirtual
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 162 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

int vtkWindow::OffScreenRendering
protected

Definition at line 164 of file vtkWindow.h.

char* vtkWindow::WindowName
protected

Definition at line 172 of file vtkWindow.h.

int vtkWindow::Size[2]
protected

Definition at line 173 of file vtkWindow.h.

int vtkWindow::Position[2]
protected

Definition at line 174 of file vtkWindow.h.

int vtkWindow::Mapped
protected

Definition at line 175 of file vtkWindow.h.

int vtkWindow::Erase
protected

Definition at line 176 of file vtkWindow.h.

int vtkWindow::DoubleBuffer
protected

Definition at line 177 of file vtkWindow.h.

int vtkWindow::DPI
protected

Definition at line 178 of file vtkWindow.h.

double vtkWindow::TileViewport[4]
protected

Definition at line 180 of file vtkWindow.h.

int vtkWindow::TileSize[2]
protected

Definition at line 181 of file vtkWindow.h.

int vtkWindow::TileScale[2]
protected

Definition at line 182 of file vtkWindow.h.


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