GHOST_WindowCocoa.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
#ifndef __APPLE__
#  error Apple OSX only!
#endif  // __APPLE__
 
#include "GHOST_Window.h"
 
@class CAMetalLayer;
@class CocoaMetalView;
@class CocoaOpenGLView;
@class CocoaWindow;
@class NSCursor;
@class NSScreen;
 
class GHOST_SystemCocoa;
 
class GHOST_WindowCocoa : public GHOST_Window {
 public:
  GHOST_WindowCocoa(GHOST_SystemCocoa *systemCocoa,
                    const char *title,
                    GHOST_TInt32 left,
                    GHOST_TInt32 bottom,
                    GHOST_TUns32 width,
                    GHOST_TUns32 height,
                    GHOST_TWindowState state,
                    GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
                    const bool stereoVisual = false,
                    bool is_debug = false,
                    bool dialog = false,
                    GHOST_WindowCocoa *parentWindow = 0);
 
  ~GHOST_WindowCocoa();
 
  bool getValid() const;
 
  void *getOSWindow() const;
 
  void setTitle(const char *title);
  std::string getTitle() const;
 
  void getWindowBounds(GHOST_Rect &bounds) const;
 
  void getClientBounds(GHOST_Rect &bounds) const;
 
  GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 
  GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 
  GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 
  GHOST_TWindowState getState() const;
 
  GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
 
  void screenToClient(GHOST_TInt32 inX,
                      GHOST_TInt32 inY,
                      GHOST_TInt32 &outX,
                      GHOST_TInt32 &outY) const;
 
  void clientToScreen(GHOST_TInt32 inX,
                      GHOST_TInt32 inY,
                      GHOST_TInt32 &outX,
                      GHOST_TInt32 &outY) const;
 
  void clientToScreenIntern(GHOST_TInt32 inX,
                            GHOST_TInt32 inY,
                            GHOST_TInt32 &outX,
                            GHOST_TInt32 &outY) const;
 
  void screenToClientIntern(GHOST_TInt32 inX,
                            GHOST_TInt32 inY,
                            GHOST_TInt32 &outX,
                            GHOST_TInt32 &outY) const;
 
  NSScreen *getScreen();
 
  GHOST_TSuccess setState(GHOST_TWindowState state);
 
  GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 
  NSCursor *getStandardCursor(GHOST_TStandardCursor cursor) const;
  void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
 
  bool isDialog() const;
 
  GHOST_TabletData &GetCocoaTabletData()
  {
    return m_tablet;
  }
 
  GHOST_TSuccess setProgressBar(float progress);
 
  GHOST_TSuccess endProgressBar();
 
  void setNativePixelSize(void);
 
  GHOST_TSuccess beginFullScreen() const
  {
    return GHOST_kFailure;
  }
 
  GHOST_TSuccess endFullScreen() const
  {
    return GHOST_kFailure;
  }
 
  CocoaWindow *getCocoaWindow() const
  {
    return m_window;
  };
 
  /* Internal value to ensure proper redraws during animations */
  void setImmediateDraw(bool value)
  {
    m_immediateDraw = value;
  }
  bool getImmediateDraw(void) const
  {
    return m_immediateDraw;
  }
 
 protected:
  GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);
 
  GHOST_TSuccess invalidate();
 
  GHOST_TSuccess setWindowCursorVisibility(bool visible);
 
  GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
 
  GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
  GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor shape);
 
  GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap,
                                            GHOST_TUns8 *mask,
                                            int sizex,
                                            int sizey,
                                            int hotX,
                                            int hotY,
                                            bool canInvertColor);
 
  CocoaWindow *m_window;
 
  CocoaOpenGLView *m_openGLView;
  CocoaMetalView *m_metalView;
  CAMetalLayer *m_metalLayer;
 
  GHOST_SystemCocoa *m_systemCocoa;
 
  NSCursor *m_customCursor;
 
  GHOST_TabletData m_tablet;
 
  bool m_immediateDraw;
  bool m_debug_context;  // for debug messages during context setup
  bool m_is_dialog;
};