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

window superclass for vtkRenderWindow More...

#include <vtkWindow.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int * GetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual int * GetScreenSize ()
 Get the current size of the screen in pixels. More...
 
virtual void SetIcon (vtkImageData *)
 Set the icon used in title bar and task bar. More...
 
virtual void Render ()
 Ask each viewport owned by this Window to render its image and synchronize this process. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this texture. More...
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual void MakeCurrent ()
 Make the window current. More...
 
virtual void ReleaseCurrent ()
 Release the current context. More...
 
virtual void SetDisplayId (void *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void SetWindowId (void *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void SetParentId (void *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void * GetGenericDisplayId ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void * GetGenericWindowId ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void * GetGenericParentId ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void * GetGenericContext ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void * GetGenericDrawable ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void SetWindowInfo (const char *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void SetParentInfo (const char *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual int * GetPosition ()
 Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
virtual void SetPosition (int x, int y)
 Set the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
virtual void SetPosition (int a[2])
 Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
virtual int * GetSize ()
 Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
virtual void SetSize (int width, int height)
 Set the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
virtual void SetSize (int a[2])
 Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
virtual vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen. More...
 
virtual bool GetShowWindow ()
 Show or not Show the window. More...
 
virtual void SetShowWindow (bool)
 Show or not Show the window. More...
 
virtual void ShowWindowOn ()
 Show or not Show the window. More...
 
virtual void ShowWindowOff ()
 Show or not Show the window. More...
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOn ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOff ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOn ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOff ()
 Turn on/off erasing the screen between images. More...
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOn ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOff ()
 Keep track of whether double buffering is on or off. More...
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void SetWindowName (const char *)
 Get name of rendering window. More...
 
virtual unsigned char * GetPixelData (int, int, int, int, int, int=0)
 Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
virtual int GetPixelData (int, int, int, int, int, vtkUnsignedCharArray *, int=0)
 Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
virtual int GetDPI ()
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
virtual void SetDPI (int)
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOff ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void SetTileScale (int, int)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual int * GetTileScale ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int &, int &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int s)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void SetTileViewport (double, double, double, double)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void SetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual double * GetTileViewport ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileViewport (double &, double &, double &, double &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWindow ()
 
 ~vtkWindow () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * WindowName
 
int Size [2]
 
int Position [2]
 
vtkTypeBool Mapped
 
bool ShowWindow
 
bool UseOffScreenBuffers
 
vtkTypeBool Erase
 
vtkTypeBool 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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
Events:
vtkCommand::WindowResizeEvent

Definition at line 38 of file vtkWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkWindow.h.

Constructor & Destructor Documentation

◆ vtkWindow()

vtkWindow::vtkWindow ( )
protected

◆ ~vtkWindow()

vtkWindow::~vtkWindow ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkWindow::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkVRRenderWindow, vtkWin32HardwareWindow, vtkOpenXRRenderWindow, vtkOpenVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkExternalOpenGLRenderWindow, vtkRenderWindow, and vtkHardwareWindow.

◆ SafeDownCast()

static vtkWindow* vtkWindow::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWindow::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkWindow* vtkWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkVRRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkOpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkExternalOpenGLRenderWindow, vtkRenderWindow, vtkHardwareWindow, and vtkOSOpenGLRenderWindow.

◆ SetDisplayId()

virtual void vtkWindow::SetDisplayId ( void *  )
inlinevirtual

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

Reimplemented in vtkCocoaRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 49 of file vtkWindow.h.

◆ SetWindowId()

virtual void vtkWindow::SetWindowId ( void *  )
inlinevirtual

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

Reimplemented in vtkEGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkCocoaRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 50 of file vtkWindow.h.

◆ SetParentId()

virtual void vtkWindow::SetParentId ( void *  )
inlinevirtual

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

Reimplemented in vtkIOSRenderWindow, vtkCocoaRenderWindow, vtkWin32OpenGLRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 51 of file vtkWindow.h.

◆ GetGenericDisplayId()

virtual void* vtkWindow::GetGenericDisplayId ( )
inlinevirtual

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

Reimplemented in vtkVRRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 52 of file vtkWindow.h.

◆ GetGenericWindowId()

virtual void* vtkWindow::GetGenericWindowId ( )
inlinevirtual

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

Reimplemented in vtkVRRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 53 of file vtkWindow.h.

◆ GetGenericParentId()

virtual void* vtkWindow::GetGenericParentId ( )
inlinevirtual

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

Reimplemented in vtkVRRenderWindow, vtkWin32HardwareWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 54 of file vtkWindow.h.

◆ GetGenericContext()

virtual void* vtkWindow::GetGenericContext ( )
inlinevirtual

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

Reimplemented in vtkVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 55 of file vtkWindow.h.

◆ GetGenericDrawable()

virtual void* vtkWindow::GetGenericDrawable ( )
inlinevirtual

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

Reimplemented in vtkVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, vtkRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 56 of file vtkWindow.h.

◆ SetWindowInfo()

virtual void vtkWindow::SetWindowInfo ( const char *  )
inlinevirtual

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

Reimplemented in vtkXOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, and vtkRenderWindow.

Definition at line 57 of file vtkWindow.h.

◆ SetParentInfo()

virtual void vtkWindow::SetParentInfo ( const char *  )
inlinevirtual

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

Reimplemented in vtkXOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, and vtkRenderWindow.

Definition at line 58 of file vtkWindow.h.

◆ GetPosition()

virtual int* vtkWindow::GetPosition ( )
virtual

Get the position (x and y) of the rendering window in screen coordinates (in pixels).

Reimplemented in vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, and vtkCocoaRenderWindow.

◆ SetPosition() [1/2]

virtual void vtkWindow::SetPosition ( int  x,
int  y 
)
virtual

Set the position (x and y) of the rendering window in screen coordinates (in pixels).

This resizes the operating system's view/window and redraws it.

Reimplemented in vtkWin32HardwareWindow, vtkSDL2OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, and vtkCocoaRenderWindow.

◆ SetPosition() [2/2]

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

Get the position (x and y) of the rendering window in screen coordinates (in pixels).

Reimplemented in vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, and vtkCocoaRenderWindow.

◆ GetSize()

virtual int* vtkWindow::GetSize ( )
virtual

Get the size (width and height) of the rendering window in screen coordinates (in pixels).

Reimplemented in vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkIOSRenderWindow, and vtkCocoaRenderWindow.

◆ SetSize() [1/2]

virtual void vtkWindow::SetSize ( int  width,
int  height 
)
virtual

Set the size (width and height) of the rendering window in screen coordinates (in pixels).

This resizes the operating system's view/window and redraws it.

If the size has changed, this method will fire vtkCommand::WindowResizeEvent.

Reimplemented in vtkWin32HardwareWindow, vtkSDL2OpenGLRenderWindow, vtkVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, and vtkCocoaRenderWindow.

◆ SetSize() [2/2]

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

Get the size (width and height) of the rendering window in screen coordinates (in pixels).

Reimplemented in vtkVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, and vtkCocoaRenderWindow.

◆ GetActualSize()

int* vtkWindow::GetActualSize ( )

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

Measured in pixels.

◆ GetScreenSize()

virtual int* vtkWindow::GetScreenSize ( )
inlinevirtual

◆ GetMapped()

virtual vtkTypeBool vtkWindow::GetMapped ( )
virtual

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

◆ GetShowWindow()

virtual bool vtkWindow::GetShowWindow ( )
virtual

Show or not Show the window.

◆ SetShowWindow()

virtual void vtkWindow::SetShowWindow ( bool  )
virtual

◆ ShowWindowOn()

virtual void vtkWindow::ShowWindowOn ( )
virtual

Show or not Show the window.

◆ ShowWindowOff()

virtual void vtkWindow::ShowWindowOff ( )
virtual

Show or not Show the window.

◆ SetUseOffScreenBuffers()

virtual void vtkWindow::SetUseOffScreenBuffers ( bool  )
virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ GetUseOffScreenBuffers()

virtual bool vtkWindow::GetUseOffScreenBuffers ( )
virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ UseOffScreenBuffersOn()

virtual void vtkWindow::UseOffScreenBuffersOn ( )
virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ UseOffScreenBuffersOff()

virtual void vtkWindow::UseOffScreenBuffersOff ( )
virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ SetErase()

virtual void vtkWindow::SetErase ( vtkTypeBool  )
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.

◆ GetErase()

virtual vtkTypeBool 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.

◆ EraseOn()

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.

◆ EraseOff()

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.

◆ SetDoubleBuffer()

virtual void vtkWindow::SetDoubleBuffer ( vtkTypeBool  )
virtual

Keep track of whether double buffering is on or off.

◆ GetDoubleBuffer()

virtual vtkTypeBool vtkWindow::GetDoubleBuffer ( )
virtual

Keep track of whether double buffering is on or off.

◆ DoubleBufferOn()

virtual void vtkWindow::DoubleBufferOn ( )
virtual

Keep track of whether double buffering is on or off.

◆ DoubleBufferOff()

virtual void vtkWindow::DoubleBufferOff ( )
virtual

Keep track of whether double buffering is on or off.

◆ GetWindowName()

virtual char* vtkWindow::GetWindowName ( )
virtual

Get name of rendering window.

◆ SetWindowName()

virtual void vtkWindow::SetWindowName ( const char *  )
virtual

◆ SetIcon()

virtual void vtkWindow::SetIcon ( vtkImageData )
inlinevirtual

Set the icon used in title bar and task bar.

Currently implemented for OpenGL windows on Windows and Linux.

Reimplemented in vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 167 of file vtkWindow.h.

◆ Render()

virtual void vtkWindow::Render ( )
inlinevirtual

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

Reimplemented in vtkVRRenderWindow, vtkOpenXRRenderWindow, vtkOpenVRRenderWindow, vtkXOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, and vtkRenderWindow.

Definition at line 173 of file vtkWindow.h.

◆ ReleaseGraphicsResources()

virtual void vtkWindow::ReleaseGraphicsResources ( vtkWindow )
inlinevirtual

Release any graphics resources that are being consumed by this texture.

The parameter window could be used to determine which graphic resources to release.

Reimplemented in vtkOpenVRRenderWindow, vtkVRRenderWindow, and vtkOpenGLRenderWindow.

Definition at line 180 of file vtkWindow.h.

◆ GetPixelData() [1/2]

virtual unsigned char* vtkWindow::GetPixelData ( int  ,
int  ,
int  ,
int  ,
int  ,
int  = 0 
)
inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow.

Definition at line 195 of file vtkWindow.h.

◆ GetPixelData() [2/2]

virtual int vtkWindow::GetPixelData ( int  ,
int  ,
int  ,
int  ,
int  ,
vtkUnsignedCharArray ,
int  = 0 
)
inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow.

Definition at line 200 of file vtkWindow.h.

◆ GetDPI()

virtual int vtkWindow::GetDPI ( )
virtual

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

◆ SetDPI()

virtual void vtkWindow::SetDPI ( int  )
virtual

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

◆ DetectDPI()

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 most backends, and this method will return false if the DPI could not be detected. Use GetDPI() to inspect the detected value.

Reimplemented in vtkWin32OpenGLRenderWindow.

Definition at line 222 of file vtkWindow.h.

◆ SetOffScreenRendering()

void vtkWindow::SetOffScreenRendering ( vtkTypeBool  val)
inline

Convenience to set SHowWindow and UseOffScreenBuffers in one call.

Definition at line 228 of file vtkWindow.h.

◆ OffScreenRenderingOn()

virtual void vtkWindow::OffScreenRenderingOn ( )
virtual

Convenience to set SHowWindow and UseOffScreenBuffers in one call.

◆ OffScreenRenderingOff()

virtual void vtkWindow::OffScreenRenderingOff ( )
virtual

Convenience to set SHowWindow and UseOffScreenBuffers in one call.

◆ GetOffScreenRendering()

vtkTypeBool vtkWindow::GetOffScreenRendering ( )
inline

Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.

Definition at line 240 of file vtkWindow.h.

◆ MakeCurrent()

virtual void vtkWindow::MakeCurrent ( )
inlinevirtual

Make the window current.

May be overridden in subclasses to do for example a glXMakeCurrent or a wglMakeCurrent.

Reimplemented in vtkVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkCocoaRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 246 of file vtkWindow.h.

◆ ReleaseCurrent()

virtual void vtkWindow::ReleaseCurrent ( )
inlinevirtual

Release the current context.

May be overridden in subclasses to do for example a glXMakeCurrent or a wglMakeCurrent.

Reimplemented in vtkVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkEGLRenderWindow, and vtkCocoaRenderWindow.

Definition at line 252 of file vtkWindow.h.

◆ SetTileScale() [1/3]

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.

◆ SetTileScale() [2/3]

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.

◆ GetTileScale() [1/3]

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.

◆ GetTileScale() [2/3]

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.

◆ GetTileScale() [3/3]

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.

◆ SetTileScale() [3/3]

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

◆ SetTileViewport() [1/2]

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.

◆ SetTileViewport() [2/2]

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.

◆ GetTileViewport() [1/3]

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.

◆ GetTileViewport() [2/3]

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.

◆ GetTileViewport() [3/3]

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

◆ WindowName

char* vtkWindow::WindowName
protected

Definition at line 272 of file vtkWindow.h.

◆ Size

int vtkWindow::Size[2]
protected

Definition at line 273 of file vtkWindow.h.

◆ Position

int vtkWindow::Position[2]
protected

Definition at line 274 of file vtkWindow.h.

◆ Mapped

vtkTypeBool vtkWindow::Mapped
protected

Definition at line 275 of file vtkWindow.h.

◆ ShowWindow

bool vtkWindow::ShowWindow
protected

Definition at line 276 of file vtkWindow.h.

◆ UseOffScreenBuffers

bool vtkWindow::UseOffScreenBuffers
protected

Definition at line 277 of file vtkWindow.h.

◆ Erase

vtkTypeBool vtkWindow::Erase
protected

Definition at line 278 of file vtkWindow.h.

◆ DoubleBuffer

vtkTypeBool vtkWindow::DoubleBuffer
protected

Definition at line 279 of file vtkWindow.h.

◆ DPI

int vtkWindow::DPI
protected

Definition at line 280 of file vtkWindow.h.

◆ TileViewport

double vtkWindow::TileViewport[4]
protected

Definition at line 282 of file vtkWindow.h.

◆ TileSize

int vtkWindow::TileSize[2]
protected

Definition at line 283 of file vtkWindow.h.

◆ TileScale

int vtkWindow::TileScale[2]
protected

Definition at line 284 of file vtkWindow.h.


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