GHOST_ISystem.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
 
#include <stdlib.h>
 
#include "GHOST_IContext.h"
#include "GHOST_ITimerTask.h"
#include "GHOST_IWindow.h"
#include "GHOST_Types.h"
 
class GHOST_IEventConsumer;
 
class GHOST_ISystem {
 public:
  static GHOST_TSuccess createSystem();
 
  static GHOST_TSuccess disposeSystem();
 
  static GHOST_ISystem *getSystem();
 
 protected:
  GHOST_ISystem()
  {
  }
 
  virtual ~GHOST_ISystem()
  {
  }
 
 public:
  /***************************************************************************************
   * Time(r) functionality
   ***************************************************************************************/
 
  virtual GHOST_TUns64 getMilliSeconds() const = 0;
 
  virtual GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
                                         GHOST_TUns64 interval,
                                         GHOST_TimerProcPtr timerProc,
                                         GHOST_TUserDataPtr userData = NULL) = 0;
 
  virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) = 0;
 
  /***************************************************************************************
   * Display/window management functionality
   ***************************************************************************************/
 
  virtual GHOST_TUns8 getNumDisplays() const = 0;
 
  virtual void getMainDisplayDimensions(GHOST_TUns32 &width, GHOST_TUns32 &height) const = 0;
 
  virtual void getAllDisplayDimensions(GHOST_TUns32 &width, GHOST_TUns32 &height) const = 0;
 
  virtual GHOST_IWindow *createWindow(const char *title,
                                      GHOST_TInt32 left,
                                      GHOST_TInt32 top,
                                      GHOST_TUns32 width,
                                      GHOST_TUns32 height,
                                      GHOST_TWindowState state,
                                      GHOST_TDrawingContextType type,
                                      GHOST_GLSettings glSettings,
                                      const bool exclusive = false,
                                      const bool is_dialog = false,
                                      const GHOST_IWindow *parentWindow = NULL) = 0;
 
  virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window) = 0;
 
  virtual GHOST_IContext *createOffscreenContext(GHOST_GLSettings glSettings) = 0;
 
  virtual GHOST_TSuccess disposeContext(GHOST_IContext *context) = 0;
 
  virtual bool validWindow(GHOST_IWindow *window) = 0;
 
  virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting &setting,
                                         GHOST_IWindow **window,
                                         const bool stereoVisual,
                                         const bool alphaBackground = 0) = 0;
 
  virtual GHOST_TSuccess updateFullScreen(const GHOST_DisplaySetting &setting,
                                          GHOST_IWindow **window) = 0;
 
  virtual GHOST_TSuccess endFullScreen(void) = 0;
 
  virtual bool getFullScreen(void) = 0;
 
  virtual bool useNativePixel(void) = 0;
 
  virtual void useWindowFocus(const bool use_focus) = 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 getCursorPosition(GHOST_TInt32 &x, GHOST_TInt32 &y) const = 0;
 
  virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
 
  /***************************************************************************************
   * Access to mouse button and keyboard states.
   ***************************************************************************************/
 
  virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool &isDown) const = 0;
 
  virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool &isDown) const = 0;
 
  virtual void setTabletAPI(GHOST_TTabletAPI api) = 0;
 
#ifdef WITH_INPUT_NDOF
  virtual void setNDOFDeadZone(float deadzone) = 0;
#endif
 
  virtual int toggleConsole(int action) = 0;
 
  /***************************************************************************************
   * Access to clipboard.
   ***************************************************************************************/
 
  virtual GHOST_TUns8 *getClipboard(bool selection) const = 0;
 
  virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) 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(bool is_debug_enabled) = 0;
 
  virtual bool isDebugEnabled() = 0;
 
 protected:
  virtual GHOST_TSuccess init() = 0;
 
  virtual GHOST_TSuccess exit() = 0;
 
  static GHOST_ISystem *m_system;
 
#ifdef WITH_CXX_GUARDEDALLOC
  MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystem")
#endif
};