GHOST_WindowCocoa.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#ifndef __APPLE__
#  error Apple OSX only!
#endif  // __APPLE__
 
#include "GHOST_Window.hh"
#ifdef WITH_INPUT_IME
#  include "GHOST_Event.hh"
#endif
 
@class CAMetalLayer;
@class CocoaMetalView;
@class CocoaOpenGLView;
@class BlenderWindow;
@class NSCursor;
@class NSScreen;
 
class GHOST_SystemCocoa;
 
class GHOST_WindowCocoa : public GHOST_Window {
 public:
  GHOST_WindowCocoa(GHOST_SystemCocoa *systemCocoa,
                    const char *title,
                    int32_t left,
                    int32_t bottom,
                    uint32_t width,
                    uint32_t height,
                    GHOST_TWindowState state,
                    GHOST_TDrawingContextType type,
                    const GHOST_ContextParams &context_params,
                    bool dialog,
                    GHOST_WindowCocoa *parent_window,
                    const GHOST_GPUDevice &preferred_device);

  ~GHOST_WindowCocoa() override;

  bool getValid() const override;

  void *getOSWindow() const override;

  void setTitle(const char *title) override;
  std::string getTitle() const override;

  GHOST_TSuccess setPath(const char *filepath) override;

  GHOST_TSuccess applyWindowDecorationStyle() override;

  void getWindowBounds(GHOST_Rect &bounds) const override;

  void getClientBounds(GHOST_Rect &bounds) const override;

  GHOST_TSuccess setClientWidth(uint32_t width) override;

  GHOST_TSuccess setClientHeight(uint32_t height) override;

  GHOST_TSuccess setClientSize(uint32_t width, uint32_t height) override;

  GHOST_TWindowState getState() const override;

  GHOST_TSuccess setModifiedState(bool is_unsaved_changes) override;

  void screenToClient(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const override;

  void clientToScreen(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const override;

  void clientToScreenIntern(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const;

  void screenToClientIntern(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const;

  NSScreen *getScreen() const;

  static NSScreen *getPrimaryScreen();

  GHOST_TSuccess setState(GHOST_TWindowState state) override;

  GHOST_TSuccess setOrder(GHOST_TWindowOrder order) override;
 
  NSCursor *getStandardCursor(GHOST_TStandardCursor cursor) const;
  void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
 
  bool isDialog() const override;
 
  GHOST_TabletData &GetCocoaTabletData()
  {
    return tablet_;
  }

  GHOST_TSuccess setProgressBar(float progress) override;

  GHOST_TSuccess endProgressBar() override;
 
  void setNativePixelSize();

  BlenderWindow *getViewWindow() const
  {
    return window_;
  };
 
  /* Internal value to ensure proper redraws during animations */
  void setImmediateDraw(bool value)
  {
    immediate_draw_ = value;
  }
  bool getImmediateDraw() const
  {
    return immediate_draw_;
  }
 
#ifdef WITH_INPUT_IME
  void beginIME(int32_t x, int32_t y, int32_t w, int32_t h, bool completed) override;
  void endIME() override;
#endif /* WITH_INPUT_IME */
 
 protected:
  GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type) override;

  GHOST_TSuccess invalidate() override;

  GHOST_TSuccess setWindowCursorVisibility(bool visible) override;

  GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) override;

  GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) override;
  GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor shape) override;

  GHOST_TSuccess setWindowCustomCursorShape(const uint8_t *bitmap,
                                            const uint8_t *mask,
                                            const int size[2],
                                            const int hot_spot[2],
                                            bool can_invert_color) override;

  BlenderWindow *window_;

  CocoaOpenGLView *opengl_view_;
  CocoaMetalView *metal_view_;
  CAMetalLayer *metal_layer_;

  GHOST_SystemCocoa *system_cocoa_;
 
  NSCursor *custom_cursor_;
 
  GHOST_TabletData tablet_;
 
  bool immediate_draw_;
  bool is_dialog_;
  GHOST_GPUDevice preferred_device_;
};
 
#ifdef WITH_INPUT_IME
class GHOST_EventIME : public GHOST_Event {
 public:
  GHOST_EventIME(uint64_t msec,
                 GHOST_TEventType type,
                 GHOST_IWindow *window,
                 const void *customdata)
      : GHOST_Event(msec, type, window)
  {
    this->data_ = customdata;
  }
};
 
typedef int GHOST_ImeStateFlagCocoa;
enum {
  GHOST_IME_INPUT_FOCUSED = (1 << 0),
  GHOST_IME_ENABLED = (1 << 1),
  GHOST_IME_COMPOSING = (1 << 2),
  GHOST_IME_KEY_CONTROL_CHAR = (1 << 3),
  GHOST_IME_COMPOSITION_EVENT = (1 << 4),  // For Korean input
  GHOST_IME_RESULT_EVENT = (1 << 5)        // For Korean input
};
#endif /* WITH_INPUT_IME */