GUIManager.h

Go to the documentation of this file.

/*
 * i6engine
 * Copyright (2016) Daniel Bonrath, Michael Baer, All rights reserved.
 *
 * This file is part of i6engine; i6engine 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 __I6ENGINE_MODULES_GUIMANAGER_H__
#define __I6ENGINE_MODULES_GUIMANAGER_H__

#include <array>
#include <list>
#include <map>
#include <sstream>
#include <vector>

#include "i6engine/utils/i6eThreadSafety.h"

#include "i6engine/api/KeyCodes.h"
#include "i6engine/api/facades/InputFacade.h"

#include "i6engine/modules/gui/GUIFactory.h"

#include "boost/function.hpp"
#include "boost/thread/mutex.hpp"

namespace CEGUI {
        class EventArgs;
        class OgreRenderer;
        class Window;
} /* namespace CEGUI */

namespace Ogre {
        class Root;
} /* namespace Ogre */

namespace i6e {
namespace core {
        struct MessageStruct;
} /* namespace core */
namespace api {
        class GUIWidget;

namespace gui {
        struct GUIUpdateMessageStruct;
} /* namespace gui */
} /* namespace api */
namespace modules {

        const std::string GUIMAN = "GUIManager"; // i.e. GUI Manager Name

        enum class KeyState;
        class GUICanvas;
        class GUIController;

        class GUIManager {
                friend class GUICanvas;
                friend class GUIController;
                friend class GUIMailbox;

        public:
                typedef std::map<std::string, boost::function<void(void)>> GUIFunctions;

                typedef std::map<std::pair<api::KeyCode, std::string>, boost::function<void(void)>> GUIKeyFunctions;

                GUIManager(GUIController * ctrl);

                ~GUIManager();

                void initializeGUI(Ogre::Root * root);

                inline CEGUI::Window * getRootWindow() const { return _objRoot; }

                void setFunction(const std::string & name, const boost::function<void(void)> & ptrEventMethod);

                bool allowedEvent(const std::string & name);

                inline void changeEvent(const std::string & name, const bool b) { _enabledFunctions[name] = b; }

                bool getVisibility(const std::string & windowname);

                void processCreateMessage(uint16_t type, api::gui::GUIUpdateMessageStruct * data);

                void processUpdateMessage(uint16_t type, api::gui::GUIUpdateMessageStruct * data);

                void processDeleteMessage(uint16_t type, api::gui::GUIUpdateMessageStruct * data);

                void processInputUpdateMessage(uint16_t type, core::MessageStruct * data);

                void addTicker(api::GUIWidget * widget);

                void removeTicker(api::GUIWidget * widget);

                void tickWidgets();

                void registerGUIWidgetTemplate(const std::string & name, GUIWidget_factory createFunc);

        protected:
                void createGUI(const std::string & strScheme, const std::string & strFont, const std::string & strDefaultFont, const std::string & strDefaultMouseImageSet, const std::string & strDefaultMouseImageName);

                void MouseMove(const double fltDeltaX, const double fltDeltaY, const double fltDeltaZ) const;

                void MousePos(const double fltPosX, const double fltPosY) const;

                void MouseDown(const api::KeyCode enuButton) const;

                void MouseUp(const api::KeyCode enuButton) const;

                void KeyDown(const api::KeyCode intKeyCode, uint32_t text);

                void KeyHold(const api::KeyCode intKeyCode);

                void KeyUp(const api::KeyCode intKeyCode);

                void MouseLeaves() const;

                void addChildWindow(const std::string & parent_widget, const std::string & child_widget);

                void addToRootWindow(CEGUI::Window * child);

                void setMouseVisibility(const bool visibility);

                void cleanUpAllWindows();

                void subscribeEvent(const std::string & name, const std::string & type);

                void triggerFunction(const std::string & name);

                void triggerKeyFunction(const uint32_t keyCode, const std::string & type);

                void handleCreateMessage(uint16_t type, api::gui::GUIUpdateMessageStruct * data);

                void handleUpdateMessage(uint16_t type, api::gui::GUIUpdateMessageStruct * data);

                void handleDeleteMessage(uint16_t type, api::gui::GUIUpdateMessageStruct * data);

                inline CEGUI::OgreRenderer * getRenderer() const { return _objRenderer; }

                void Tick();

        private:
                bool ClickedEventHandler(const CEGUI::EventArgs & e);

                bool PressedEventHandler(const CEGUI::EventArgs & e);

                bool ReleasedEventHandler(const CEGUI::EventArgs & e);

                api::GUIWidget * getWidgetByName(const std::string & name);

                std::vector<api::GUIWidget *> getMouseoverWidgets() const {
                        ASSERT_THREAD_SAFETY_FUNCTION
                        return _mouseOverWidgets;
                }

                CEGUI::OgreRenderer * _objRenderer;
                GUIFunctions _objGUIFunctions;
                GUIKeyFunctions _objGUIKeyFunctions;
                CEGUI::Window * _objRoot;

                std::map<std::string, api::GUIWidget *> _widgets;
                std::map<std::string, bool> _enabledFunctions;
                uint64_t _listIDs;

                std::list<api::GUIWidget *> _toTick;

                std::array<api::KeyState, 238> _keyStates;

                GUIFactory _factory;

                mutable boost::mutex _tickerLock;

                GUIController * _ctrl;

                std::string _lastOnWindow;

                std::vector<api::GUIWidget *> _mouseOverWidgets;

                GUIManager(const GUIManager &) = delete;

                const GUIManager & operator=(const GUIManager &) = delete;

                ASSERT_THREAD_SAFETY_HEADER
        };

} /* namespace modules */
} /* namespace i6e */

#endif /* __I6ENGINE_MODULES_GUIMANAGER_H__ */