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);

  virtual void Start();

  virtual void Frame();

  virtual void WindowConfigure();

  virtual void Initialize();

  virtual void SetFullScreen(int);

  virtual void WindowRemap();

  virtual void PrefFullScreen();


  virtual void SetSize(int a[2]);
  virtual void SetSize(int,int);

  virtual int *GetSize();


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

  virtual int *GetScreenSize();

  virtual int *GetPosition();

  virtual void SetWindowName(const char *);

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

  virtual void SetWindowInfo(char*);

  virtual void SetParentInfo(char*);

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

  virtual bool InitializeFromCurrentContext();

  virtual void StereoUpdate();

  virtual void SetStereoCapableWindow(int capable);

  virtual void MakeCurrent();

  virtual bool IsCurrent();

  virtual bool IsDrawable();

  void UpdateContext();

  const char *ReportCapabilities();

  int IsDirect();

  virtual void SetForceMakeCurrent();

  virtual  int GetEventPending();


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

  void Finalize();


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

  virtual void SetCurrentCursor(int);

  virtual int GetViewCreated();

  virtual int GetWindowCreated();


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

  virtual void SetRootWindow(void *);

  virtual void *GetRootWindow();

  virtual void SetWindowId(void *);

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

  virtual void SetParentId(void *nsview);

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


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


  virtual void PushContext();
  virtual void PopContext();

protected:
  vtkCocoaRenderWindow();
  ~vtkCocoaRenderWindow();

  std::stack<void *> ContextStack;

  void CreateGLContext();

  void CreateAWindow();
  void DestroyWindow();
  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&) VTK_DELETE_FUNCTION;
  void operator=(const vtkCocoaRenderWindow&) VTK_DELETE_FUNCTION;

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;
  char     *Capabilities;
};

#endif