VTK  9.4.20241202
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*) {}
68 virtual bool EnsureDisplay() { return true; }
69
71
73
77 virtual int* GetPosition() VTK_SIZEHINT(2);
78
84 virtual void SetPosition(int x, int y);
85 virtual void SetPosition(int a[2]);
87
89
93 virtual int* GetSize() VTK_SIZEHINT(2);
94
103 virtual void SetSize(int width, int height);
104 virtual void SetSize(int a[2]);
106
111 int* GetActualSize() VTK_SIZEHINT(2);
112
116 virtual int* GetScreenSize() VTK_SIZEHINT(2) { return nullptr; }
117
119
122 vtkGetMacro(Mapped, vtkTypeBool);
124
126
130 vtkGetMacro(ShowWindow, bool);
131 vtkSetMacro(ShowWindow, bool);
132 vtkBooleanMacro(ShowWindow, bool);
134
136
142 vtkSetMacro(UseOffScreenBuffers, bool);
143 vtkGetMacro(UseOffScreenBuffers, bool);
144 vtkBooleanMacro(UseOffScreenBuffers, bool);
146
148
154 vtkSetMacro(Erase, vtkTypeBool);
155 vtkGetMacro(Erase, vtkTypeBool);
156 vtkBooleanMacro(Erase, vtkTypeBool);
158
160
163 vtkSetMacro(DoubleBuffer, vtkTypeBool);
164 vtkGetMacro(DoubleBuffer, vtkTypeBool);
165 vtkBooleanMacro(DoubleBuffer, vtkTypeBool);
167
169
172 vtkGetStringMacro(WindowName);
173 vtkSetStringMacro(WindowName);
175
180 virtual void SetIcon(vtkImageData*) {}
181
187 virtual void Render() {}
188
195
197
209 virtual unsigned char* GetPixelData(
210 int /*x*/, int /*y*/, int /*x2*/, int /*y2*/, int /*front*/, int /*right*/ = 0)
211 {
212 return nullptr;
213 }
214 virtual int GetPixelData(int /*x*/, int /*y*/, int /*x2*/, int /*y2*/, int /*front*/,
215 vtkUnsignedCharArray* /*data*/, int /*right*/ = 0)
216 {
217 return 0;
218 }
220
222
227 vtkGetMacro(DPI, int);
228 vtkSetClampMacro(DPI, int, 1, VTK_INT_MAX);
230
237 virtual bool DetectDPI() { return false; }
238
240
244 void SetOffScreenRendering(vtkTypeBool val)
245 {
246 this->SetShowWindow(val == 0);
247 this->SetUseOffScreenBuffers(val != 0);
248 }
249 vtkBooleanMacro(OffScreenRendering, vtkTypeBool);
251
257 vtkTypeBool GetOffScreenRendering() { return this->GetShowWindow() ? 0 : 1; }
258
263 virtual void MakeCurrent() {}
264
269 virtual void ReleaseCurrent() {}
270
272
278 vtkSetVector2Macro(TileScale, int);
279 vtkGetVector2Macro(TileScale, int);
280 void SetTileScale(int s) { this->SetTileScale(s, s); }
281 vtkSetVector4Macro(TileViewport, double);
282 vtkGetVector4Macro(TileViewport, double);
284
285protected:
287 ~vtkWindow() override;
288
290 int Size[2];
291 int Position[2];
297 int DPI;
298
299 double TileViewport[4];
300 int TileSize[2];
301 int TileScale[2];
302
303private:
304 vtkWindow(const vtkWindow&) = delete;
305 void operator=(const vtkWindow&) = delete;
306};
307
308VTK_ABI_NAMESPACE_END
309#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:209
bool UseOffScreenBuffers
Definition vtkWindow.h:294
virtual void * GetGenericWindowId()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:62
virtual bool EnsureDisplay()
These are window system independent methods that are used to help interface vtkWindow to native windo...
Definition vtkWindow.h:68
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:269
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:296
~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:214
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
vtkTypeBool Mapped
Definition vtkWindow.h:292
vtkTypeBool Erase
Definition vtkWindow.h:295
bool ShowWindow
Definition vtkWindow.h:293
char * WindowName
Definition vtkWindow.h:289
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:194
virtual VTK_UNBLOCKTHREADS void Render()
Ask each viewport owned by this Window to render its image and synchronize this process.
Definition vtkWindow.h:187
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:280
virtual void MakeCurrent()
Make the window current.
Definition vtkWindow.h:263
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_MARSHAL_EXCLUDE_REASON_IS_INTERNAL
#define VTK_UNBLOCKTHREADS
#define VTK_MARSHALAUTO
#define VTK_MARSHALEXCLUDE(reason)