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 size_t bufsize = size.X * size.Y * size.Z;
61 for (size_t i = 0; i != bufsize; i++)
62 schemdata[i].setContent(c_nodes[schemdata[i].getContent()]);
66 void Schematic::blitToVManip(v3s16 p, ManualMapVoxelManipulator *vm,
67 Rotation rot, bool force_placement, INodeDefManager *ndef)
71 int zstride = size.X * size.Y;
79 int i_start, i_step_x, i_step_z;
88 i_start = zstride * (sz - 1) + sx - 1;
93 i_start = zstride * (sz - 1);
105 for (s16 y = 0; y != sy; y++) {
106 if (slice_probs[y] != MTSCHEM_PROB_ALWAYS &&
107 myrand_range(1, 255) > slice_probs[y])
110 for (s16 z = 0; z != sz; z++) {
111 u32 i = z * i_step_z + y * ystride + i_start;
112 for (s16 x = 0; x != sx; x++, i += i_step_x) {
113 u32 vi = vm->m_area.index(p.X + x, y_map, p.Z + z);
114 if (!vm->m_area.contains(vi))
117 if (schemdata[i].getContent() == CONTENT_IGNORE)
120 if (schemdata[i].param1 == MTSCHEM_PROB_NEVER)
123 if (!force_placement) {
124 content_t c = vm->m_data[vi].getContent();
125 if (c != CONTENT_AIR && c != CONTENT_IGNORE)
129 if (schemdata[i].param1 != MTSCHEM_PROB_ALWAYS &&
130 myrand_range(1, 255) > schemdata[i].param1)
133 vm->m_data[vi] = schemdata[i];
134 vm->m_data[vi].param1 = 0;
137 vm->m_data[vi].rotateAlongYAxis(ndef, rot);
145 void Schematic::placeStructure(Map *map, v3s16 p, u32 flags,
146 Rotation rot, bool force_placement, INodeDefManager *ndef)
148 assert(schemdata != NULL);
149 ManualMapVoxelManipulator *vm = new ManualMapVoxelManipulator(map);
151 if (rot == ROTATE_RAND)
152 rot = (Rotation)myrand_range(ROTATE_0, ROTATE_270);
154 v3s16 s = (rot == ROTATE_90 || rot == ROTATE_270) ?
155 v3s16(size.Z, size.Y, size.X) : size;
157 if (flags & DECO_PLACE_CENTER_X)
158 p.X -= (s.X + 1) / 2;
159 if (flags & DECO_PLACE_CENTER_Y)
160 p.Y -= (s.Y + 1) / 2;
161 if (flags & DECO_PLACE_CENTER_Z)
162 p.Z -= (s.Z + 1) / 2;
164 v3s16 bp1 = getNodeBlockPos(p);
165 v3s16 bp2 = getNodeBlockPos(p + s - v3s16(1,1,1));
166 vm->initialEmerge(bp1, bp2);
168 blitToVManip(p, vm, rot, force_placement, ndef);
170 std::map<v3s16, MapBlock *> lighting_modified_blocks;
171 std::map<v3s16, MapBlock *> modified_blocks;
172 vm->blitBackAll(&modified_blocks);
174 // TODO: Optimize this by using Mapgen::calcLighting() instead
175 lighting_modified_blocks.insert(modified_blocks.begin(), modified_blocks.end());
176 map->updateLighting(lighting_modified_blocks, modified_blocks);
179 event.type = MEET_OTHER;
180 for (std::map<v3s16, MapBlock *>::iterator
181 it = modified_blocks.begin();
182 it != modified_blocks.end(); ++it)
183 event.modified_blocks.insert(it->first);
185 map->dispatchEvent(&event);
189 bool Schematic::loadSchematicFromFile(const char *filename,
190 NodeResolver *resolver,
191 std::map<std::string, std::string> &replace_names)
193 content_t cignore = CONTENT_IGNORE;
194 bool have_cignore = false;
196 std::ifstream is(filename, std::ios_base::binary);
198 u32 signature = readU32(is);
199 if (signature != MTSCHEM_FILE_SIGNATURE) {
200 errorstream << "loadSchematicFile: invalid schematic "
205 u16 version = readU16(is);
206 if (version > MTSCHEM_FILE_VER_HIGHEST_READ) {
207 errorstream << "loadSchematicFile: unsupported schematic "
208 "file version" << std::endl;
212 size = readV3S16(is);
214 delete []slice_probs;
215 slice_probs = new u8[size.Y];
216 for (int y = 0; y != size.Y; y++)
217 slice_probs[y] = (version >= 3) ? readU8(is) : MTSCHEM_PROB_ALWAYS;
219 int nodecount = size.X * size.Y * size.Z;
221 u16 nidmapcount = readU16(is);
223 for (int i = 0; i != nidmapcount; i++) {
224 std::string name = deSerializeString(is);
225 if (name == "ignore") {
231 std::map<std::string, std::string>::iterator it;
232 it = replace_names.find(name);
233 if (it != replace_names.end())
236 resolver->addNodeList(name.c_str(), &c_nodes);
240 schemdata = new MapNode[nodecount];
241 MapNode::deSerializeBulk(is, SER_FMT_VER_HIGHEST_READ, schemdata,
242 nodecount, 2, 2, true);
244 if (version == 1) { // fix up the probability values
245 for (int i = 0; i != nodecount; i++) {
246 if (schemdata[i].param1 == 0)
247 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
248 if (have_cignore && schemdata[i].getContent() == cignore)
249 schemdata[i].param1 = MTSCHEM_PROB_NEVER;
258 Minetest Schematic File Format
260 All values are stored in big-endian byte order.
261 [u32] signature: 'MTSM'
267 [u8] slice probability value
268 [Name-ID table] Name ID Mapping Table
270 For each name-id mapping:
274 For each node in schematic: (for z, y, x)
276 For each node in schematic:
277 [u8] probability of occurance (param1)
278 For each node in schematic:
284 2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
285 3 - Added y-slice probabilities; this allows for variable height structures
287 void Schematic::saveSchematicToFile(const char *filename, INodeDefManager *ndef)
289 std::ostringstream ss(std::ios_base::binary);
291 writeU32(ss, MTSCHEM_FILE_SIGNATURE); // signature
292 writeU16(ss, MTSCHEM_FILE_VER_HIGHEST_WRITE); // version
293 writeV3S16(ss, size); // schematic size
295 for (int y = 0; y != size.Y; y++) // Y slice probabilities
296 writeU8(ss, slice_probs[y]);
298 std::vector<content_t> usednodes;
299 int nodecount = size.X * size.Y * size.Z;
300 build_nnlist_and_update_ids(schemdata, nodecount, &usednodes);
302 u16 numids = usednodes.size();
303 writeU16(ss, numids); // name count
304 for (int i = 0; i != numids; i++)
305 ss << serializeString(ndef->get(usednodes[i]).name); // node names
307 // compressed bulk node data
308 MapNode::serializeBulk(ss, SER_FMT_VER_HIGHEST_WRITE, schemdata,
309 nodecount, 2, 2, true);
311 fs::safeWriteToFile(filename, ss.str());
315 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
316 std::vector<content_t> *usednodes)
318 std::map<content_t, content_t> nodeidmap;
319 content_t numids = 0;
321 for (u32 i = 0; i != nodecount; i++) {
323 content_t c = nodes[i].getContent();
325 std::map<content_t, content_t>::const_iterator it = nodeidmap.find(c);
326 if (it == nodeidmap.end()) {
330 usednodes->push_back(c);
331 nodeidmap.insert(std::make_pair(c, id));
335 nodes[i].setContent(id);
340 bool Schematic::getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2)
342 ManualMapVoxelManipulator *vm = new ManualMapVoxelManipulator(map);
344 v3s16 bp1 = getNodeBlockPos(p1);
345 v3s16 bp2 = getNodeBlockPos(p2);
346 vm->initialEmerge(bp1, bp2);
350 slice_probs = new u8[size.Y];
351 for (s16 y = 0; y != size.Y; y++)
352 slice_probs[y] = MTSCHEM_PROB_ALWAYS;
354 schemdata = new MapNode[size.X * size.Y * size.Z];
357 for (s16 z = p1.Z; z <= p2.Z; z++)
358 for (s16 y = p1.Y; y <= p2.Y; y++) {
359 u32 vi = vm->m_area.index(p1.X, y, z);
360 for (s16 x = p1.X; x <= p2.X; x++, i++, vi++) {
361 schemdata[i] = vm->m_data[vi];
362 schemdata[i].param1 = MTSCHEM_PROB_ALWAYS;
371 void Schematic::applyProbabilities(v3s16 p0,
372 std::vector<std::pair<v3s16, u8> > *plist,
373 std::vector<std::pair<s16, u8> > *splist)
375 for (size_t i = 0; i != plist->size(); i++) {
376 v3s16 p = (*plist)[i].first - p0;
377 int index = p.Z * (size.Y * size.X) + p.Y * size.X + p.X;
378 if (index < size.Z * size.Y * size.X) {
379 u8 prob = (*plist)[i].second;
380 schemdata[index].param1 = prob;
382 // trim unnecessary node names from schematic
383 if (prob == MTSCHEM_PROB_NEVER)
384 schemdata[index].setContent(CONTENT_AIR);
388 for (size_t i = 0; i != splist->size(); i++) {
389 s16 y = (*splist)[i].first - p0.Y;
390 slice_probs[y] = (*splist)[i].second;