VTK  9.3.20240721
vtkWindow.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
36#ifndef vtkWindow_h
37#define vtkWindow_h
38
39#include "vtkCommonCoreModule.h" // For export macro
40#include "vtkObject.h"
41#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
42
43VTK_ABI_NAMESPACE_BEGIN
44class vtkImageData;
46
47class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkWindow : public vtkObject
48{
49public:
50 vtkTypeMacro(vtkWindow, vtkObject);
51 void PrintSelf(ostream& os, vtkIndent indent) override;
52
54
58 virtual void SetDisplayId(void*) {}
59 virtual void SetWindowId(void*) {}
60 virtual void SetParentId(void*) {}
61 virtual void* GetGenericDisplayId() { return nullptr; }
62 virtual void* GetGenericWindowId() { return nullptr; }
63 virtual void* GetGenericParentId() { return nullptr; }
64 virtual void* GetGenericContext() { return nullptr; }
65 virtual void* GetGenericDrawable() { return nullptr; }
66 virtual void SetWindowInfo(const char*) {}
67 virtual void SetParentInfo(const char*) {}
69
71
75 virtual int* GetPosition() VTK_SIZEHINT(2);
76
82 virtual void SetPosition(int x, int y);
83 virtual void SetPosition(int a[2]);
85
87
91 virtual int* GetSize() VTK_SIZEHINT(2);
92
101 virtual void SetSize(int width, int height);
102 virtual void SetSize(int a[2]);
104
109 int* GetActualSize() VTK_SIZEHINT(2);
110
114 virtual int* GetScreenSize() VTK_SIZEHINT(2) { return nullptr; }
115
117
120 vtkGetMacro(Mapped, vtkTypeBool);
122
124
127 vtkGetMacro(ShowWindow, bool);
128 vtkSetMacro(ShowWindow, bool);
129 vtkBooleanMacro(ShowWindow, bool);
131
133
138 vtkSetMacro(UseOffScreenBuffers, bool);
139 vtkGetMacro(UseOffScreenBuffers, bool);
140 vtkBooleanMacro(UseOffScreenBuffers, bool);
142
144
150 vtkSetMacro(Erase, vtkTypeBool);
151 vtkGetMacro(Erase, vtkTypeBool);
152 vtkBooleanMacro(Erase, vtkTypeBool);
154
156
159 vtkSetMacro(DoubleBuffer, vtkTypeBool);
160 vtkGetMacro(DoubleBuffer, vtkTypeBool);
161 vtkBooleanMacro(DoubleBuffer, vtkTypeBool);
163
165
168 vtkGetStringMacro(WindowName);
169 vtkSetStringMacro(WindowName);
171
176 virtual void SetIcon(vtkImageData*) {}
177
183 virtual void Render() {}
184
191
193
205 virtual unsigned char* GetPixelData(
206 int /*x*/, int /*y*/, int /*x2*/, int /*y2*/, int /*front*/, int /*right*/ = 0)
207 {
208 return nullptr;
209 }
210 virtual int GetPixelData(int /*x*/, int /*y*/, int /*x2*/, int /*y2*/, int /*front*/,
211 vtkUnsignedCharArray* /*data*/, int /*right*/ = 0)
212 {
213 return 0;
214 }
216
218
222 vtkGetMacro(DPI, int);
223 vtkSetClampMacro(DPI, int, 1, VTK_INT_MAX);
225
232 virtual bool DetectDPI() { return false; }
233
235
239 {
240 this->SetShowWindow(val == 0);
241 this->SetUseOffScreenBuffers(val != 0);
242 }
243 vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
245
250 vtkTypeBool GetOffScreenRendering() { return this->GetShowWindow() ? 0 : 1; }
251
256 virtual void MakeCurrent() {}
257
262 virtual void ReleaseCurrent() {}
263
265
271 vtkSetVector2Macro(TileScale, int);
272 vtkGetVector2Macro(TileScale, int);
273 void SetTileScale(int s) { this->SetTileScale(s, s); }
274 vtkSetVector4Macro(TileViewport, double);
275 vtkGetVector4Macro(TileViewport, double);
277
278protected:
280 ~vtkWindow() override;
281
283 int Size[2];
284 int Position[2];
290 int DPI;
291
292 double TileViewport[4];
293 int TileSize[2];
294 int TileScale[2];
295
296private:
297 vtkWindow(const vtkWindow&) = delete;
298 void operator=(const vtkWindow&) = delete;
299};
300
301VTK_ABI_NAMESPACE_END
302#endif
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:108
abstract base class for most VTK objects
Definition vtkObject.h:162
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void * GetGenericDrawable()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:65
virtual unsigned char * GetPixelData(int, int, int, int, int, int=0)
Get the pixel data of an image, transmitted as RGBRGBRGB.
Definition vtkWindow.h:205
bool UseOffScreenBuffers
Definition vtkWindow.h:287
virtual bool DetectDPI()
Attempt to detect and set the DPI of the display device by querying the system.
Definition vtkWindow.h:232
vtkTypeBool GetOffScreenRendering()
Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.
Definition vtkWindow.h:250
virtual void SetIcon(vtkImageData *)
Set the icon used in title bar and task bar.
Definition vtkWindow.h:176
virtual void * GetGenericWindowId()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:62
virtual void SetWindowInfo(const char *)
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:66
virtual void ReleaseCurrent()
Release the current context.
Definition vtkWindow.h:262
virtual void * GetGenericContext()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:64
vtkTypeBool DoubleBuffer
Definition vtkWindow.h:289
~vtkWindow() override
virtual void * GetGenericParentId()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:63
virtual int GetPixelData(int, int, int, int, int, vtkUnsignedCharArray *, int=0)
Get the pixel data of an image, transmitted as RGBRGBRGB.
Definition vtkWindow.h:210
virtual void * GetGenericDisplayId()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:61
virtual void SetDisplayId(void *)
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:58
void SetOffScreenRendering(vtkTypeBool val)
Convenience to set SHowWindow and UseOffScreenBuffers in one call.
Definition vtkWindow.h:238
vtkTypeBool Mapped
Definition vtkWindow.h:285
vtkTypeBool Erase
Definition vtkWindow.h:288
bool ShowWindow
Definition vtkWindow.h:286
char * WindowName
Definition vtkWindow.h:282
virtual int * GetPosition()
Get the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual void SetParentInfo(const char *)
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:67
virtual void ReleaseGraphicsResources(vtkWindow *)
Release any graphics resources that are being consumed by this texture.
Definition vtkWindow.h:190
virtual VTK_UNBLOCKTHREADS void Render()
Ask each viewport owned by this Window to render its image and synchronize this process.
Definition vtkWindow.h:183
virtual void SetParentId(void *)
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:60
void SetTileScale(int s)
These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by ...
Definition vtkWindow.h:273
virtual void MakeCurrent()
Make the window current.
Definition vtkWindow.h:256
virtual void SetWindowId(void *)
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:59
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_INT_MAX
Definition vtkType.h:144
#define VTK_SIZEHINT(...)
#define VTK_UNBLOCKTHREADS
#define VTK_MARSHALAUTO