3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
20 #include "irrlichttypes_extrabloated.h"
25 #include "content_mapnode.h" // For mapnode_translate_*_internal
26 #include "serialization.h" // For ser_ver_supported
27 #include "util/serialize.h"
29 #include "util/numeric.h"
33 static const Rotation wallmounted_to_rot[] = {
34 ROTATE_0, ROTATE_180, ROTATE_90, ROTATE_270
37 static const u8 rot_to_wallmounted[] = {
46 // Create directly from a nodename
47 // If name is unknown, sets CONTENT_IGNORE
48 MapNode::MapNode(INodeDefManager *ndef, const std::string &name,
49 u8 a_param1, u8 a_param2)
51 content_t id = CONTENT_IGNORE;
52 ndef->getId(name, id);
58 void MapNode::getColor(const ContentFeatures &f, video::SColor *color) const
61 *color = (*f.palette)[param2];
67 void MapNode::setLight(enum LightBank bank, u8 a_light, const ContentFeatures &f)
69 // If node doesn't contain light data, ignore this
70 if(f.param_type != CPT_LIGHT)
72 if(bank == LIGHTBANK_DAY)
75 param1 |= a_light & 0x0f;
77 else if(bank == LIGHTBANK_NIGHT)
80 param1 |= (a_light & 0x0f)<<4;
83 assert("Invalid light bank" == NULL);
86 void MapNode::setLight(enum LightBank bank, u8 a_light, INodeDefManager *nodemgr)
88 setLight(bank, a_light, nodemgr->get(*this));
91 bool MapNode::isLightDayNightEq(INodeDefManager *nodemgr) const
93 const ContentFeatures &f = nodemgr->get(*this);
96 if (f.param_type == CPT_LIGHT) {
97 u8 day = MYMAX(f.light_source, param1 & 0x0f);
98 u8 night = MYMAX(f.light_source, (param1 >> 4) & 0x0f);
99 isEqual = day == night;
107 u8 MapNode::getLight(enum LightBank bank, INodeDefManager *nodemgr) const
109 // Select the brightest of [light source, propagated light]
110 const ContentFeatures &f = nodemgr->get(*this);
113 if(f.param_type == CPT_LIGHT)
114 light = bank == LIGHTBANK_DAY ? param1 & 0x0f : (param1 >> 4) & 0x0f;
118 return MYMAX(f.light_source, light);
121 u8 MapNode::getLightRaw(enum LightBank bank, const ContentFeatures &f) const
123 if(f.param_type == CPT_LIGHT)
124 return bank == LIGHTBANK_DAY ? param1 & 0x0f : (param1 >> 4) & 0x0f;
128 u8 MapNode::getLightNoChecks(enum LightBank bank, const ContentFeatures *f) const
130 return MYMAX(f->light_source,
131 bank == LIGHTBANK_DAY ? param1 & 0x0f : (param1 >> 4) & 0x0f);
134 bool MapNode::getLightBanks(u8 &lightday, u8 &lightnight, INodeDefManager *nodemgr) const
136 // Select the brightest of [light source, propagated light]
137 const ContentFeatures &f = nodemgr->get(*this);
138 if(f.param_type == CPT_LIGHT)
140 lightday = param1 & 0x0f;
141 lightnight = (param1>>4)&0x0f;
148 if(f.light_source > lightday)
149 lightday = f.light_source;
150 if(f.light_source > lightnight)
151 lightnight = f.light_source;
152 return f.param_type == CPT_LIGHT || f.light_source != 0;
155 u8 MapNode::getFaceDir(INodeDefManager *nodemgr) const
157 const ContentFeatures &f = nodemgr->get(*this);
158 if (f.param_type_2 == CPT2_FACEDIR ||
159 f.param_type_2 == CPT2_COLORED_FACEDIR)
160 return (getParam2() & 0x1F) % 24;
164 u8 MapNode::getWallMounted(INodeDefManager *nodemgr) const
166 const ContentFeatures &f = nodemgr->get(*this);
167 if (f.param_type_2 == CPT2_WALLMOUNTED ||
168 f.param_type_2 == CPT2_COLORED_WALLMOUNTED)
169 return getParam2() & 0x07;
173 v3s16 MapNode::getWallMountedDir(INodeDefManager *nodemgr) const
175 switch(getWallMounted(nodemgr))
177 case 0: default: return v3s16(0,1,0);
178 case 1: return v3s16(0,-1,0);
179 case 2: return v3s16(1,0,0);
180 case 3: return v3s16(-1,0,0);
181 case 4: return v3s16(0,0,1);
182 case 5: return v3s16(0,0,-1);
186 void MapNode::rotateAlongYAxis(INodeDefManager *nodemgr, Rotation rot)
188 ContentParamType2 cpt2 = nodemgr->get(*this).param_type_2;
190 if (cpt2 == CPT2_FACEDIR || cpt2 == CPT2_COLORED_FACEDIR) {
191 static const u8 rotate_facedir[24 * 4] = {
192 // Table value = rotated facedir
193 // Columns: 0, 90, 180, 270 degrees rotation around vertical axis
194 // Rotation is anticlockwise as seen from above (+Y)
196 0, 1, 2, 3, // Initial facedir 0 to 3
201 4, 13, 10, 19, // 4 to 7
206 8, 17, 6, 15, // 8 to 11
211 12, 9, 18, 7, // 12 to 15
216 16, 5, 14, 11, // 16 to 19
221 20, 23, 22, 21, // 20 to 23
226 u8 facedir = (param2 & 31) % 24;
227 u8 index = facedir * 4 + rot;
229 param2 |= rotate_facedir[index];
230 } else if (cpt2 == CPT2_WALLMOUNTED ||
231 cpt2 == CPT2_COLORED_WALLMOUNTED) {
232 u8 wmountface = (param2 & 7);
236 Rotation oldrot = wallmounted_to_rot[wmountface - 2];
238 param2 |= rot_to_wallmounted[(oldrot - rot) & 3];
242 void transformNodeBox(const MapNode &n, const NodeBox &nodebox,
243 INodeDefManager *nodemgr, std::vector<aabb3f> *p_boxes, u8 neighbors = 0)
245 std::vector<aabb3f> &boxes = *p_boxes;
247 if (nodebox.type == NODEBOX_FIXED || nodebox.type == NODEBOX_LEVELED) {
248 const std::vector<aabb3f> &fixed = nodebox.fixed;
249 int facedir = n.getFaceDir(nodemgr);
250 u8 axisdir = facedir>>2;
252 for (aabb3f box : fixed) {
253 if (nodebox.type == NODEBOX_LEVELED)
254 box.MaxEdge.Y = (-0.5f + n.getLevel(nodemgr) / 64.0f) * BS;
260 box.MinEdge.rotateXZBy(-90);
261 box.MaxEdge.rotateXZBy(-90);
263 else if(facedir == 2)
265 box.MinEdge.rotateXZBy(180);
266 box.MaxEdge.rotateXZBy(180);
268 else if(facedir == 3)
270 box.MinEdge.rotateXZBy(90);
271 box.MaxEdge.rotateXZBy(90);
275 box.MinEdge.rotateYZBy(90);
276 box.MaxEdge.rotateYZBy(90);
279 box.MinEdge.rotateXYBy(90);
280 box.MaxEdge.rotateXYBy(90);
282 else if(facedir == 2)
284 box.MinEdge.rotateXYBy(180);
285 box.MaxEdge.rotateXYBy(180);
287 else if(facedir == 3)
289 box.MinEdge.rotateXYBy(-90);
290 box.MaxEdge.rotateXYBy(-90);
294 box.MinEdge.rotateYZBy(-90);
295 box.MaxEdge.rotateYZBy(-90);
298 box.MinEdge.rotateXYBy(-90);
299 box.MaxEdge.rotateXYBy(-90);
301 else if(facedir == 2)
303 box.MinEdge.rotateXYBy(180);
304 box.MaxEdge.rotateXYBy(180);
306 else if(facedir == 3)
308 box.MinEdge.rotateXYBy(90);
309 box.MaxEdge.rotateXYBy(90);
313 box.MinEdge.rotateXYBy(-90);
314 box.MaxEdge.rotateXYBy(-90);
317 box.MinEdge.rotateYZBy(90);
318 box.MaxEdge.rotateYZBy(90);
320 else if(facedir == 2)
322 box.MinEdge.rotateYZBy(180);
323 box.MaxEdge.rotateYZBy(180);
325 else if(facedir == 3)
327 box.MinEdge.rotateYZBy(-90);
328 box.MaxEdge.rotateYZBy(-90);
332 box.MinEdge.rotateXYBy(90);
333 box.MaxEdge.rotateXYBy(90);
336 box.MinEdge.rotateYZBy(-90);
337 box.MaxEdge.rotateYZBy(-90);
339 else if(facedir == 2)
341 box.MinEdge.rotateYZBy(180);
342 box.MaxEdge.rotateYZBy(180);
344 else if(facedir == 3)
346 box.MinEdge.rotateYZBy(90);
347 box.MaxEdge.rotateYZBy(90);
351 box.MinEdge.rotateXYBy(-180);
352 box.MaxEdge.rotateXYBy(-180);
355 box.MinEdge.rotateXZBy(90);
356 box.MaxEdge.rotateXZBy(90);
358 else if(facedir == 2)
360 box.MinEdge.rotateXZBy(180);
361 box.MaxEdge.rotateXZBy(180);
363 else if(facedir == 3)
365 box.MinEdge.rotateXZBy(-90);
366 box.MaxEdge.rotateXZBy(-90);
373 boxes.push_back(box);
376 else if(nodebox.type == NODEBOX_WALLMOUNTED)
378 v3s16 dir = n.getWallMountedDir(nodemgr);
381 if(dir == v3s16(0,1,0))
383 boxes.push_back(nodebox.wall_top);
386 else if(dir == v3s16(0,-1,0))
388 boxes.push_back(nodebox.wall_bottom);
395 nodebox.wall_side.MinEdge,
396 nodebox.wall_side.MaxEdge
399 for (v3f &vertex : vertices) {
400 if(dir == v3s16(-1,0,0))
401 vertex.rotateXZBy(0);
402 if(dir == v3s16(1,0,0))
403 vertex.rotateXZBy(180);
404 if(dir == v3s16(0,0,-1))
405 vertex.rotateXZBy(90);
406 if(dir == v3s16(0,0,1))
407 vertex.rotateXZBy(-90);
410 aabb3f box = aabb3f(vertices[0]);
411 box.addInternalPoint(vertices[1]);
412 boxes.push_back(box);
415 else if (nodebox.type == NODEBOX_CONNECTED)
417 size_t boxes_size = boxes.size();
418 boxes_size += nodebox.fixed.size();
420 boxes_size += nodebox.connect_top.size();
422 boxes_size += nodebox.connect_bottom.size();
424 boxes_size += nodebox.connect_front.size();
426 boxes_size += nodebox.connect_left.size();
428 boxes_size += nodebox.connect_back.size();
430 boxes_size += nodebox.connect_right.size();
431 boxes.reserve(boxes_size);
433 #define BOXESPUSHBACK(c) \
434 for (std::vector<aabb3f>::const_iterator \
436 it != (c).end(); ++it) \
437 (boxes).push_back(*it);
439 BOXESPUSHBACK(nodebox.fixed);
442 BOXESPUSHBACK(nodebox.connect_top);
444 BOXESPUSHBACK(nodebox.connect_bottom);
446 BOXESPUSHBACK(nodebox.connect_front);
448 BOXESPUSHBACK(nodebox.connect_left);
450 BOXESPUSHBACK(nodebox.connect_back);
452 BOXESPUSHBACK(nodebox.connect_right);
454 else // NODEBOX_REGULAR
456 boxes.emplace_back(-BS/2,-BS/2,-BS/2,BS/2,BS/2,BS/2);
460 static inline void getNeighborConnectingFace(
461 const v3s16 &p, INodeDefManager *nodedef,
462 Map *map, MapNode n, u8 bitmask, u8 *neighbors)
464 MapNode n2 = map->getNodeNoEx(p);
465 if (nodedef->nodeboxConnects(n, n2, bitmask))
466 *neighbors |= bitmask;
469 u8 MapNode::getNeighbors(v3s16 p, Map *map)
471 INodeDefManager *nodedef=map->getNodeDefManager();
473 const ContentFeatures &f = nodedef->get(*this);
474 // locate possible neighboring nodes to connect to
475 if (f.drawtype == NDT_NODEBOX && f.node_box.type == NODEBOX_CONNECTED) {
479 getNeighborConnectingFace(p2, nodedef, map, *this, 1, &neighbors);
483 getNeighborConnectingFace(p2, nodedef, map, *this, 2, &neighbors);
487 getNeighborConnectingFace(p2, nodedef, map, *this, 4, &neighbors);
491 getNeighborConnectingFace(p2, nodedef, map, *this, 8, &neighbors);
495 getNeighborConnectingFace(p2, nodedef, map, *this, 16, &neighbors);
499 getNeighborConnectingFace(p2, nodedef, map, *this, 32, &neighbors);
505 void MapNode::getNodeBoxes(INodeDefManager *nodemgr, std::vector<aabb3f> *boxes, u8 neighbors)
507 const ContentFeatures &f = nodemgr->get(*this);
508 transformNodeBox(*this, f.node_box, nodemgr, boxes, neighbors);
511 void MapNode::getCollisionBoxes(INodeDefManager *nodemgr, std::vector<aabb3f> *boxes, u8 neighbors)
513 const ContentFeatures &f = nodemgr->get(*this);
514 if (f.collision_box.fixed.empty())
515 transformNodeBox(*this, f.node_box, nodemgr, boxes, neighbors);
517 transformNodeBox(*this, f.collision_box, nodemgr, boxes, neighbors);
520 void MapNode::getSelectionBoxes(INodeDefManager *nodemgr, std::vector<aabb3f> *boxes, u8 neighbors)
522 const ContentFeatures &f = nodemgr->get(*this);
523 transformNodeBox(*this, f.selection_box, nodemgr, boxes, neighbors);
526 u8 MapNode::getMaxLevel(INodeDefManager *nodemgr) const
528 const ContentFeatures &f = nodemgr->get(*this);
529 // todo: after update in all games leave only if (f.param_type_2 ==
530 if( f.liquid_type == LIQUID_FLOWING || f.param_type_2 == CPT2_FLOWINGLIQUID)
531 return LIQUID_LEVEL_MAX;
532 if(f.leveled || f.param_type_2 == CPT2_LEVELED)
537 u8 MapNode::getLevel(INodeDefManager *nodemgr) const
539 const ContentFeatures &f = nodemgr->get(*this);
540 // todo: after update in all games leave only if (f.param_type_2 ==
541 if(f.liquid_type == LIQUID_SOURCE)
542 return LIQUID_LEVEL_SOURCE;
543 if (f.param_type_2 == CPT2_FLOWINGLIQUID)
544 return getParam2() & LIQUID_LEVEL_MASK;
545 if(f.liquid_type == LIQUID_FLOWING) // can remove if all param_type_2 setted
546 return getParam2() & LIQUID_LEVEL_MASK;
547 if(f.leveled || f.param_type_2 == CPT2_LEVELED) {
548 u8 level = getParam2() & LEVELED_MASK;
551 if(f.leveled > LEVELED_MAX)
553 return f.leveled; //default
558 u8 MapNode::setLevel(INodeDefManager *nodemgr, s8 level)
562 setContent(CONTENT_AIR);
565 const ContentFeatures &f = nodemgr->get(*this);
566 if (f.param_type_2 == CPT2_FLOWINGLIQUID
567 || f.liquid_type == LIQUID_FLOWING
568 || f.liquid_type == LIQUID_SOURCE) {
569 if (level >= LIQUID_LEVEL_SOURCE) {
570 rest = level - LIQUID_LEVEL_SOURCE;
571 setContent(nodemgr->getId(f.liquid_alternative_source));
573 setContent(nodemgr->getId(f.liquid_alternative_flowing));
574 setParam2(level & LIQUID_LEVEL_MASK);
576 } else if (f.leveled || f.param_type_2 == CPT2_LEVELED) {
577 if (level > LEVELED_MAX) {
578 rest = level - LEVELED_MAX;
581 setParam2(level & LEVELED_MASK);
586 u8 MapNode::addLevel(INodeDefManager *nodemgr, s8 add)
588 s8 level = getLevel(nodemgr);
589 if (add == 0) level = 1;
591 return setLevel(nodemgr, level);
594 u32 MapNode::serializedLength(u8 version)
596 if(!ser_ver_supported(version))
597 throw VersionMismatchException("ERROR: MapNode format not supported");
610 void MapNode::serialize(u8 *dest, u8 version)
612 if(!ser_ver_supported(version))
613 throw VersionMismatchException("ERROR: MapNode format not supported");
615 // Can't do this anymore; we have 16-bit dynamically allocated node IDs
616 // in memory; conversion just won't work in this direction.
618 throw SerializationError("MapNode::serialize: serialization to "
619 "version < 24 not possible");
621 writeU16(dest+0, param0);
622 writeU8(dest+2, param1);
623 writeU8(dest+3, param2);
625 void MapNode::deSerialize(u8 *source, u8 version)
627 if(!ser_ver_supported(version))
628 throw VersionMismatchException("ERROR: MapNode format not supported");
632 deSerialize_pre22(source, version);
637 param0 = readU16(source+0);
638 param1 = readU8(source+2);
639 param2 = readU8(source+3);
641 param0 = readU8(source+0);
642 param1 = readU8(source+1);
643 param2 = readU8(source+2);
645 param0 |= ((param2&0xF0)<<4);
650 void MapNode::serializeBulk(std::ostream &os, int version,
651 const MapNode *nodes, u32 nodecount,
652 u8 content_width, u8 params_width, bool compressed)
654 if (!ser_ver_supported(version))
655 throw VersionMismatchException("ERROR: MapNode format not supported");
657 sanity_check(content_width == 2);
658 sanity_check(params_width == 2);
660 // Can't do this anymore; we have 16-bit dynamically allocated node IDs
661 // in memory; conversion just won't work in this direction.
663 throw SerializationError("MapNode::serializeBulk: serialization to "
664 "version < 24 not possible");
666 size_t databuf_size = nodecount * (content_width + params_width);
667 u8 *databuf = new u8[databuf_size];
669 u32 start1 = content_width * nodecount;
670 u32 start2 = (content_width + 1) * nodecount;
673 for (u32 i = 0; i < nodecount; i++) {
674 writeU16(&databuf[i * 2], nodes[i].param0);
675 writeU8(&databuf[start1 + i], nodes[i].param1);
676 writeU8(&databuf[start2 + i], nodes[i].param2);
680 Compress data to output stream
684 compressZlib(databuf, databuf_size, os);
686 os.write((const char*) &databuf[0], databuf_size);
691 // Deserialize bulk node data
692 void MapNode::deSerializeBulk(std::istream &is, int version,
693 MapNode *nodes, u32 nodecount,
694 u8 content_width, u8 params_width, bool compressed)
696 if(!ser_ver_supported(version))
697 throw VersionMismatchException("ERROR: MapNode format not supported");
700 || (content_width != 1 && content_width != 2)
701 || params_width != 2)
702 FATAL_ERROR("Deserialize bulk node data error");
704 // Uncompress or read data
705 u32 len = nodecount * (content_width + params_width);
706 SharedBuffer<u8> databuf(len);
709 std::ostringstream os(std::ios_base::binary);
710 decompressZlib(is, os);
711 std::string s = os.str();
713 throw SerializationError("deSerializeBulkNodes: "
714 "decompress resulted in invalid size");
715 memcpy(&databuf[0], s.c_str(), len);
719 is.read((char*) &databuf[0], len);
720 if(is.eof() || is.fail())
721 throw SerializationError("deSerializeBulkNodes: "
722 "failed to read bulk node data");
725 // Deserialize content
726 if(content_width == 1)
728 for(u32 i=0; i<nodecount; i++)
729 nodes[i].param0 = readU8(&databuf[i]);
731 else if(content_width == 2)
733 for(u32 i=0; i<nodecount; i++)
734 nodes[i].param0 = readU16(&databuf[i*2]);
737 // Deserialize param1
738 u32 start1 = content_width * nodecount;
739 for(u32 i=0; i<nodecount; i++)
740 nodes[i].param1 = readU8(&databuf[start1 + i]);
742 // Deserialize param2
743 u32 start2 = (content_width + 1) * nodecount;
744 if(content_width == 1)
746 for(u32 i=0; i<nodecount; i++) {
747 nodes[i].param2 = readU8(&databuf[start2 + i]);
748 if(nodes[i].param0 > 0x7F){
749 nodes[i].param0 <<= 4;
750 nodes[i].param0 |= (nodes[i].param2&0xF0)>>4;
751 nodes[i].param2 &= 0x0F;
755 else if(content_width == 2)
757 for(u32 i=0; i<nodecount; i++)
758 nodes[i].param2 = readU8(&databuf[start2 + i]);
765 void MapNode::deSerialize_pre22(const u8 *source, u8 version)
771 else if(version <= 9)
783 param0 |= (param2&0xf0)>>4;
788 // Convert special values from old version to new
791 // In these versions, CONTENT_IGNORE and CONTENT_AIR
793 // Version 19 is fucked up with sometimes the old values and sometimes not
795 param0 = CONTENT_IGNORE;
796 else if(param0 == 254)
797 param0 = CONTENT_AIR;
800 // Translate to our known version
801 *this = mapnode_translate_to_internal(*this, version);