vtkCocoaRenderWindow.h

Go to the documentation of this file.

/*=========================================================================

Program:   Visualization Toolkit
Module:    vtkCocoaRenderWindow.h

Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkCocoaRenderWindow_h
#define vtkCocoaRenderWindow_h

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

class VTKRENDERINGOPENGL2_EXPORT vtkCocoaRenderWindow : public vtkOpenGLRenderWindow
{
public:
  static vtkCocoaRenderWindow *New();
  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 a[2]) override;
  void SetSize(int,int) override;

  int *GetSize() VTK_SIZEHINT(2) override;


  void SetPosition(int a[2]) override;
  void SetPosition(int,int) override;

  int *GetScreenSize() VTK_SIZEHINT(2) override;

  int *GetPosition() VTK_SIZEHINT(2) override;

  void SetWindowName(const char *) override;

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

  void SetWindowInfo(const char*) override;

  void SetParentInfo(const char*) override;

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

  bool InitializeFromCurrentContext() override;

  bool GetPlatformSupportsRenderWindowSharing() override { return true; };

  void SetStereoCapableWindow(vtkTypeBool capable) override;

  void MakeCurrent() override;

  bool IsCurrent() override;

  bool IsDrawable() override;

  void UpdateContext();

  const char *ReportCapabilities() override;

  int IsDirect() override;

  void SetForceMakeCurrent() override;

   int 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 int GetViewCreated();

  virtual int GetWindowCreated();


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

  virtual void SetRootWindow(void *);

  virtual void *GetRootWindow();

  void SetWindowId(void *) override;

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

  void SetParentId(void *nsview) override;

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

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


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


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

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

  std::stack<void *> ContextStack;

  void CreateGLContext();

  void CreateAWindow() override;
  void DestroyWindow() override;
  void DestroyOffScreenWindow();

  int OffScreenInitialized;
  int 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*

  int      WindowCreated;
  int      ViewCreated;
  int      CursorHidden;

  int      ForceMakeCurrent;

  bool     WantsBestResolution;
};

#endif