Debian Codegraph @

engine/core/savers/native/map/mapsaver.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 #ifndef FIFE_MAPSAVER_H_
22 #define FIFE_MAPSAVER_H_
23
24 // Standard C++ library includes
25 #include <string>
26
27 // 3rd party library includes
28
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33 #include "imapsaver.h"
34
35 namespace FIFE {
36 class Map;
37
38 /** default map saver class implementing the IMapSaver interface
39 */
40 class MapSaver : public IMapSaver {
41 public:
42 /** constructor
43 */
44 MapSaver();
45
46 /** destructor
47 */
48 ~MapSaver();
49
50 /** allows setting which object saver will be
51 * used to save object files
52 */
53 virtual void setObjectSaver(const FIFE::ObjectSaverPtr& objectSaver);
54
55 /** allows setting which animation saver will be
56 * used to save animation files
57 */
58 virtual void setAnimationSaver(const FIFE::AnimationSaverPtr& animationSaver);
59
60 /** allows setting which atlas saver will be
61 * used to save atlas files
62 */
63 virtual void setAtlasSaver(const FIFE::AtlasSaverPtr& atlasSaver);
64
65 /** responsible for saving the map resource
66 * used to save map files
67 */
68 virtual void save(const Map& map, const std::string& filename, const std::vector<std::string>& importFiles);
69
70 private:
71 ObjectSaverPtr m_objectSaver;
72 AnimationSaverPtr m_animationSaver;
73 AtlasSaverPtr m_atlasSaver;
74 };
75 }
76
77 #endif