vtkCocoaRenderWindow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCocoaRenderWindow_h
#define vtkCocoaRenderWindow_h

#include "vtkOpenGLRenderWindow.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO
#include <stack>                       // for ivar

VTK_ABI_NAMESPACE_BEGIN
class vtkOverrideAttribute;
class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkCocoaRenderWindow : public vtkOpenGLRenderWindow
{
public:
  static vtkCocoaRenderWindow* New();
  VTK_NEWINSTANCE
  static vtkOverrideAttribute* CreateOverrideAttributes();
  vtkTypeMacro(vtkCocoaRenderWindow, vtkOpenGLRenderWindow);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Start() override;

  void Frame() override;

  virtual void WindowConfigure();

  void Initialize() override;

  void SetFullScreen(vtkTypeBool) override;

  void WindowRemap() override;

  virtual void PrefFullScreen();


  void SetSize(int width, int height) override;
  void SetSize(int a[2]) override { this->SetSize(a[0], a[1]); }

  int* GetSize() VTK_SIZEHINT(2) override;


  void SetPosition(int x, int y) override;
  void SetPosition(int a[2]) override { this->SetPosition(a[0], a[1]); }

  int* GetScreenSize() VTK_SIZEHINT(2) override;

  int* GetPosition() VTK_SIZEHINT(2) override;

  void SetWindowName(const char*) override;

  void SetNextWindowInfo(const char*) override
  {
    vtkDebugMacro("SetNextWindowInfo not implemented (WindowRemap not implemented).");
  }
  void* GetGenericDrawable() override
  {
    vtkDebugMacro("Method not implemented.");
    return nullptr;
  }

  void SetDisplayId(void* displayId) override
  {
    this->DisplayIndex = displayId ? *(reinterpret_cast<int*>(displayId)) : 0;
  }

  void* GetGenericDisplayId() override
  {
    vtkDebugMacro("Method not implemented.");
    return nullptr;
  }

  void SetWindowInfo(const char*) override;

  void SetParentInfo(const char*) override;

  void SetNextWindowId(void*) override
  {
    vtkDebugMacro("SetNextWindowId not implemented (WindowRemap not implemented).");
  }

  bool InitializeFromCurrentContext() override;

  bool GetPlatformSupportsRenderWindowSharing() override { return true; }

  void SetStereoCapableWindow(vtkTypeBool capable) override;

  void MakeCurrent() override;

  void ReleaseCurrent() override;

  bool IsCurrent() override;

  void UpdateContext();

  const char* ReportCapabilities() override;

  vtkTypeBool IsDirect() override;

  void SetForceMakeCurrent() override;

  vtkTypeBool GetEventPending() override;


  virtual void SetupPalette(void* hDC);
  virtual void SetupPixelFormat(void* hDC, void* dwFlags, int debug, int bpp = 16, int zbpp = 16);

  void Finalize() override;


  void HideCursor() override;
  void ShowCursor() override;
  void SetCursorPosition(int x, int y) override;

  void SetCurrentCursor(int) override;

  virtual vtkTypeBool GetViewCreated();

  virtual vtkTypeBool GetWindowCreated();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetContextId(void*);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void* GetContextId();
  void* GetGenericContext() override { return this->GetContextId(); }

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  virtual void SetRootWindow(void*);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  virtual void* GetRootWindow();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetWindowId(void*) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  virtual void* GetWindowId();
  void* GetGenericWindowId() override { return this->GetWindowId(); }

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetParentId(void* nsview) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  virtual void* GetParentId();
  void* GetGenericParentId() override { return this->GetParentId(); }

  void SetWantsBestResolution(bool wantsBest);
  bool GetWantsBestResolution();

  void SetConnectContextToNSView(bool connect);
  bool GetConnectContextToNSView();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetPixelFormat(void* pixelFormat);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void* GetPixelFormat();


  void PushContext() override;
  void PopContext() override;

  void Render() override;

protected:
  vtkCocoaRenderWindow();
  ~vtkCocoaRenderWindow() override;

  std::stack<void*> ContextStack;

  void CreateGLContext();

  void CreateAWindow() override;
  void DestroyWindow() override;
  vtkTypeBool OnScreenInitialized;


  void SetCocoaManager(void* manager);
  void* GetCocoaManager();

  void SetCocoaServer(void* server); // Really a vtkCocoaServer*
  void* GetCocoaServer();

private:
  vtkCocoaRenderWindow(const vtkCocoaRenderWindow&) = delete;
  void operator=(const vtkCocoaRenderWindow&) = delete;

private:
  // Important: this class cannot contain Objective-C instance
  // variables for 2 reasons:
  // 1) C++ files include this header
  // 2) because of garbage collection (the GC scanner does not scan objects create by C++'s new)
  // Instead, use the CocoaManager dictionary to keep a collection
  // of what would otherwise be Objective-C instance variables.
  void* CocoaManager; // Really an NSMutableDictionary*

  vtkTypeBool WindowCreated;
  vtkTypeBool ViewCreated;
  vtkTypeBool CursorHidden;

  vtkTypeBool ForceMakeCurrent;

  bool WantsBestResolution;
  bool ConnectContextToNSView;

  int DisplayIndex = 0;
};

#define vtkCocoaRenderWindow_OVERRIDE_ATTRIBUTES vtkCocoaRenderWindow::CreateOverrideAttributes()
VTK_ABI_NAMESPACE_END
#endif