3 Copyright (C) 2010-2014 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include "mg_schematic.h"
26 #include "util/numeric.h"
27 #include "util/serialize.h"
28 #include "serialization.h"
31 const char *SchematicManager::ELEMENT_TITLE = "schematic";
34 ///////////////////////////////////////////////////////////////////////////////
37 Schematic::Schematic()
42 size = v3s16(0, 0, 0);
46 Schematic::~Schematic()
53 void Schematic::updateContentIds()
55 if (flags & SCHEM_CIDS_UPDATED)
58 flags |= SCHEM_CIDS_UPDATED;
60 for (int i = 0; i != size.X * size.Y * size.Z; i++)
61 schemdata[i].setContent(c_nodes[schemdata[i].getContent()]);
65 void Schematic::blitToVManip(v3s16 p, ManualMapVoxelManipulator *vm,
66 Rotation rot, bool force_placement, INodeDefManager *ndef)
70 int zstride = size.X * size.Y;
78 int i_start, i_step_x, i_step_z;
87 i_start = zstride * (sz - 1) + sx - 1;
92 i_start = zstride * (sz - 1);
104 for (s16 y = 0; y != sy; y++) {
105 if (slice_probs[y] != MTSCHEM_PROB_ALWAYS &&
106 myrand_range(1, 255) > slice_probs[y])
109 for (s16 z = 0; z != sz; z++) {
110 u32 i = z * i_step_z + y * ystride + i_start;
111 for (s16 x = 0; x != sx; x++, i += i_step_x) {
112 u32 vi = vm->m_area.index(p.X + x, y_map, p.Z + z);
113 if (!vm->m_area.contains(vi))
116 if (schemdata[i].getContent() == CONTENT_IGNORE)
119 if (schemdata[i].param1 == MTSCHEM_PROB_NEVER)
122 if (!force_placement) {
123 content_t c = vm->m_data[vi].getContent();
124 if (c != CONTENT_AIR && c != CONTENT_IGNORE)
128 if (schemdata[i].param1 != MTSCHEM_PROB_ALWAYS &&
129 myrand_range(1, 255) > schemdata[i].param1)
132 vm->m_data[vi] = schemdata[i];
133 vm->m_data[vi].param1 = 0;
136 vm->m_data[vi].rotateAlongYAxis(ndef, rot);
144 void Schematic::placeStructure(Map *map, v3s16 p, u32 flags,
145 Rotation rot, bool force_placement, INodeDefManager *ndef)
147 assert(schemdata != NULL);
148 ManualMapVoxelManipulator *vm = new ManualMapVoxelManipulator(map);
150 if (rot == ROTATE_RAND)
151 rot = (Rotation)myrand_range(ROTATE_0, ROTATE_270);
153 v3s16 s = (rot == ROTATE_90 || rot == ROTATE_270) ?
154 v3s16(size.Z, size.Y, size.X) : size;
156 if (flags & DECO_PLACE_CENTER_X)
157 p.X -= (s.X + 1) / 2;
158 if (flags & DECO_PLACE_CENTER_Y)
159 p.Y -= (s.Y + 1) / 2;
160 if (flags & DECO_PLACE_CENTER_Z)
161 p.Z -= (s.Z + 1) / 2;
163 v3s16 bp1 = getNodeBlockPos(p);
164 v3s16 bp2 = getNodeBlockPos(p + s - v3s16(1,1,1));
165 vm->initialEmerge(bp1, bp2);
167 blitToVManip(p, vm, rot, force_placement, ndef);
169 std::map<v3s16, MapBlock *> lighting_modified_blocks;
170 std::map<v3s16, MapBlock *> modified_blocks;
171 vm->blitBackAll(&modified_blocks);
173 // TODO: Optimize this by using Mapgen::calcLighting() instead
174 lighting_modified_blocks.insert(modified_blocks.begin(), modified_blocks.end());
175 map->updateLighting(lighting_modified_blocks, modified_blocks);
178 event.type = MEET_OTHER;
179 for (std::map<v3s16, MapBlock *>::iterator
180 it = modified_blocks.begin();
181 it != modified_blocks.end(); ++it)
182 event.modified_blocks.insert(it->first);
184 map->dispatchEvent(&event);
188 bool Schematic::loadSchematicFromFile(const char *filename,
189 NodeResolver *resolver,
190 std::map<std::string, std::string> &replace_names)
192 content_t cignore = CONTENT_IGNORE;
193 bool have_cignore = false;
195 std::ifstream is(filename, std::ios_base::binary);
197 u32 signature = readU32(is);
198 if (signature != MTSCHEM_FILE_SIGNATURE) {
199 errorstream << "loadSchematicFile: invalid schematic "
204 u16 version = readU16(is);
205 if (version > MTSCHEM_FILE_VER_HIGHEST_READ) {
206 errorstream << "loadSchematicFile: unsupported schematic "
207 "file version" << std::endl;
211 size = readV3S16(is);
213 delete []slice_probs;
214 slice_probs = new u8[size.Y];
215 for (int y = 0; y != size.Y; y++)
216 slice_probs[y] = (version >= 3) ? readU8(is) : MTSCHEM_PROB_ALWAYS;
218 int nodecount = size.X * size.Y * size.Z;
220 u16 nidmapcount = readU16(is);
222 for (int i = 0; i != nidmapcount; i++) {
223 std::string name = deSerializeString(is);
224 if (name == "ignore") {
230 std::map<std::string, std::string>::iterator it;
231 it = replace_names.find(name);
232 if (it != replace_names.end())
235 resolver->addNodeList(name.c_str(), &c_nodes);
239 schemdata = new MapNode[nodecount];
240 MapNode::deSerializeBulk(is, SER_FMT_VER_HIGHEST_READ, schemdata,
241 nodecount, 2, 2, true);
243 if (version == 1) { // fix up the probability values
244 for (int i = 0; i != nodecount; i++) {
245 if (schemdata[i].param1 == 0)
246 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
247 if (have_cignore && schemdata[i].getContent() == cignore)
248 schemdata[i].param1 = MTSCHEM_PROB_NEVER;
257 Minetest Schematic File Format
259 All values are stored in big-endian byte order.
260 [u32] signature: 'MTSM'
266 [u8] slice probability value
267 [Name-ID table] Name ID Mapping Table
269 For each name-id mapping:
273 For each node in schematic: (for z, y, x)
275 For each node in schematic:
276 [u8] probability of occurance (param1)
277 For each node in schematic:
283 2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
284 3 - Added y-slice probabilities; this allows for variable height structures
286 void Schematic::saveSchematicToFile(const char *filename, INodeDefManager *ndef)
288 std::ostringstream ss(std::ios_base::binary);
290 writeU32(ss, MTSCHEM_FILE_SIGNATURE); // signature
291 writeU16(ss, MTSCHEM_FILE_VER_HIGHEST_WRITE); // version
292 writeV3S16(ss, size); // schematic size
294 for (int y = 0; y != size.Y; y++) // Y slice probabilities
295 writeU8(ss, slice_probs[y]);
297 std::vector<content_t> usednodes;
298 int nodecount = size.X * size.Y * size.Z;
299 build_nnlist_and_update_ids(schemdata, nodecount, &usednodes);
301 u16 numids = usednodes.size();
302 writeU16(ss, numids); // name count
303 for (int i = 0; i != numids; i++)
304 ss << serializeString(ndef->get(usednodes[i]).name); // node names
306 // compressed bulk node data
307 MapNode::serializeBulk(ss, SER_FMT_VER_HIGHEST_WRITE, schemdata,
308 nodecount, 2, 2, true);
310 fs::safeWriteToFile(filename, ss.str());
314 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
315 std::vector<content_t> *usednodes)
317 std::map<content_t, content_t> nodeidmap;
318 content_t numids = 0;
320 for (u32 i = 0; i != nodecount; i++) {
322 content_t c = nodes[i].getContent();
324 std::map<content_t, content_t>::const_iterator it = nodeidmap.find(c);
325 if (it == nodeidmap.end()) {
329 usednodes->push_back(c);
330 nodeidmap.insert(std::make_pair(c, id));
334 nodes[i].setContent(id);
339 bool Schematic::getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2)
341 ManualMapVoxelManipulator *vm = new ManualMapVoxelManipulator(map);
343 v3s16 bp1 = getNodeBlockPos(p1);
344 v3s16 bp2 = getNodeBlockPos(p2);
345 vm->initialEmerge(bp1, bp2);
349 slice_probs = new u8[size.Y];
350 for (s16 y = 0; y != size.Y; y++)
351 slice_probs[y] = MTSCHEM_PROB_ALWAYS;
353 schemdata = new MapNode[size.X * size.Y * size.Z];
356 for (s16 z = p1.Z; z <= p2.Z; z++)
357 for (s16 y = p1.Y; y <= p2.Y; y++) {
358 u32 vi = vm->m_area.index(p1.X, y, z);
359 for (s16 x = p1.X; x <= p2.X; x++, i++, vi++) {
360 schemdata[i] = vm->m_data[vi];
361 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
370 void Schematic::applyProbabilities(v3s16 p0,
371 std::vector<std::pair<v3s16, u8> > *plist,
372 std::vector<std::pair<s16, u8> > *splist)
374 for (size_t i = 0; i != plist->size(); i++) {
375 v3s16 p = (*plist)[i].first - p0;
376 int index = p.Z * (size.Y * size.X) + p.Y * size.X + p.X;
377 if (index < size.Z * size.Y * size.X) {
378 u8 prob = (*plist)[i].second;
379 schemdata[index].param1 = prob;
381 // trim unnecessary node names from schematic
382 if (prob == MTSCHEM_PROB_NEVER)
383 schemdata[index].setContent(CONTENT_AIR);
387 for (size_t i = 0; i != splist->size(); i++) {
388 s16 y = (*splist)[i].first - p0.Y;
389 slice_probs[y] = (*splist)[i].second;