GHOST_System.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
 
#include "GHOST_ISystem.hh"
 
#include "GHOST_Buttons.hh"
#include "GHOST_Debug.hh"
#include "GHOST_EventManager.hh"
#include "GHOST_ModifierKeys.hh"
#ifdef WITH_GHOST_DEBUG
#  include "GHOST_EventPrinter.hh"
#endif  // WITH_GHOST_DEBUG
 
class GHOST_Event;
class GHOST_TimerManager;
class GHOST_Window;
class GHOST_WindowManager;
#ifdef WITH_INPUT_NDOF
class GHOST_NDOFManager;
#endif

class GHOST_System : public GHOST_ISystem {
 protected:
  GHOST_System();

  ~GHOST_System() override;
 
 public:
  /***************************************************************************************
   * Time(r) functionality
   ***************************************************************************************/

  GHOST_ITimerTask *installTimer(uint64_t delay,
                                 uint64_t interval,
                                 GHOST_TimerProcPtr timer_proc,
                                 GHOST_TUserDataPtr user_data = nullptr) override;
  GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) override;
 
  /***************************************************************************************
   * Display/window management functionality
   ***************************************************************************************/

  GHOST_TSuccess disposeWindow(GHOST_IWindow *window) override;

  GHOST_IContext *createOffscreenContext(GHOST_GPUSettings gpu_settings) override = 0;

  bool validWindow(GHOST_IWindow *window) override;

  bool useNativePixel() override;
  bool native_pixel_;

  void useWindowFocus(const bool use_focus) override;
 
  bool window_focus_;

  void setAutoFocus(const bool auto_focus) override;
  bool auto_focus_;

  GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y) override;
 
  /***************************************************************************************
   * Event management functionality
   ***************************************************************************************/


  void dispatchEvents() override;
  GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer) override;
  GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer) override;
 
  /***************************************************************************************
   * Cursor management functionality
   ***************************************************************************************/
 
  /* Client relative functions use a default implementation
   * that converts from screen-coordinates to client coordinates.
   * Implementations may override. */

  GHOST_TSuccess getCursorPositionClientRelative(const GHOST_IWindow *window,
                                                 int32_t &x,
                                                 int32_t &y) const override;
  GHOST_TSuccess setCursorPositionClientRelative(GHOST_IWindow *window,
                                                 int32_t x,
                                                 int32_t y) override;

  uint32_t getCursorPreferredLogicalSize() const override;

 
  /***************************************************************************************
   * Access to mouse button and keyboard states.
   ***************************************************************************************/

  GHOST_TSuccess getModifierKeyState(GHOST_TModifierKey mask, bool &is_down) const override;

  GHOST_TSuccess getButtonState(GHOST_TButton mask, bool &is_down) const override;

  void setMultitouchGestures(const bool use) override;

  void setTabletAPI(GHOST_TTabletAPI api) override;
  GHOST_TTabletAPI getTabletAPI();

  GHOST_TSuccess getPixelAtCursor(float r_color[3]) const override;
 
#ifdef WITH_INPUT_NDOF
  /***************************************************************************************
   * Access to 3D mouse.
   ***************************************************************************************/

  void setNDOFDeadZone(float deadzone) override;
#endif
 
  /***************************************************************************************
   * Access to the Clipboard
   ***************************************************************************************/

  char *getClipboard(bool selection) const override = 0;
  void putClipboard(const char *buffer, bool selection) const override = 0;
  GHOST_TSuccess hasClipboardImage() const override;
  uint *getClipboardImage(int *r_width, int *r_height) const override;
  GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const override;

  GHOST_TSuccess showMessageBox(const char * /*title*/,
                                const char * /*message*/,
                                const char * /*help_label*/,
                                const char * /*continue_label*/,
                                const char * /*link*/,
                                GHOST_DialogOptions /*dialog_options*/) const override
  {
    return GHOST_kFailure;
  };
 
  /***************************************************************************************
   * Other (internal) functionality.
   ***************************************************************************************/

  GHOST_TSuccess pushEvent(const GHOST_IEvent *event);

  inline GHOST_TimerManager *getTimerManager() const;

  inline GHOST_EventManager *getEventManager() const;

  inline GHOST_WindowManager *getWindowManager() const;
 
#ifdef WITH_INPUT_NDOF
  inline GHOST_NDOFManager *getNDOFManager() const;
#endif

  virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const = 0;

  virtual GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const = 0;
 
  /***************************************************************************************
   * Debugging
   ***************************************************************************************/

  void initDebug(GHOST_Debug debug) override;

  bool isDebugEnabled() override;
 
 protected:
  GHOST_TSuccess init() override;
  GHOST_TSuccess exit() override;

  GHOST_TimerManager *timer_manager_;

  GHOST_WindowManager *window_manager_;

  GHOST_EventManager *event_manager_;
 
#ifdef WITH_INPUT_NDOF
  GHOST_NDOFManager *ndof_manager_;
#endif
 
#ifdef WITH_GHOST_DEBUG
  GHOST_EventPrinter *event_printer_;
#endif  // WITH_GHOST_DEBUG

  bool multitouch_gestures_;

  GHOST_TTabletAPI tablet_api_;
 
  bool is_debug_enabled_;
};
 
inline GHOST_TimerManager *GHOST_System::getTimerManager() const
{
  return timer_manager_;
}
 
inline GHOST_EventManager *GHOST_System::getEventManager() const
{
  return event_manager_;
}
 
inline GHOST_WindowManager *GHOST_System::getWindowManager() const
{
  return window_manager_;
}
 
#ifdef WITH_INPUT_NDOF
inline GHOST_NDOFManager *GHOST_System::getNDOFManager() const
{
  return ndof_manager_;
}
#endif