File: librocketmanager.h

package info (click to toggle)
fife 0.4.2-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 25,204 kB
  • sloc: cpp: 42,642; xml: 18,881; python: 13,521; makefile: 23
file content (163 lines) | stat: -rw-r--r-- 4,949 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/***************************************************************************
 *   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_GUI_LIBROCKETMANAGER_H
#define FIFE_GUI_LIBROCKETMANAGER_H

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

// 3rd party library includes
#include <Rocket/Core/SystemInterface.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 "util/base/singleton.h"
#include "gui/guimanager.h"

namespace Rocket {
	
	namespace Core {
		class Context;
		class ElementDocument;
	}
};

namespace FIFE {
	
	class LibRocketInputProcessor;
	class LibRocketRenderInterface;
	
	class LibRocketManager : 
	public Rocket::Core::SystemInterface,
	public IGUIManager, 
	public DynamicSingleton<LibRocketManager> {

	public:
		
		/** Constructor.
		 */
		LibRocketManager();

		/**
		 * Destructor.
		 */
		virtual ~LibRocketManager();
		
		/**
		 * Initializes the librocket manager.
		 */
		void init(const std::string& backend, int32_t screenWidth, int32_t screenHeight);
		
		/**
		 * NOTE 
		 * There is an inconsistency in the naming of this method.
		 * It's in upper camelcase and should have been in lower camelcase,
		 * but it overrides Rocket::Core::SystemInterface::GetElapsedTime.
		 * 
		 * @return The number of seconds elapsed since the start of the application.
		 */
		virtual float GetElapsedTime();
		
		/** Updates and renders the gui.
		 */
		virtual void turn();

		/** Resizes the top container.
		 * 
		 * @param x The new starting X coordinate.
		 * @param y The new starting Y coordinate.
		 * @param width The new width.
		 * @param height The new height.
		 */
		virtual void resizeTopContainer(uint32_t x, uint32_t y, uint32_t width, uint32_t height);
		
		/** Loads a rocket .rml file and shows it.
		 * 
		 * @param id Id of the document chosen by the user.
		 * @param documentPath Path to the file.
		 * @return A document if the .rml file exists, NULL otherwise.
		 */
		virtual Rocket::Core::ElementDocument* loadDocument(const std::string& id, const std::string& documentPath);
		
		/** @return Document with id.
		 */
		virtual Rocket::Core::ElementDocument* getDocument(const std::string& id);
		
		/** Unloads a rocket document.
		 */
		virtual void unloadDocument(Rocket::Core::ElementDocument* document);
		
		/** Unloads a rocket document with given id.
		 */
		virtual void unloadDocument(const std::string& id);
		
		/**
		 * Loads a font to be used by librocket.
		 * 
		 * @param filepath Path of the font.
		 */
		virtual void loadFont(const std::string& filepath);
		
		/** Receives input and converts it to librocket format, then it forwards it
		 * to librocket.
		 */
		virtual bool onSdlEvent(SDL_Event& evt);
		
		/** Shows the librocket debugger.
		 */
		void showDebugger() const;
		
		/**
		 * Hides the librocket debugger.
		 */
		void hideDebugger() const;
		
	private:
		
		/**
		 * Unloads documents opened by librocket.
		 */
		void unloadDocuments();
		
		/** Librocket's context.
		 */
		Rocket::Core::Context* m_context;
		
		/** Render Interface for librocket.
		 */
		LibRocketRenderInterface* m_renderInterface;
		
		/** Input processor for librocket.
		 */
		LibRocketInputProcessor* m_inputProcessor;
		
		/** A set of all open documents.
		 */
		std::map<std::string, Rocket::Core::ElementDocument*> m_openDocuments;

	};
};

#endif //FIFE_GUI_LIBROCKETMANAGER_H