GHOST_System.cpp

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 *****
 */

#include "GHOST_System.h"

#include <time.h>
#include <stdio.h> /* just for printf */

#include "GHOST_DisplayManager.h"
#include "GHOST_EventManager.h"
#include "GHOST_NDOFManager.h"
#include "GHOST_TimerTask.h"
#include "GHOST_TimerManager.h"
#include "GHOST_WindowManager.h"


GHOST_System::GHOST_System()
    : m_displayManager(0),
      m_timerManager(0),
      m_windowManager(0),
      m_eventManager(0)
#ifdef WITH_INPUT_NDOF
      , m_ndofManager(0)
#endif
{
}


GHOST_System::~GHOST_System()
{
    exit();
}


GHOST_TUns64 GHOST_System::getMilliSeconds() const
{
    GHOST_TUns64 millis = ::clock();
    if (CLOCKS_PER_SEC != 1000) {
        millis *= 1000;
        millis /= CLOCKS_PER_SEC;
    }
    return millis;
}


GHOST_ITimerTask* GHOST_System::installTimer(GHOST_TUns64 delay,
                                             GHOST_TUns64 interval,
                                             GHOST_TimerProcPtr timerProc,
                                             GHOST_TUserDataPtr userData)
{
    GHOST_TUns64 millis = getMilliSeconds();
    GHOST_TimerTask* timer = new GHOST_TimerTask(millis+delay, interval, timerProc, userData);
    if (timer) {
        if (m_timerManager->addTimer(timer) == GHOST_kSuccess) {
            // Check to see whether we need to fire the timer right away
            m_timerManager->fireTimers(millis);
        }
        else {
            delete timer;
            timer = 0;
        }
    }
    return timer;
}


GHOST_TSuccess GHOST_System::removeTimer(GHOST_ITimerTask* timerTask)
{
    GHOST_TSuccess success = GHOST_kFailure;
    if (timerTask) {
        success = m_timerManager->removeTimer((GHOST_TimerTask*)timerTask);
    }
    return success;
}


GHOST_TSuccess GHOST_System::disposeWindow(GHOST_IWindow* window)
{
    GHOST_TSuccess success;

    /*
     * Remove all pending events for the window.
     */ 
    if (m_windowManager->getWindowFound(window)) {
        m_eventManager->removeWindowEvents(window);
    }
    if (window == m_windowManager->getFullScreenWindow()) {
        success = endFullScreen();
    }
    else {
        if (m_windowManager->getWindowFound(window)) {
            success = m_windowManager->removeWindow(window);
            if (success) {
                delete window;
            }
        }
        else {
            success = GHOST_kFailure;
        }
    }
    return success;
}


bool GHOST_System::validWindow(GHOST_IWindow* window)
{
    return m_windowManager->getWindowFound(window);
}


GHOST_TSuccess GHOST_System::beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow** window,
                                             const bool stereoVisual, const GHOST_TUns16 numOfAASamples)
{
    GHOST_TSuccess success = GHOST_kFailure;
    GHOST_ASSERT(m_windowManager, "GHOST_System::beginFullScreen(): invalid window manager")
    if (m_displayManager) {
        if (!m_windowManager->getFullScreen()) {
            m_displayManager->getCurrentDisplaySetting(GHOST_DisplayManager::kMainDisplay, m_preFullScreenSetting);

            //GHOST_PRINT("GHOST_System::beginFullScreen(): activating new display settings\n");
            success = m_displayManager->setCurrentDisplaySetting(GHOST_DisplayManager::kMainDisplay, setting);
            if (success == GHOST_kSuccess) {
                //GHOST_PRINT("GHOST_System::beginFullScreen(): creating full-screen window\n");
                success = createFullScreenWindow((GHOST_Window**)window, stereoVisual, numOfAASamples);
                if (success == GHOST_kSuccess) {
                    m_windowManager->beginFullScreen(*window, stereoVisual);
                }
                else {
                    m_displayManager->setCurrentDisplaySetting(GHOST_DisplayManager::kMainDisplay, m_preFullScreenSetting);
                }
            }
        }
    }
    if (success == GHOST_kFailure) {
        GHOST_PRINT("GHOST_System::beginFullScreen(): could not enter full-screen mode\n");
    }
    return success;
}


GHOST_TSuccess GHOST_System::endFullScreen(void)
{
    GHOST_TSuccess success = GHOST_kFailure;
    GHOST_ASSERT(m_windowManager, "GHOST_System::endFullScreen(): invalid window manager")
    if (m_windowManager->getFullScreen()) {
        //GHOST_IWindow* window = m_windowManager->getFullScreenWindow();
        //GHOST_PRINT("GHOST_System::endFullScreen(): leaving window manager full-screen mode\n");
        success = m_windowManager->endFullScreen();
        GHOST_ASSERT(m_displayManager, "GHOST_System::endFullScreen(): invalid display manager")
        //GHOST_PRINT("GHOST_System::endFullScreen(): leaving full-screen mode\n");
        success = m_displayManager->setCurrentDisplaySetting(GHOST_DisplayManager::kMainDisplay, m_preFullScreenSetting);
    }
    else {
        success = GHOST_kFailure;
    }
    return success;
}


