Debian Codegraph @

engine/core/loaders/native/map/imaploader.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_IMAPLOADER_H_
23 #define FIFE_IMAPLOADER_H_
24
25 // Standard C++ library includes
26 #include <string>
27
28 // 3rd party library includes
29
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34 #include "iatlasloader.h"
35 #include "iobjectloader.h"
36 #include "ianimationloader.h"
37
38 namespace FIFE {
39 class Map;
40
41 /** Interface class that all map loaders should derive from
42 */
43 class IMapLoader {
44 public:
45 virtual ~IMapLoader() { };
46
47 /** allows setting which object loader will be
48 * used to load object files
49 */
50 virtual void setObjectLoader(const FIFE::ObjectLoaderPtr& objectLoader) = 0;
51
52 /** allows setting which animation loader will be
53 * used to load animation files
54 */
55 virtual void setAnimationLoader(const FIFE::AnimationLoaderPtr& animationLoader) = 0;
56
57 /** allows setting which atlas loader will be
58 * used to load atlas files
59 */
60 virtual void setAtlasLoader(const FIFE::AtlasLoaderPtr& atlasLoader) = 0;
61
62 /** determines whether the resource is in
63 * the correct format for this loader
64 */
65 virtual bool isLoadable(const std::string& filename) const = 0;
66
67 /** responsible for loading the map resource
68 * and populating the engine
69 */
70 virtual Map* load(const std::string& filename) = 0;
71
72 };
73 }
74
75 #endif