VTK  9.0.1
vtkIOSRenderWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkIOSRenderWindow.h
5 
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
42 #ifndef vtkIOSRenderWindow_h
43 #define vtkIOSRenderWindow_h
44 
45 #include "vtkOpenGLRenderWindow.h"
46 #include "vtkRenderingOpenGL2Module.h" // For export macro
47 
48 class VTKRENDERINGOPENGL2_EXPORT vtkIOSRenderWindow : public vtkOpenGLRenderWindow
49 {
50 public:
51  static vtkIOSRenderWindow* New();
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
58  void Start() override;
59 
63  void Frame() override;
64 
68  virtual void WindowConfigure();
69 
78  void Initialize() override;
79 
86  void SetFullScreen(vtkTypeBool) override;
87 
91  void WindowRemap() override;
92 
97  virtual void PrefFullScreen();
98 
100 
108  void SetSize(int width, int height) override;
109  void SetSize(int a[2]) override { this->SetSize(a[0], a[1]); }
111 
116  int* GetSize() VTK_SIZEHINT(2) override;
117 
119 
124  void SetPosition(int x, int y) override;
125  void SetPosition(int a[2]) override { this->SetPosition(a[0], a[1]); }
127 
132  int* GetScreenSize() VTK_SIZEHINT(2) override;
133 
138  int* GetPosition() VTK_SIZEHINT(2) override;
139 
144  void SetWindowName(const char*) override;
145 
146  void SetNextWindowInfo(const char*) override
147  {
148  vtkWarningMacro("SetNextWindowInfo not implemented (WindowRemap not implemented).");
149  }
150  void* GetGenericDrawable() override
151  {
152  vtkWarningMacro("Method not implemented.");
153  return 0;
154  }
155  void SetDisplayId(void*) override { vtkWarningMacro("Method not implemented."); }
156  void* GetGenericDisplayId() override
157  {
158  vtkWarningMacro("Method not implemented.");
159  return 0;
160  }
161 
167  void SetWindowInfo(const char*) override;
168 
174  void SetParentInfo(const char*) override;
175 
176  void SetNextWindowId(void*) override
177  {
178  vtkWarningMacro("SetNextWindowId not implemented (WindowRemap not implemented).");
179  }
180 
185  bool InitializeFromCurrentContext() override;
186 
193  void SetStereoCapableWindow(vtkTypeBool capable) override;
194 
198  void MakeCurrent() override;
199 
203  bool IsCurrent() override;
204 
211  VTK_LEGACY(bool IsDrawable() override);
212 
216  void UpdateContext();
217 
221  const char* ReportCapabilities() override;
222 
226  int SupportsOpenGL() override;
227 
231  vtkTypeBool IsDirect() override;
232 
238  void SetForceMakeCurrent() override;
239 
244  vtkTypeBool GetEventPending() override;
245 
247 
250  virtual void SetupPalette(void* hDC);
251  virtual void SetupPixelFormat(void* hDC, void* dwFlags, int debug, int bpp = 16, int zbpp = 16);
253 
257  void Finalize() override;
258 
262  int GetDepthBufferSize() override;
263 
265 
271  void HideCursor() override;
272  void ShowCursor() override;
273  void SetCursorPosition(int x, int y) override;
275 
279  void SetCurrentCursor(int) override;
280 
285  virtual int GetWindowCreated();
286 
288 
291  void SetContextId(void*);
292  void* GetContextId();
293  void* GetGenericContext() override { return this->GetContextId(); }
295 
306  virtual void SetRootWindow(void*);
307 
311  virtual void* GetRootWindow();
312 
323  void SetWindowId(void*) override;
324 
328  virtual void* GetWindowId();
329  void* GetGenericWindowId() override { return this->GetWindowId(); }
330 
337  void SetParentId(void* UIView) override;
338 
344  virtual void* GetParentId();
345  void* GetGenericParentId() override { return this->GetParentId(); }
346 
348 
351  void SetPixelFormat(void* pixelFormat);
352  void* GetPixelFormat();
354 
355 protected:
357  ~vtkIOSRenderWindow() override;
358 
359  void CreateGLContext();
360 
361  void CreateAWindow() override;
362  void DestroyWindow() override;
363  void DestroyOffScreenWindow();
364 
367 
368  // IOS seems to have issues with getting RGB data
369  int ReadPixels(
370  const vtkRecti& rect, int front, int glFormat, int glType, void* data, int right = 0) override;
371 
372 private:
373  vtkIOSRenderWindow(const vtkIOSRenderWindow&) = delete;
374  void operator=(const vtkIOSRenderWindow&) = delete;
375 
376 private:
377  vtkTypeBool WindowCreated;
378  vtkTypeBool ViewCreated;
379  vtkTypeBool CursorHidden;
380 
381  vtkTypeBool ForceMakeCurrent;
382 };
383 
384 #endif
int GetDepthBufferSize() override
Get the size of the depth buffer.
OpenGL rendering window.
virtual void SetForceMakeCurrent()
If called, allow MakeCurrent() to skip cache-check when called.
virtual void SetFullScreen(vtkTypeBool)
Turn on/off rendering full screen window size.
virtual void WindowRemap()
Remap the rendering window.
void Start(void) override
Begin the rendering process.
virtual void HideCursor()
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
static vtkRenderWindow * New()
Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on...
bool InitializeFromCurrentContext() override
Initialize the render window from the information associated with the currently activated OpenGL cont...
void MakeCurrent() override
Attempt to make this window the current graphics context for the calling thread.
void SetWindowInfo(const char *) override
Dummy stubs for vtkWindow API.
virtual void SetCurrentCursor(int)
Change the shape of the cursor.
virtual bool IsCurrent()
Tells if this window is the current graphics context for the calling thread.
virtual void Finalize()
Finalize the rendering process.
void SetParentId(void *) override
Dummy stubs for vtkWindow API.
void SetNextWindowId(void *) override
Dummy stubs for vtkWindow API.
void * GetGenericDrawable() override
Dummy stubs for vtkWindow API.
int vtkTypeBool
Definition: vtkABI.h:69
virtual void SetStereoCapableWindow(vtkTypeBool capable)
Prescribe that the window be created in a stereo-capable mode.
void * GetGenericWindowId() override
Dummy stubs for vtkWindow API.
void SetWindowId(void *) override
Dummy stubs for vtkWindow API.
a simple class to control print indentation
Definition: vtkIndent.h:33
virtual void DestroyWindow()=0
Destroy a not-off-screen window.
void SetDisplayId(void *) override
Dummy stubs for vtkWindow API.
void * GetGenericContext() override
Accessors for the OpenGL context (Really an NSOpenGLContext*).
virtual void ShowCursor()
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
virtual int * GetScreenSize()
Get the current size of the screen in pixels.
Definition: vtkWindow.h:104
int SupportsOpenGL() override
Does this render window support OpenGL? 0-false, 1-true.
virtual void SetCursorPosition(int, int)
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
#define VTK_SIZEHINT(...)
const char * ReportCapabilities() override
Get report of capabilities for the render window.
void SetSize(int width, int height) override
Set the size (width and height) of the rendering window in screen coordinates (in pixels)...
void Frame() override
A termination method performed at the end of the rendering process to do things like swapping buffers...
vtkTypeBool OnScreenInitialized
void SetSize(int a[2]) override
Set the size (width and height) of the rendering window in screen coordinates (in pixels)...
virtual int * GetSize()
Get the size (width and height) of the rendering window in screen coordinates (in pixels)...
vtkTypeBool OffScreenInitialized
virtual vtkTypeBool GetEventPending()
Check to see if a mouse button has been pressed.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
IOS OpenGL rendering window.
void * GetGenericDisplayId() override
Dummy stubs for vtkWindow API.
void * GetGenericParentId() override
Dummy stubs for vtkWindow API.
void SetParentInfo(const char *) override
Dummy stubs for vtkWindow API.
void SetPosition(int a[2]) override
Set the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual void Initialize(void)
Initialize the rendering window.
virtual void CreateAWindow()=0
Create a not-off-screen window.
virtual int ReadPixels(const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right=0)
virtual vtkTypeBool IsDirect()
Is this render window using hardware acceleration? 0-false, 1-true.
virtual bool IsDrawable()
Test if the window has a valid drawable.