bool GHOST_System::getFullScreen(void)
{
    bool fullScreen;
    if (m_windowManager) {
        fullScreen = m_windowManager->getFullScreen();
    }
    else {
        fullScreen = false;
    }
    return fullScreen;
}


bool GHOST_System::dispatchEvents()
{
    bool handled = false;

#ifdef WITH_INPUT_NDOF
    // NDOF Motion event is sent only once per dispatch, so do it now:
    if (m_ndofManager) {
        handled |= m_ndofManager->sendMotionEvent();
    }
#endif

    if (m_eventManager) {
        handled |= m_eventManager->dispatchEvents();
    }

    m_timerManager->fireTimers(getMilliSeconds());
    return handled;
}


GHOST_TSuccess GHOST_System::addEventConsumer(GHOST_IEventConsumer* consumer)
{
    GHOST_TSuccess success;
    if (m_eventManager) {
        success = m_eventManager->addConsumer(consumer);
    }
    else {
        success = GHOST_kFailure;
    }
    return success;
}

GHOST_TSuccess GHOST_System::removeEventConsumer(GHOST_IEventConsumer* consumer)
{
    GHOST_TSuccess success;
    if (m_eventManager) {
        success = m_eventManager->removeConsumer(consumer);
    }
    else {
        success = GHOST_kFailure;
    }
    return success;
}

GHOST_TSuccess GHOST_System::pushEvent(GHOST_IEvent* event)
{
    GHOST_TSuccess success;
    if (m_eventManager) {
        success = m_eventManager->pushEvent(event);
    }
    else {
        success = GHOST_kFailure;
    }
    return success;
}

GHOST_TSuccess GHOST_System::getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const
{
    GHOST_ModifierKeys keys;
    // Get the state of all modifier keys 
    GHOST_TSuccess success = getModifierKeys(keys);
    if (success) {
        // Isolate the state of the key requested
        isDown = keys.get(mask);
    }
    return success;
}


GHOST_TSuccess GHOST_System::getButtonState(GHOST_TButtonMask mask, bool& isDown) const
{
    GHOST_Buttons buttons;
    // Get the state of all mouse buttons
    GHOST_TSuccess success = getButtons(buttons);
    if (success) {
        // Isolate the state of the mouse button requested
        isDown = buttons.get(mask);
    }
    return success;
}

GHOST_TSuccess GHOST_System::init()
{
    m_timerManager = new GHOST_TimerManager ();
    m_windowManager = new GHOST_WindowManager ();
    m_eventManager = new GHOST_EventManager ();
    
#ifdef GHOST_DEBUG
    if (m_eventManager) {
        m_eventPrinter = new GHOST_EventPrinter();
        m_eventManager->addConsumer(m_eventPrinter);
    }
#endif // GHOST_DEBUG

    if (m_timerManager && m_windowManager && m_eventManager) {
        return GHOST_kSuccess;
    } else {
        return GHOST_kFailure;
    }
}


GHOST_TSuccess GHOST_System::exit()
{
    if (getFullScreen()) {
        endFullScreen();
    }
    if (m_displayManager) {
        delete m_displayManager;
        m_displayManager = 0;
    }
    if (m_windowManager) {
        delete m_windowManager;
        m_windowManager = 0;
    }
    if (m_timerManager) {
        delete m_timerManager;
        m_timerManager = 0;
    }
    if (m_eventManager) {
        delete m_eventManager;
        m_eventManager = 0;
    }
#ifdef WITH_INPUT_NDOF
    if (m_ndofManager) {
        delete m_ndofManager;
        m_ndofManager = 0;
    }
#endif
    return GHOST_kSuccess;
}


GHOST_TSuccess GHOST_System::createFullScreenWindow(GHOST_Window** window, const bool stereoVisual, const GHOST_TUns16 numOfAASamples)
{
    GHOST_TSuccess success;
    GHOST_ASSERT(m_displayManager, "GHOST_System::createFullScreenWindow(): invalid display manager")
    GHOST_DisplaySetting settings;

    success = m_displayManager->getCurrentDisplaySetting(GHOST_DisplayManager::kMainDisplay, settings);
    if (success) {
        //GHOST_PRINT("GHOST_System::createFullScreenWindow(): creating full-screen window\n");
        *window = (GHOST_Window*)createWindow(
                    STR_String (""),
                    0, 0, settings.xPixels, settings.yPixels,
                    GHOST_kWindowStateFullScreen,
                    GHOST_kDrawingContextTypeOpenGL,
                    stereoVisual,
                    numOfAASamples);
        success = *window == 0 ? GHOST_kFailure : GHOST_kSuccess;
    }
    return success;
}