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_DisplayManager;
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();
 
  virtual ~GHOST_System();
 
 public:
  /***************************************************************************************
   * Time(r) functionality
   ***************************************************************************************/
 
  GHOST_ITimerTask *installTimer(uint64_t delay,
                                 uint64_t interval,
                                 GHOST_TimerProcPtr timerProc,
                                 GHOST_TUserDataPtr userData = nullptr);
 
  GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask);
 
  /***************************************************************************************
   * Display/window management functionality
   ***************************************************************************************/
 
  GHOST_TSuccess disposeWindow(GHOST_IWindow *window);
 
  virtual GHOST_IContext *createOffscreenContext(GHOST_GPUSettings gpuSettings) = 0;
 
  bool validWindow(GHOST_IWindow *window);
 
  GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting &setting,
                                 GHOST_IWindow **window,
                                 const bool stereoVisual);
 
  GHOST_TSuccess updateFullScreen(const GHOST_DisplaySetting &setting, GHOST_IWindow **window);
 
  GHOST_TSuccess endFullScreen();
 
  bool getFullScreen();
 
  bool useNativePixel();
  bool m_nativePixel;
 
  void useWindowFocus(const bool use_focus);
 
  bool m_windowFocus;
 
  void setAutoFocus(const bool auto_focus);
  bool m_autoFocus;
 
  GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y);
 
  /***************************************************************************************
   * Event management functionality
   ***************************************************************************************/
 
  void dispatchEvents();
 
  GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer);
 
  GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer);
 
  /***************************************************************************************
   * 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;
  GHOST_TSuccess setCursorPositionClientRelative(GHOST_IWindow *window, int32_t x, int32_t y);
 
  /***************************************************************************************
   * Access to mouse button and keyboard states.
   ***************************************************************************************/
 
  GHOST_TSuccess getModifierKeyState(GHOST_TModifierKey mask, bool &isDown) const;
 
  GHOST_TSuccess getButtonState(GHOST_TButton mask, bool &isDown) const;
 
  void setMultitouchGestures(const bool use);
 
  virtual void setTabletAPI(GHOST_TTabletAPI api);
  GHOST_TTabletAPI getTabletAPI();
 
  GHOST_TSuccess getPixelAtCursor(float r_color[3]) const;
 
#ifdef WITH_INPUT_NDOF
  /***************************************************************************************
   * Access to 3D mouse.
   ***************************************************************************************/
 
  void setNDOFDeadZone(float deadzone);
#endif
 
  /***************************************************************************************
   * 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;
 
  virtual char *getClipboard(bool selection) const = 0;
 
  virtual void putClipboard(const char *buffer, bool selection) const = 0;
 
  GHOST_TSuccess hasClipboardImage() const;
 
  uint *getClipboardImage(int *r_width, int *r_height) const;
 
  GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const;
 
  virtual 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
  {
    return GHOST_kFailure;
  };
 
  /***************************************************************************************
   * Debugging
   ***************************************************************************************/
 
  virtual void initDebug(GHOST_Debug debug);
 
  virtual bool isDebugEnabled();
 
 protected:
  virtual GHOST_TSuccess init();
 
  virtual GHOST_TSuccess exit();
 
  GHOST_TSuccess createFullScreenWindow(GHOST_Window **window,
                                        const GHOST_DisplaySetting &settings,
                                        const bool stereoVisual);
 
  GHOST_DisplayManager *m_displayManager;
 
  GHOST_TimerManager *m_timerManager;
 
  GHOST_WindowManager *m_windowManager;
 
  GHOST_EventManager *m_eventManager;
 
#ifdef WITH_INPUT_NDOF
  GHOST_NDOFManager *m_ndofManager;
#endif
 
#ifdef WITH_GHOST_DEBUG
  GHOST_EventPrinter *m_eventPrinter;
#endif  // WITH_GHOST_DEBUG
 
  GHOST_DisplaySetting m_preFullScreenSetting;
 
  /* Use multi-touch gestures? */
  bool m_multitouchGestures;
 
  GHOST_TTabletAPI m_tabletAPI;
 
  bool m_is_debug_enabled;
};
 
inline GHOST_TimerManager *GHOST_System::getTimerManager() const
{
  return m_timerManager;
}
 
inline GHOST_EventManager *GHOST_System::getEventManager() const
{
  return m_eventManager;
}
 
inline GHOST_WindowManager *GHOST_System::getWindowManager() const
{
  return m_windowManager;
}
 
#ifdef WITH_INPUT_NDOF
inline GHOST_NDOFManager *GHOST_System::getNDOFManager() const
{
  return m_ndofManager;
}
#endif