File: patch_manager.h

package info (click to toggle)
boswars 2.8-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 96,652 kB
  • sloc: cpp: 57,250; python: 1,715; sh: 25; makefile: 17
file content (174 lines) | stat: -rw-r--r-- 4,101 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
164
165
166
167
168
169
170
171
172
173
174
//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
/**@name patch.h - The patch manager header. */
//
//      (c) Copyright 2008-2010 by Jimmy Salmon
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; only version 2 of the License.
//
//      This program 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 General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef _PATCH_MANAGER_H_
#define _PATCH_MANAGER_H_

//@{

#include <list>
#include <map>
#include <vector>
#include <string>

class CPatchType;
class CPatch;
class CFile;


class CPatchManager
{
public:
	/**
	**  Patch manager constructor
	*/
	CPatchManager();

	/**
	**  Patch manager destructor
	*/
	~CPatchManager();

	/**
	**  Create a new patch of type typeName at location x, y
	*/
	CPatch *add(const std::string &typeName, int x, int y);

	/**
	**  Remove a patch
	*/
	void remove(CPatch *patch);

	/**
	**  Move a patch's location
	*/
	void move(CPatch *patch, int x, int y);

	/**
	**  Move a patch to the top
	*/
	void moveToTop(CPatch *patch);

	/**
	**  Move a patch to the bottom
	*/
	void moveToBottom(CPatch *patch);

	/**
	**  Get the patch at location x, y
	*/
	CPatch *getPatch(int x, int y, int *xOffset = NULL, int *yOffset = NULL) const;

	/**
	**  Get all of the patches
	*/
	const std::list<CPatch *> &getPatches() const;

	/**
	**  Get all of the patch names
	*/
	std::vector<std::string> getPatchTypeNames() const;

	/**
	**  Get the names of the patch types that use the graphic in
	**  the specified file.
	*/
	std::vector<std::string> getPatchTypeNamesUsingGraphic(
		const std::string &graphicFile) const;

	/**
	**  Get all of the patch themes
	*/
	std::vector<std::string> getPatchTypeThemes() const;

	/**
	**  Load the patches used in the map
	*/
	void load();

	/**
	**  Load all patches
	*/
	void loadAll();

	/**
	**  Clear the patches used in the map
	*/
	void clear();

	/**
	**  Define a new patch type.
	**  Types should be created only once and last for the duration of the game.
	*/
	CPatchType *newPatchType(const std::string &name, const std::string &file,
		int tileWidth, int tileHeight, int *flags, const std::string &theme = "");

	/**
	**  Define a new patch type.
	**  Types should be created only once and last for the duration of the game.
	*/
	CPatchType *newPatchType(const std::string &name, const std::string &file,
		int tileWidth, int tileHeight, unsigned short *flags, const std::string &theme = "");

	/**
	**  Get a patch type
	*/
	CPatchType *getPatchType(const std::string &name);

	/**
	**  Save all of the patches
	*/
	std::string savePatches(bool patchesOnly = false) const;

	/**
	**  Save a patch type
	*/
	std::string savePatchType(CPatchType *patchType) const;

	/**
	**  Compute how large the patch type should be if one were
	**  created for the graphic in the specified file.
	**  This function is intended to be called from Lua.
	*/
	bool computePatchSize(const std::string &graphicFile,
	                      int *width, int *height) const;

private:
	void updateMapFlags(int x1, int y1, int x2, int y2);

	std::list<CPatch *> patches;
	std::map<std::string, CPatchType *> patchTypesMap;

	std::list<CPatch *> removedPatches;

	bool loadedAll;
};

//@}

#endif /* _PATCH_MANAGER_H_ */