kg: src/Engine.hh@194bc810a570 (annotated)

185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	1	#ifndef ENGINE_HH
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	2	#define ENGINE_HH
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	3
218 86d22fe82b30 add static Engine::graphicsEnabled function and disable player graphics loading when false terom parents: 186 diff changeset	4	// forward-declare
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	5	class Engine;
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	6
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	7	#include "GameState.hh"
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	8	#include "Configuration.hh"
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	9	#include "Logger.hh"
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	10
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	11	// forward-declare component pointer types
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	12	// XXX: move to some kind of Components.hh file?
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	13	namespace graphics { class Graphics; }
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	14	class NetworkServer;
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	15	class NetworkClientConnect;
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	16	class NetworkClient;
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	17
283 7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 233 diff changeset	18	/**
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 233 diff changeset	19	* This is the core class that glues all the other components together and runs the main loop
7540b0859579 start adding some documentation, most core classes (outside of Network) are now doxygen-enabled terom parents: 233 diff changeset	20	*/
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	21	class Engine {
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	22	private:
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	23	/** The game's terrain */
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	24	Terrain *terrain;
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	25
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	26	/** The game's state */
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	27	GameState *game_state;
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	28
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	29	/** The graphics+input component */
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	30	graphics::Graphics *graphics;
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	31
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	32	/** Network server */
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	33	NetworkServer *net_server;
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	34
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	35	/** Network client connector */
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	36	NetworkClientConnect *net_client_connect;
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	37
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	38	/** Network client, currently unused */
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	39	NetworkClient *net_client;
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	40
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	41	/** Is the mainloop still running? */
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	42	bool is_running;
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	43
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	44	/** Used to load ClanLib resources */
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	45	CL_ResourceManager resources;
218 86d22fe82b30 add static Engine::graphicsEnabled function and disable player graphics loading when false terom parents: 186 diff changeset	46
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	47	/** Global log level */
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	48	static LogLevel log_level;
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	49
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	50	public:
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	51	// default constructor
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	52	Engine (const EngineConfig &config);
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	53
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	54	/**
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	55	* Setup game world using the given terrain, returning the new GameState
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	56	*
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	57	* XXX: fix to return void
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	58	*/
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	59	GameState& setupGame (Terrain *terrain);
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	60
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	61	/**
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	62	* Setup game world using given terrain configuration
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	63	*/
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	64	void setupGame (const TerrainConfig &config);
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	65
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	66	/**
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	67	* Enable graphics.
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	68	*
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	69	* Requires: GRAPHICS_ENABLED
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	70	*/
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	71	void setupGraphics (const DisplayConfig &config);
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	72
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	73	/**
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	74	* Setup server, must call setupGame first
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	75	*
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	76	* Requires: NETWORK_ENABLED
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	77	*/
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	78	void setupNetworkServer (const std::string &listen_port);
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	79
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	80	/**
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	81	* Setup client, do not call setupGame, configuration comes from the server
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	82	*
c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	83	* Requires: NETWORK_ENABLED
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	84	*/
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	85	void setupNetworkClient (const std::string &connect_host, const std::string &connect_port);
409 1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	86
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	87	/**
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	88	* Setup singleplayer, must call setupGame first
1a03ff151abc add --terrain-seed and --terrain-size arguments, plus bugfixes Tero Marttila <terom@fixme.fi> parents: 408 diff changeset	89	*/
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	90	void setupSinglePlayer (void);
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	91
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	92	/**
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	93	* Run the game main loop. This will not return until the game aborts due to an error, or someone calls stop().
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	94	*/
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	95	void run (void);
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	96
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	97	/**
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	98	* Terminate the main loop, causing run() to return once this loop iteration is finished
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	99	*/
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	100	void stop (void);
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	101
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	102	private:
e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	103	/**
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	104	* Puts graphics into GameView mode, using our GameState and the given player
408 e6cfc44266af reorganize Terrain/PhysicsWorld/GameState/Engine to use NetworkClientConnect, and hence handle the connection process asynchronously, and finally properly implement receiving the terrain data from the server Tero Marttila <terom@fixme.fi> parents: 389 diff changeset	105	*/
417 c503e0c6a740 support for building without Network/Graphics, although the disable-graphics case is kind of hackish still Tero Marttila <terom@fixme.fi> parents: 411 diff changeset	106	void startGameView (LocalPlayer *player);
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	107
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	108	public:
418 194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	109	/**
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	110	* Get a pointer to our resource manager, please don't break it.
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	111	*
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	112	* Guaranteed to never be NULL
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	113	*/
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	114	CL_ResourceManager* getResourceManager (void) { return &resources; }
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	115
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	116	/**
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	117	* Log output, see Logger for more info
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	118	*
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	119	* @see Logger
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	120	*/
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	121	static inline Logger log (LogLevel level, const char *type) {
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	122	return Logger(level <= WARN ? std::cerr : std::cout, level, type, log_level);
194bc810a570 add --log-level option, improve Config/Logger documentation, fix NETWORK_EANBLED typos in Engine Tero Marttila <terom@fixme.fi> parents: 417 diff changeset	123	}
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	124
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	125	};
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	126
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	127	#endif /* ENGINE_HH */

author	Tero Marttila <terom@fixme.fi>
	Thu, 22 Jan 2009 02:38:33 +0200
branch	new_graphics
changeset 418	194bc810a570
parent 417	c503e0c6a740
child 419	9cd4e54693b6
permissions	-rw-r--r--