GHOST_System.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_SYSTEM_H_
#define _GHOST_SYSTEM_H_

#include "GHOST_ISystem.h"

#include "GHOST_Debug.h"
#include "GHOST_Buttons.h"
#include "GHOST_ModifierKeys.h"
#include "GHOST_EventManager.h"
#ifdef GHOST_DEBUG
#include "GHOST_EventPrinter.h"
#endif // GHOST_DEBUG

class GHOST_DisplayManager;
class GHOST_Event;
class GHOST_TimerManager;
class GHOST_Window;
class GHOST_WindowManager;
class GHOST_NDOFManager;

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

    virtual ~GHOST_System();

public:
    /***************************************************************************************
     ** Time(r) functionality
     ***************************************************************************************/

    virtual GHOST_TUns64 getMilliSeconds() const;

    virtual GHOST_ITimerTask* installTimer(GHOST_TUns64 delay,
                                           GHOST_TUns64 interval,
                                           GHOST_TimerProcPtr timerProc,
                                           GHOST_TUserDataPtr userData = 0);

    virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask* timerTask);

    /***************************************************************************************
     ** Display/window management functionality
     ***************************************************************************************/
    
    virtual GHOST_TSuccess disposeWindow(GHOST_IWindow* window);

    virtual bool validWindow(GHOST_IWindow* window);

    virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
        const bool stereoVisual, const GHOST_TUns16 numOfAASamples=0);

    virtual GHOST_TSuccess endFullScreen(void);

    virtual bool getFullScreen(void);


    /***************************************************************************************
     ** Event management functionality
     ***************************************************************************************/

    virtual bool dispatchEvents();

    virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer* consumer);

    virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer* consumer);

    /***************************************************************************************
     ** Cursor management functionality
     ***************************************************************************************/

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

    virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const;

    virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const;
    
    /***************************************************************************************
     ** Other (internal) functionality.
     ***************************************************************************************/

    virtual GHOST_TSuccess pushEvent(GHOST_IEvent* event);

    inline virtual GHOST_TimerManager* getTimerManager() const;

    virtual inline GHOST_EventManager* getEventManager() const;

    virtual inline GHOST_WindowManager* getWindowManager() const;

#ifdef WITH_INPUT_NDOF

    virtual 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 GHOST_TUns8* getClipboard(bool selection) const = 0;
      
      virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;

    
protected:
    virtual GHOST_TSuccess init();

    virtual GHOST_TSuccess exit();

    virtual GHOST_TSuccess createFullScreenWindow(GHOST_Window** window,
        const bool stereoVisual, const GHOST_TUns16 numOfAASamples=0);

    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 GHOST_DEBUG
    GHOST_EventPrinter* m_eventPrinter;
#endif // GHOST_DEBUG

    GHOST_DisplaySetting m_preFullScreenSetting;
};

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

#endif // _GHOST_SYSTEM_H_