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 ///////////////////////////////////////////////////////////////////////////////
34 SchematicManager::SchematicManager(IGameDef *gamedef) :
35 ObjDefManager(gamedef, OBJDEF_SCHEMATIC)
40 ///////////////////////////////////////////////////////////////////////////////
43 Schematic::Schematic()
48 size = v3s16(0, 0, 0);
52 Schematic::~Schematic()
59 void Schematic::resolveNodeNames(NodeResolveInfo *nri)
61 m_ndef->getIdsFromResolveInfo(nri, c_nodes);
65 void Schematic::updateContentIds()
67 if (flags & SCHEM_CIDS_UPDATED)
70 flags |= SCHEM_CIDS_UPDATED;
72 size_t bufsize = size.X * size.Y * size.Z;
73 for (size_t i = 0; i != bufsize; i++)
74 schemdata[i].setContent(c_nodes[schemdata[i].getContent()]);
78 void Schematic::blitToVManip(v3s16 p, MMVManip *vm, Rotation rot,
79 bool force_placement, INodeDefManager *ndef)
83 int zstride = size.X * size.Y;
91 int i_start, i_step_x, i_step_z;
100 i_start = zstride * (sz - 1) + sx - 1;
105 i_start = zstride * (sz - 1);
117 for (s16 y = 0; y != sy; y++) {
118 if (slice_probs[y] != MTSCHEM_PROB_ALWAYS &&
119 myrand_range(1, 255) > slice_probs[y])
122 for (s16 z = 0; z != sz; z++) {
123 u32 i = z * i_step_z + y * ystride + i_start;
124 for (s16 x = 0; x != sx; x++, i += i_step_x) {
125 u32 vi = vm->m_area.index(p.X + x, y_map, p.Z + z);
126 if (!vm->m_area.contains(vi))
129 if (schemdata[i].getContent() == CONTENT_IGNORE)
132 if (schemdata[i].param1 == MTSCHEM_PROB_NEVER)
135 if (!force_placement) {
136 content_t c = vm->m_data[vi].getContent();
137 if (c != CONTENT_AIR && c != CONTENT_IGNORE)
141 if (schemdata[i].param1 != MTSCHEM_PROB_ALWAYS &&
142 myrand_range(1, 255) > schemdata[i].param1)
145 vm->m_data[vi] = schemdata[i];
146 vm->m_data[vi].param1 = 0;
149 vm->m_data[vi].rotateAlongYAxis(ndef, rot);
157 void Schematic::placeStructure(Map *map, v3s16 p, u32 flags, Rotation rot,
158 bool force_placement, INodeDefManager *ndef)
160 assert(schemdata != NULL); // Pre-condition
161 MMVManip *vm = new MMVManip(map);
163 if (rot == ROTATE_RAND)
164 rot = (Rotation)myrand_range(ROTATE_0, ROTATE_270);
166 v3s16 s = (rot == ROTATE_90 || rot == ROTATE_270) ?
167 v3s16(size.Z, size.Y, size.X) : size;
169 if (flags & DECO_PLACE_CENTER_X)
170 p.X -= (s.X + 1) / 2;
171 if (flags & DECO_PLACE_CENTER_Y)
172 p.Y -= (s.Y + 1) / 2;
173 if (flags & DECO_PLACE_CENTER_Z)
174 p.Z -= (s.Z + 1) / 2;
176 v3s16 bp1 = getNodeBlockPos(p);
177 v3s16 bp2 = getNodeBlockPos(p + s - v3s16(1,1,1));
178 vm->initialEmerge(bp1, bp2);
180 blitToVManip(p, vm, rot, force_placement, ndef);
182 std::map<v3s16, MapBlock *> lighting_modified_blocks;
183 std::map<v3s16, MapBlock *> modified_blocks;
184 vm->blitBackAll(&modified_blocks);
186 // TODO: Optimize this by using Mapgen::calcLighting() instead
187 lighting_modified_blocks.insert(modified_blocks.begin(), modified_blocks.end());
188 map->updateLighting(lighting_modified_blocks, modified_blocks);
191 event.type = MEET_OTHER;
192 for (std::map<v3s16, MapBlock *>::iterator
193 it = modified_blocks.begin();
194 it != modified_blocks.end(); ++it)
195 event.modified_blocks.insert(it->first);
197 map->dispatchEvent(&event);
201 bool Schematic::deserializeFromMts(std::istream *is,
202 INodeDefManager *ndef, std::vector<std::string> *names)
204 std::istream &ss = *is;
205 content_t cignore = CONTENT_IGNORE;
206 bool have_cignore = false;
208 u32 signature = readU32(ss);
209 if (signature != MTSCHEM_FILE_SIGNATURE) {
210 errorstream << "Schematic::deserializeFromMts: invalid schematic "
215 u16 version = readU16(ss);
216 if (version > MTSCHEM_FILE_VER_HIGHEST_READ) {
217 errorstream << "Schematic::deserializeFromMts: unsupported schematic "
218 "file version" << std::endl;
222 size = readV3S16(ss);
224 delete []slice_probs;
225 slice_probs = new u8[size.Y];
226 for (int y = 0; y != size.Y; y++)
227 slice_probs[y] = (version >= 3) ? readU8(ss) : MTSCHEM_PROB_ALWAYS;
229 u16 nidmapcount = readU16(ss);
230 for (int i = 0; i != nidmapcount; i++) {
231 std::string name = deSerializeString(ss);
233 // Instances of "ignore" from ver 1 are converted to air (and instances
234 // are fixed to have MTSCHEM_PROB_NEVER later on).
235 if (name == "ignore") {
241 names->push_back(name);
244 size_t nodecount = size.X * size.Y * size.Z;
247 schemdata = new MapNode[nodecount];
249 MapNode::deSerializeBulk(ss, SER_FMT_VER_HIGHEST_READ, schemdata,
250 nodecount, 2, 2, true);
252 // fix any probability values for nodes that were ignore
254 for (size_t i = 0; i != nodecount; i++) {
255 if (schemdata[i].param1 == 0)
256 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
257 if (have_cignore && schemdata[i].getContent() == cignore)
258 schemdata[i].param1 = MTSCHEM_PROB_NEVER;
266 bool Schematic::serializeToMts(std::ostream *os, INodeDefManager *ndef)
268 std::ostream &ss = *os;
270 writeU32(ss, MTSCHEM_FILE_SIGNATURE); // signature
271 writeU16(ss, MTSCHEM_FILE_VER_HIGHEST_WRITE); // version
272 writeV3S16(ss, size); // schematic size
274 for (int y = 0; y != size.Y; y++) // Y slice probabilities
275 writeU8(ss, slice_probs[y]);
277 std::vector<content_t> usednodes;
278 int nodecount = size.X * size.Y * size.Z;
279 build_nnlist_and_update_ids(schemdata, nodecount, &usednodes);
281 u16 numids = usednodes.size();
282 writeU16(ss, numids); // name count
283 for (int i = 0; i != numids; i++)
284 ss << serializeString(ndef->get(usednodes[i]).name); // node names
286 // compressed bulk node data
287 MapNode::serializeBulk(ss, SER_FMT_VER_HIGHEST_WRITE,
288 schemdata, nodecount, 2, 2, true);
294 bool Schematic::serializeToLua(std::ostream *os,
295 INodeDefManager *ndef, bool use_comments)
297 std::ostream &ss = *os;
301 ss << "schematic = {" << std::endl;
306 << "}," << std::endl;
309 //// Write y-slice probabilities
311 ss << "\tyslice_prob = {" << std::endl;
313 for (u16 y = 0; y != size.Y; y++) {
316 << ", prob=" << (u16)slice_probs[y]
317 << "}," << std::endl;
320 ss << "\t}," << std::endl;
325 ss << "\tdata = {" << std::endl;
328 for (u16 z = 0; z != size.Z; z++)
329 for (u16 y = 0; y != size.Y; y++) {
333 << ", y=" << y << std::endl;
336 for (u16 x = 0; x != size.X; x++, i++) {
338 << "name=\"" << ndef->get(schemdata[i]).name
339 << "\", param1=" << (u16)schemdata[i].param1
340 << ", param2=" << (u16)schemdata[i].param2
341 << "}," << std::endl;
345 ss << "\t}," << std::endl;
348 ss << "}" << std::endl;
354 bool Schematic::loadSchematicFromFile(const char *filename,
355 INodeDefManager *ndef, StringMap *replace_names)
357 std::ifstream is(filename, std::ios_base::binary);
359 errorstream << "Schematic::loadSchematicFile: unable to open file '"
360 << filename << "'" << std::endl;
364 std::vector<std::string> names;
365 if (!deserializeFromMts(&is, ndef, &names))
368 NodeResolveInfo *nri = new NodeResolveInfo(this);
369 for (size_t i = 0; i != names.size(); i++) {
371 StringMap::iterator it = replace_names->find(names[i]);
372 if (it != replace_names->end())
373 names[i] = it->second;
375 nri->nodenames.push_back(names[i]);
377 nri->nodelistinfo.push_back(NodeListInfo(names.size(), CONTENT_AIR));
378 ndef->pendNodeResolve(nri);
384 bool Schematic::saveSchematicToFile(const char *filename, INodeDefManager *ndef)
386 std::ostringstream os(std::ios_base::binary);
387 serializeToMts(&os, ndef);
388 return fs::safeWriteToFile(filename, os.str());
392 bool Schematic::getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2)
394 MMVManip *vm = new MMVManip(map);
396 v3s16 bp1 = getNodeBlockPos(p1);
397 v3s16 bp2 = getNodeBlockPos(p2);
398 vm->initialEmerge(bp1, bp2);
402 slice_probs = new u8[size.Y];
403 for (s16 y = 0; y != size.Y; y++)
404 slice_probs[y] = MTSCHEM_PROB_ALWAYS;
406 schemdata = new MapNode[size.X * size.Y * size.Z];
409 for (s16 z = p1.Z; z <= p2.Z; z++)
410 for (s16 y = p1.Y; y <= p2.Y; y++) {
411 u32 vi = vm->m_area.index(p1.X, y, z);
412 for (s16 x = p1.X; x <= p2.X; x++, i++, vi++) {
413 schemdata[i] = vm->m_data[vi];
414 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
423 void Schematic::applyProbabilities(v3s16 p0,
424 std::vector<std::pair<v3s16, u8> > *plist,
425 std::vector<std::pair<s16, u8> > *splist)
427 for (size_t i = 0; i != plist->size(); i++) {
428 v3s16 p = (*plist)[i].first - p0;
429 int index = p.Z * (size.Y * size.X) + p.Y * size.X + p.X;
430 if (index < size.Z * size.Y * size.X) {
431 u8 prob = (*plist)[i].second;
432 schemdata[index].param1 = prob;
434 // trim unnecessary node names from schematic
435 if (prob == MTSCHEM_PROB_NEVER)
436 schemdata[index].setContent(CONTENT_AIR);
440 for (size_t i = 0; i != splist->size(); i++) {
441 s16 y = (*splist)[i].first - p0.Y;
442 slice_probs[y] = (*splist)[i].second;
447 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
448 std::vector<content_t> *usednodes)
450 std::map<content_t, content_t> nodeidmap;
451 content_t numids = 0;
453 for (u32 i = 0; i != nodecount; i++) {
455 content_t c = nodes[i].getContent();
457 std::map<content_t, content_t>::const_iterator it = nodeidmap.find(c);
458 if (it == nodeidmap.end()) {
462 usednodes->push_back(c);
463 nodeidmap.insert(std::make_pair(c, id));
467 nodes[i].setContent(id);