engine.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_ENGINE_H
#define FIFE_ENGINE_H

// Standard C++ library includes
#include <map>
#include <string>
#include <vector>

// Platform specific includes
#ifdef USE_COCOA
#include <objc/runtime.h>
#endif

// 3rd party library includes
#include <SDL.h>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "enginesettings.h"
#include "video/devicecaps.h"

namespace FIFE {

    class SoundManager;
    class RenderBackend;
    class IGUIManager;
    class VFS;
    class VFSSourceFactory;
    class EventManager;
    class TimeManager;
    class Model;
    class LogManager;
    class Cursor;
    class RendererBase;
    class Image;
    class ImageManager;
    class AnimationManager;
    class SoundClipManager;
    class OffRenderer;
    class TargetRenderer;

    class IEngineChangeListener {
    public:
        virtual ~IEngineChangeListener() {}

        virtual void onScreenModeChanged(const ScreenMode& newmode) = 0;
    };

    class Engine {
    public:
        Engine();

        virtual ~Engine();

        EngineSettings& getSettings();

        const DeviceCaps& getDeviceCaps() const;

        void changeScreenMode(const ScreenMode& mode);

        void init();

        void destroy();

        void initializePumping();

        void finalizePumping();

        void pump();

        SoundManager* getSoundManager() const { return m_soundmanager; }

        EventManager* getEventManager() const { return m_eventmanager; }

        TimeManager* getTimeManager() const { return m_timemanager; }


        void setGuiManager(IGUIManager* guimanager) { m_guimanager = guimanager; }

        IGUIManager* getGuiManager() const { return m_guimanager; }

        ImageManager* getImageManager() const { return m_imagemanager; }

        AnimationManager* getAnimationManager() const { return m_animationmanager; }

        SoundClipManager* getSoundClipManager() const { return m_soundclipmanager; }

        RenderBackend* getRenderBackend() const { return m_renderbackend; }

        Model* getModel() const { return m_model; }

        LogManager* getLogManager() const { return m_logmanager; }

        VFS* getVFS() const { return m_vfs; }

        Cursor* getCursor() const { return m_cursor; }

        OffRenderer* getOffRenderer() const { return m_offrenderer; }

        TargetRenderer* getTargetRenderer() const { return m_targetrenderer; }

        void addChangeListener(IEngineChangeListener* listener);

        void removeChangeListener(IEngineChangeListener* listener);

    private:
        RenderBackend* m_renderbackend;
        IGUIManager* m_guimanager;
        EventManager* m_eventmanager;
        SoundManager* m_soundmanager;
        TimeManager* m_timemanager;
        ImageManager* m_imagemanager;
        AnimationManager* m_animationmanager;
        SoundClipManager* m_soundclipmanager;

        VFS* m_vfs;
        Model* m_model;
        LogManager* m_logmanager;

        Cursor* m_cursor;
        bool m_destroyed;

        EngineSettings m_settings;
        DeviceCaps m_devcaps;

        ScreenMode m_screenMode;

        OffRenderer* m_offrenderer;
        TargetRenderer* m_targetrenderer;
        std::vector<RendererBase*> m_renderers;

        std::vector<IEngineChangeListener*> m_changelisteners;

#ifdef USE_COCOA
        id m_autoreleasePool;
#endif

    };

}//FIFE

#endif