VTK  9.0.1
vtkCocoaRenderWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkCocoaRenderWindow.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 vtkCocoaRenderWindow_h
43 #define vtkCocoaRenderWindow_h
44 
45 #include "vtkOpenGLRenderWindow.h"
46 #include "vtkRenderingOpenGL2Module.h" // For export macro
47 #include <stack> // for ivar
48 
49 class VTKRENDERINGOPENGL2_EXPORT vtkCocoaRenderWindow : public vtkOpenGLRenderWindow
50 {
51 public:
52  static vtkCocoaRenderWindow* New();
54  void PrintSelf(ostream& os, vtkIndent indent) override;
55 
59  void Start() override;
60 
64  void Frame() override;
65 
69  virtual void WindowConfigure();
70 
79  void Initialize() override;
80 
87  void SetFullScreen(vtkTypeBool) override;
88 
92  void WindowRemap() override;
93 
98  virtual void PrefFullScreen();
99 
101 
109  void SetSize(int width, int height) override;
110  void SetSize(int a[2]) override { this->SetSize(a[0], a[1]); }
112 
117  int* GetSize() VTK_SIZEHINT(2) override;
118 
120 
125  void SetPosition(int x, int y) override;
126  void SetPosition(int a[2]) override { this->SetPosition(a[0], a[1]); }
128 
133  int* GetScreenSize() VTK_SIZEHINT(2) override;
134 
139  int* GetPosition() VTK_SIZEHINT(2) override;
140 
145  void SetWindowName(const char*) override;
146 
147  void SetNextWindowInfo(const char*) override
148  {
149  vtkDebugMacro("SetNextWindowInfo not implemented (WindowRemap not implemented).");
150  }
151  void* GetGenericDrawable() override
152  {
153  vtkDebugMacro("Method not implemented.");
154  return nullptr;
155  }
156  void SetDisplayId(void*) override
157  {
158  // no-op
159  vtkDebugMacro("Method not implemented.");
160  }
161  void* GetGenericDisplayId() override
162  {
163  vtkDebugMacro("Method not implemented.");
164  return nullptr;
165  }
166 
172  void SetWindowInfo(const char*) override;
173 
179  void SetParentInfo(const char*) override;
180 
181  void SetNextWindowId(void*) override
182  {
183  vtkDebugMacro("SetNextWindowId not implemented (WindowRemap not implemented).");
184  }
185 
190  bool InitializeFromCurrentContext() override;
191 
195  bool GetPlatformSupportsRenderWindowSharing() override { return true; }
196 
203  void SetStereoCapableWindow(vtkTypeBool capable) override;
204 
208  void MakeCurrent() override;
209 
213  bool IsCurrent() override;
214 
221  VTK_LEGACY(bool IsDrawable() override);
222 
226  void UpdateContext();
227 
231  const char* ReportCapabilities() override;
232 
236  vtkTypeBool IsDirect() override;
237 
243  void SetForceMakeCurrent() override;
244 
249  vtkTypeBool GetEventPending() override;
250 
252 
255  virtual void SetupPalette(void* hDC);
256  virtual void SetupPixelFormat(void* hDC, void* dwFlags, int debug, int bpp = 16, int zbpp = 16);
258 
262  void Finalize() 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 vtkTypeBool GetViewCreated();
286 
291  virtual vtkTypeBool GetWindowCreated();
292 
294 
297  void SetContextId(void*);
298  void* GetContextId();
299  void* GetGenericContext() override { return this->GetContextId(); }
301 
312  virtual void SetRootWindow(void*);
313 
317  virtual void* GetRootWindow();
318 
329  void SetWindowId(void*) override;
330 
334  virtual void* GetWindowId();
335  void* GetGenericWindowId() override { return this->GetWindowId(); }
336 
343  void SetParentId(void* nsview) override;
344 
350  virtual void* GetParentId();
351  void* GetGenericParentId() override { return this->GetParentId(); }
352 
363  void SetWantsBestResolution(bool wantsBest);
364  bool GetWantsBestResolution();
365 
372  void SetConnectContextToNSView(bool connect);
373  bool GetConnectContextToNSView();
374 
376 
379  void SetPixelFormat(void* pixelFormat);
380  void* GetPixelFormat();
382 
384 
391  void PushContext() override;
392  void PopContext() override;
394 
395 protected:
397  ~vtkCocoaRenderWindow() override;
398 
399  std::stack<void*> ContextStack;
400 
401  void CreateGLContext();
402 
403  void CreateAWindow() override;
404  void DestroyWindow() override;
406 
408 
412  void SetCocoaManager(void* manager);
413  void* GetCocoaManager();
415 
416  void SetCocoaServer(void* server); // Really a vtkCocoaServer*
417  void* GetCocoaServer();
418 
419 private:
421  void operator=(const vtkCocoaRenderWindow&) = delete;
422 
423 private:
424  // Important: this class cannot contain Objective-C instance
425  // variables for 2 reasons:
426  // 1) C++ files include this header
427  // 2) because of garbage collection (the GC scanner does not scan objects create by C++'s new)
428  // Instead, use the CocoaManager dictionary to keep a collection
429  // of what would otherwise be Objective-C instance variables.
430  void* CocoaManager; // Really an NSMutableDictionary*
431 
432  vtkTypeBool WindowCreated;
433  vtkTypeBool ViewCreated;
434  vtkTypeBool CursorHidden;
435 
436  vtkTypeBool ForceMakeCurrent;
437 
438  bool WantsBestResolution;
439  bool ConnectContextToNSView;
440 };
441 
442 #endif
vtkOpenGLRenderWindow::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCocoaRenderWindow::ContextStack
std::stack< void * > ContextStack
Definition: vtkCocoaRenderWindow.h:399
vtkX3D::connect
@ connect
Definition: vtkX3D.h:182
vtkRenderWindow::SetWindowInfo
void SetWindowInfo(const char *) override
Definition: vtkRenderWindow.h:623
vtkWindow::GetSize
virtual int * GetSize()
Get the size (width and height) of the rendering window in screen coordinates (in pixels).
vtkRenderWindow::SetWindowId
void SetWindowId(void *) override
Definition: vtkRenderWindow.h:615
vtkCocoaRenderWindow::GetGenericDrawable
void * GetGenericDrawable() override
Definition: vtkCocoaRenderWindow.h:151
vtkRenderWindow::SetForceMakeCurrent
virtual void SetForceMakeCurrent()
If called, allow MakeCurrent() to skip cache-check when called.
Definition: vtkRenderWindow.h:672
vtkRenderWindow::WindowRemap
virtual void WindowRemap()
Remap the rendering window.
Definition: vtkRenderWindow.h:403
vtkOpenGLRenderWindow::PopContext
virtual void PopContext()
Definition: vtkOpenGLRenderWindow.h:374
vtkCocoaRenderWindow::SetDisplayId
void SetDisplayId(void *) override
Dummy stubs for vtkWindow API.
Definition: vtkCocoaRenderWindow.h:156
vtkRenderWindow::ShowCursor
virtual void ShowCursor()
Definition: vtkRenderWindow.h:211
vtkRenderWindow::HideCursor
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...
Definition: vtkRenderWindow.h:210
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
vtkRenderWindow::Finalize
virtual void Finalize()
Finalize the rendering process.
Definition: vtkRenderWindow.h:176
vtkCocoaRenderWindow::GetGenericDisplayId
void * GetGenericDisplayId() override
Definition: vtkCocoaRenderWindow.h:161
vtkCocoaRenderWindow::GetGenericContext
void * GetGenericContext() override
Definition: vtkCocoaRenderWindow.h:299
vtkX3D::height
@ height
Definition: vtkX3D.h:260
vtkOpenGLRenderWindow::InitializeFromCurrentContext
bool InitializeFromCurrentContext() override
Initialize the render window from the information associated with the currently activated OpenGL cont...
vtkRenderWindow::MakeCurrent
void MakeCurrent() override
Attempt to make this window the current graphics context for the calling thread.
Definition: vtkRenderWindow.h:651
vtkRenderWindow::IsDirect
virtual vtkTypeBool IsDirect()
Is this render window using hardware acceleration? 0-false, 1-true.
Definition: vtkRenderWindow.h:687
vtkRenderWindow::GetEventPending
virtual vtkTypeBool GetEventPending()
Check to see if a mouse button has been pressed.
Definition: vtkRenderWindow.h:556
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCocoaRenderWindow::SetNextWindowId
void SetNextWindowId(void *) override
Definition: vtkCocoaRenderWindow.h:181
vtkRenderWindow::SetCurrentCursor
virtual void SetCurrentCursor(int)
Change the shape of the cursor.
vtkRenderWindow::SetParentInfo
void SetParentInfo(const char *) override
Definition: vtkRenderWindow.h:625
vtkWindow::GetScreenSize
virtual int * GetScreenSize()
Get the current size of the screen in pixels.
Definition: vtkWindow.h:104
vtkRenderWindow::SetStereoCapableWindow
virtual void SetStereoCapableWindow(vtkTypeBool capable)
vtkCocoaRenderWindow::OnScreenInitialized
vtkTypeBool OnScreenInitialized
Definition: vtkCocoaRenderWindow.h:405
vtkRenderWindow::SetParentId
void SetParentId(void *) override
Definition: vtkRenderWindow.h:617
vtkCocoaRenderWindow::GetPlatformSupportsRenderWindowSharing
bool GetPlatformSupportsRenderWindowSharing() override
Does this platform support render window data sharing.
Definition: vtkCocoaRenderWindow.h:195
vtkCocoaRenderWindow::SetPosition
void SetPosition(int a[2]) override
Definition: vtkCocoaRenderWindow.h:126
vtkCocoaRenderWindow::SetSize
void SetSize(int a[2]) override
Definition: vtkCocoaRenderWindow.h:110
vtkCocoaRenderWindow
Cocoa OpenGL rendering window.
Definition: vtkCocoaRenderWindow.h:49
vtkOpenGLRenderWindow::ReportCapabilities
const char * ReportCapabilities() override
Get report of capabilities for the render window.
vtkOpenGLRenderWindow::SetSize
void SetSize(int width, int height) override
Set the size (width and height) of the rendering window in screen coordinates (in pixels).
vtkRenderWindow::SetCursorPosition
virtual void SetCursorPosition(int, int)
Definition: vtkRenderWindow.h:212
vtkCocoaRenderWindow::GetGenericParentId
void * GetGenericParentId() override
Definition: vtkCocoaRenderWindow.h:351
vtkOpenGLRenderWindow::Frame
void Frame() override
A termination method performed at the end of the rendering process to do things like swapping buffers...
vtkRenderWindow::IsDrawable
virtual bool IsDrawable()
Test if the window has a valid drawable.
vtkRenderWindow::SetFullScreen
virtual void SetFullScreen(vtkTypeBool)
Turn on/off rendering full screen window size.
Definition: vtkRenderWindow.h:227
vtkOpenGLRenderWindow::DestroyWindow
virtual void DestroyWindow()=0
Destroy a not-off-screen window.
vtkCocoaRenderWindow::GetGenericWindowId
void * GetGenericWindowId() override
Definition: vtkCocoaRenderWindow.h:335
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:51
vtkOpenGLRenderWindow::Start
void Start(void) override
Begin the rendering process.
vtkRenderWindow::IsCurrent
virtual bool IsCurrent()
Tells if this window is the current graphics context for the calling thread.
Definition: vtkRenderWindow.h:657
vtkRenderWindow::New
static vtkRenderWindow * New()
Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on,...
vtkOpenGLRenderWindow::PushContext
virtual void PushContext()
Ability to push and pop this window's context as the current context.
Definition: vtkOpenGLRenderWindow.h:373
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkOpenGLRenderWindow::Initialize
virtual void Initialize(void)
Initialize the rendering window.
Definition: vtkOpenGLRenderWindow.h:342
vtkOpenGLRenderWindow::CreateAWindow
virtual void CreateAWindow()=0
Create a not-off-screen window.
vtkOpenGLRenderWindow.h