GHOST_ISystem.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 <cstdlib>
 
#include "GHOST_IContext.hh"
#include "GHOST_ITimerTask.hh"
#include "GHOST_IWindow.hh"
#include "GHOST_Types.h"
 
class GHOST_IEventConsumer;


class GHOST_ISystem {
 public:
 
  static GHOST_TSuccess createSystem(bool verbose, bool background);
  static GHOST_TSuccess createSystemBackground();

  static GHOST_TSuccess disposeSystem();

  static GHOST_ISystem *getSystem();
  static const char *getSystemBackend();
 
  static GHOST_TBacktraceFn getBacktraceFn();
  static void setBacktraceFn(GHOST_TBacktraceFn backtrace_fn);
 
  static bool getUseWindowFrame();
  static void setUseWindowFrame(bool use_window_frame);
 
 protected:
  GHOST_ISystem() {}

  virtual ~GHOST_ISystem() = default;
 
 public:
  /***************************************************************************************
   * Time(r) functionality
   ***************************************************************************************/

  virtual uint64_t getMilliSeconds() const = 0;

  virtual GHOST_ITimerTask *installTimer(uint64_t delay,
                                         uint64_t interval,
                                         GHOST_TimerProcPtr timer_proc,
                                         GHOST_TUserDataPtr user_data = nullptr) = 0;

  virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) = 0;
 
  /***************************************************************************************
   * Display/window management functionality
   ***************************************************************************************/

  virtual uint8_t getNumDisplays() const = 0;

  virtual void getMainDisplayDimensions(uint32_t &width, uint32_t &height) const = 0;

  virtual void getAllDisplayDimensions(uint32_t &width, uint32_t &height) const = 0;

  virtual GHOST_IWindow *createWindow(const char *title,
                                      int32_t left,
                                      int32_t top,
                                      uint32_t width,
                                      uint32_t height,
                                      GHOST_TWindowState state,
                                      GHOST_GPUSettings gpu_settings,
                                      const bool exclusive = false,
                                      const bool is_dialog = false,
                                      const GHOST_IWindow *parent_window = nullptr) = 0;

  virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window) = 0;

  virtual GHOST_IContext *createOffscreenContext(GHOST_GPUSettings gpu_settings) = 0;

  virtual GHOST_TSuccess disposeContext(GHOST_IContext *context) = 0;

  virtual bool validWindow(GHOST_IWindow *window) = 0;

  virtual bool useNativePixel() = 0;

  virtual GHOST_TCapabilityFlag getCapabilities() const = 0;

  virtual void useWindowFocus(const bool use_focus) = 0;

  virtual void setAutoFocus(const bool auto_focus) = 0;

  virtual GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y) = 0;
 
  /***************************************************************************************
   * Event management functionality
   ***************************************************************************************/

  virtual bool processEvents(bool waitForEvent) = 0;

  virtual void dispatchEvents() = 0;

  virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer) = 0;

  virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer) = 0;
 
  /***************************************************************************************
   * Cursor management functionality
   ***************************************************************************************/

  virtual GHOST_TSuccess getCursorPositionClientRelative(const GHOST_IWindow *window,
                                                         int32_t &x,
                                                         int32_t &y) const = 0;
  virtual GHOST_TSuccess setCursorPositionClientRelative(GHOST_IWindow *window,
                                                         int32_t x,
                                                         int32_t y) = 0;

  virtual GHOST_TSuccess getCursorPosition(int32_t &x, int32_t &y) const = 0;

  virtual uint32_t getCursorPreferredLogicalSize() const = 0;

  virtual GHOST_TSuccess setCursorPosition(int32_t x, int32_t y) = 0;
 
  /***************************************************************************************
   * Access to mouse button and keyboard states.
   ***************************************************************************************/

  virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKey mask, bool &is_down) const = 0;

  virtual GHOST_TSuccess getButtonState(GHOST_TButton mask, bool &is_down) const = 0;

  virtual void setMultitouchGestures(const bool use) = 0;

  virtual void setTabletAPI(GHOST_TTabletAPI api) = 0;

  virtual GHOST_TSuccess getPixelAtCursor(float r_color[3]) const = 0;
 
#ifdef WITH_INPUT_NDOF
  virtual void setNDOFDeadZone(float deadzone) = 0;
#endif

  virtual bool setConsoleWindowState(GHOST_TConsoleWindowState action) = 0;
 
  /***************************************************************************************
   * Access to clipboard.
   ***************************************************************************************/

  virtual char *getClipboard(bool selection) const = 0;

  virtual void putClipboard(const char *buffer, bool selection) const = 0;

  virtual GHOST_TSuccess hasClipboardImage() const = 0;

  virtual uint *getClipboardImage(int *r_width, int *r_height) const = 0;

  virtual GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const = 0;
 
  /***************************************************************************************
   * System Message Box.
   ***************************************************************************************/

  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 = 0;
 
  /***************************************************************************************
   * Debugging
   ***************************************************************************************/

  virtual void initDebug(GHOST_Debug debug) = 0;

  virtual bool isDebugEnabled() = 0;
 
 protected:
  virtual GHOST_TSuccess init() = 0;

  virtual GHOST_TSuccess exit() = 0;

  static GHOST_ISystem *system_;
  static const char *system_backend_id_;

  static GHOST_TBacktraceFn backtrace_fn_;

  static bool use_window_frame_;
 
  MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystem")
};