VTK
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 "vtkRenderingOpenGL2Module.h" // For export macro
46 #include "vtkOpenGLRenderWindow.h"
47 
48 class VTKRENDERINGOPENGL2_EXPORT vtkIOSRenderWindow : public vtkOpenGLRenderWindow
49 {
50 public:
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 
103  void SetSize(int a[2]) override;
104  void SetSize(int,int) override;
106 
110  int *GetSize() VTK_SIZEHINT(2) override;
111 
113 
116  void SetPosition(int a[2]) override;
117  void SetPosition(int,int) override;
119 
123  int *GetScreenSize() VTK_SIZEHINT(2) override;
124 
128  int *GetPosition() VTK_SIZEHINT(2) override;
129 
134  void SetWindowName(const char *) override;
135 
136  void SetNextWindowInfo(const char *) override
137  {
138  vtkWarningMacro("SetNextWindowInfo not implemented (WindowRemap not implemented).");
139  }
140  void* GetGenericDrawable() override
141  {
142  vtkWarningMacro("Method not implemented.");
143  return 0;
144  }
145  void SetDisplayId(void*) override
146  {
147  vtkWarningMacro("Method not implemented.");
148  }
149  void *GetGenericDisplayId() override
150  {
151  vtkWarningMacro("Method not implemented.");
152  return 0;
153  }
154 
160  void SetWindowInfo(const char*) override;
161 
167  void SetParentInfo(const char*) override;
168 
169  void SetNextWindowId(void*) override
170  {
171  vtkWarningMacro("SetNextWindowId not implemented (WindowRemap not implemented).");
172  }
173 
179 
186  void SetStereoCapableWindow(vtkTypeBool capable) override;
187 
191  void MakeCurrent() override;
192 
196  bool IsCurrent() override;
197 
204  bool IsDrawable() override;
205 
210 
214  const char *ReportCapabilities() override;
215 
219  int SupportsOpenGL() override;
220 
224  int IsDirect() override;
225 
231  void SetForceMakeCurrent() override;
232 
237  int GetEventPending() override;
238 
240 
243  virtual void SetupPalette(void *hDC);
244  virtual void SetupPixelFormat(void *hDC, void *dwFlags, int debug,
245  int bpp=16, int zbpp=16);
247 
251  void Finalize() override;
252 
256  int GetDepthBufferSize() override;
257 
259 
265  void HideCursor() override;
266  void ShowCursor() override;
267  void SetCursorPosition(int x, int y) override;
269 
273  void SetCurrentCursor(int) override;
274 
279  virtual int GetWindowCreated();
280 
282 
285  void SetContextId(void *);
286  void *GetContextId();
287  void *GetGenericContext() override {return this->GetContextId();}
289 
300  virtual void SetRootWindow(void *);
301 
305  virtual void *GetRootWindow();
306 
317  void SetWindowId(void *) override;
318 
322  virtual void *GetWindowId();
323  void *GetGenericWindowId() override {return this->GetWindowId();}
324 
331  void SetParentId(void *UIView) override;
332 
338  virtual void *GetParentId();
339  void *GetGenericParentId() override { return this->GetParentId(); }
340 
342 
345  void SetPixelFormat(void *pixelFormat);
346  void *GetPixelFormat();
348 
349 protected:
352 
354 
355  void CreateAWindow() override;
356  void DestroyWindow() override;
358 
361 
362  // IOS seems to have issues with getting RGB data
364  const vtkRecti& rect, int front, int glFormat, int glType, void* data, int right=0) override;
365 
366 private:
367  vtkIOSRenderWindow(const vtkIOSRenderWindow&) = delete;
368  void operator=(const vtkIOSRenderWindow&) = delete;
369 
370 private:
371  int WindowCreated;
372  int ViewCreated;
373  int CursorHidden;
374 
375  int ForceMakeCurrent;
376 };
377 
378 #endif
vtkIOSRenderWindow::SetFullScreen
void SetFullScreen(vtkTypeBool) override
Change the window to fill the entire screen.
vtkIOSRenderWindow::CreateGLContext
void CreateGLContext()
vtkIOSRenderWindow::UpdateContext
void UpdateContext()
Update this window's OpenGL context, e.g.
vtkIOSRenderWindow::PrefFullScreen
virtual void PrefFullScreen()
Set the preferred window size to full screen.
vtkIOSRenderWindow::SetRootWindow
virtual void SetRootWindow(void *)
Sets the NSWindow* associated with this vtkRenderWindow.
vtkIOSRenderWindow::SetParentInfo
void SetParentInfo(const char *) override
See the documentation for SetParentId().
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkIOSRenderWindow::Start
void Start() override
Begin the rendering process.
vtkIOSRenderWindow::GetSize
int * GetSize() override
Get the current size of the window in pixels.
vtkIOSRenderWindow::SetCursorPosition
void SetCursorPosition(int x, int y) override
vtkIOSRenderWindow::OffScreenInitialized
int OffScreenInitialized
Definition: vtkIOSRenderWindow.h:359
vtkIOSRenderWindow::GetGenericDisplayId
void * GetGenericDisplayId() override
Definition: vtkIOSRenderWindow.h:149
vtkIOSRenderWindow::Frame
void Frame() override
Finish the rendering process.
vtkIOSRenderWindow::SetForceMakeCurrent
void SetForceMakeCurrent() override
If called, allow MakeCurrent() to skip cache-check when called.
vtkIOSRenderWindow::New
static vtkIOSRenderWindow * New()
vtkIOSRenderWindow::GetContextId
void * GetContextId()
vtkIOSRenderWindow::GetWindowCreated
virtual int GetWindowCreated()
Get the WindowCreated flag.
vtkIOSRenderWindow::IsDrawable
bool IsDrawable() override
Test if the window has a valid drawable.
vtkIOSRenderWindow::SetContextId
void SetContextId(void *)
Accessors for the OpenGL context (Really an NSOpenGLContext*).
vtkIOSRenderWindow::DestroyOffScreenWindow
void DestroyOffScreenWindow()
vtkIOSRenderWindow::GetPixelFormat
void * GetPixelFormat()
vtkIOSRenderWindow::vtkIOSRenderWindow
vtkIOSRenderWindow()
vtkIOSRenderWindow::SetParentId
void SetParentId(void *UIView) override
Set the UIView* for the vtkRenderWindow to be parented within.
vtkIOSRenderWindow::Initialize
void Initialize() override
Initialize the window for rendering.
vtkIOSRenderWindow::SetWindowInfo
void SetWindowInfo(const char *) override
Set this RenderWindow's window id to a pre-existing window.
vtkIOSRenderWindow::ShowCursor
void ShowCursor() override
vtkIOSRenderWindow::WindowConfigure
virtual void WindowConfigure()
Specify various window parameters.
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkIOSRenderWindow::GetWindowId
virtual void * GetWindowId()
Returns the UIView* associated with this vtkRenderWindow.
vtkIOSRenderWindow::IsDirect
int IsDirect() override
Is this render window using hardware acceleration? 0-false, 1-true.
vtkIOSRenderWindow::SetSize
void SetSize(int, int) override
vtkIOSRenderWindow::SetDisplayId
void SetDisplayId(void *) override
Dummy stubs for vtkWindow API.
Definition: vtkIOSRenderWindow.h:145
vtkIOSRenderWindow::IsCurrent
bool IsCurrent() override
Tells if this window is the current OpenGL context for the calling thread.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkIOSRenderWindow::ReportCapabilities
const char * ReportCapabilities() override
Get report of capabilities for the render window.
vtkIOSRenderWindow::DestroyWindow
void DestroyWindow() override
Destroy a not-off-screen window.
vtkIOSRenderWindow::GetGenericWindowId
void * GetGenericWindowId() override
Definition: vtkIOSRenderWindow.h:323
vtkIOSRenderWindow::SetCurrentCursor
void SetCurrentCursor(int) override
Change the shape of the cursor.
vtkIOSRenderWindow::GetEventPending
int GetEventPending() override
Check to see if an event is pending for this window.
vtkIOSRenderWindow::SetWindowId
void SetWindowId(void *) override
Sets the UIView* associated with this vtkRenderWindow.
vtkIOSRenderWindow::SetSize
void SetSize(int a[2]) override
Set the size of the window in pixels.
vtkIOSRenderWindow::WindowRemap
void WindowRemap() override
Remap the window.
vtkIOSRenderWindow::GetGenericDrawable
void * GetGenericDrawable() override
Definition: vtkIOSRenderWindow.h:140
vtkIOSRenderWindow::SetPixelFormat
void SetPixelFormat(void *pixelFormat)
Accessors for the pixel format object (Really an NSOpenGLPixelFormat*).
vtkIOSRenderWindow::GetRootWindow
virtual void * GetRootWindow()
Returns the NSWindow* associated with this vtkRenderWindow.
vtkIOSRenderWindow::CreateAWindow
void CreateAWindow() override
Create a not-off-screen window.
vtkIOSRenderWindow::~vtkIOSRenderWindow
~vtkIOSRenderWindow() override
vtkIOSRenderWindow::InitializeFromCurrentContext
bool InitializeFromCurrentContext() override
Initialize the render window from the information associated with the currently activated OpenGL cont...
vtkIOSRenderWindow::ReadPixels
int ReadPixels(const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right=0) override
vtkIOSRenderWindow::HideCursor
void HideCursor() override
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
vtkIOSRenderWindow::GetGenericContext
void * GetGenericContext() override
Definition: vtkIOSRenderWindow.h:287
vtkIOSRenderWindow::MakeCurrent
void MakeCurrent() override
Make this windows OpenGL context the current context.
vtkIOSRenderWindow::Finalize
void Finalize() override
Clean up device contexts, rendering contexts, etc.
vtkIOSRenderWindow::SetNextWindowId
void SetNextWindowId(void *) override
Definition: vtkIOSRenderWindow.h:169
vtkRecti
Definition: vtkRect.h:324
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:54
vtkIOSRenderWindow::GetParentId
virtual void * GetParentId()
Get the parent UIView* for this vtkRenderWindow.
vtkIOSRenderWindow::OnScreenInitialized
int OnScreenInitialized
Definition: vtkIOSRenderWindow.h:360
vtkIOSRenderWindow::SupportsOpenGL
int SupportsOpenGL() override
Does this render window support OpenGL? 0-false, 1-true.
vtkIOSRenderWindow::GetDepthBufferSize
int GetDepthBufferSize() override
Get the size of the depth buffer.
vtkIOSRenderWindow::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIOSRenderWindow::GetGenericParentId
void * GetGenericParentId() override
Definition: vtkIOSRenderWindow.h:339
vtkIOSRenderWindow
IOS OpenGL rendering window.
Definition: vtkIOSRenderWindow.h:49
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkIOSRenderWindow::SetupPixelFormat
virtual void SetupPixelFormat(void *hDC, void *dwFlags, int debug, int bpp=16, int zbpp=16)
vtkIOSRenderWindow::SetupPalette
virtual void SetupPalette(void *hDC)
Initialize OpenGL for this window.
vtkOpenGLRenderWindow.h
vtkIOSRenderWindow::SetStereoCapableWindow
void SetStereoCapableWindow(vtkTypeBool capable) override
Prescribe that the window be created in a stereo-capable mode.