3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2013 Kahrl <kahrl@gmx.net>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include "inventory.h"
28 #include "mapblock_mesh.h"
33 #include "main.h" // g_settings
35 #include "util/serialize.h"
36 #include "util/container.h"
37 #include "util/thread.h"
44 ItemDefinition::ItemDefinition()
49 ItemDefinition::ItemDefinition(const ItemDefinition &def)
55 ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
64 description = def.description;
65 inventory_image = def.inventory_image;
66 wield_image = def.wield_image;
67 wield_scale = def.wield_scale;
68 stack_max = def.stack_max;
70 liquids_pointable = def.liquids_pointable;
71 if(def.tool_capabilities)
73 tool_capabilities = new ToolCapabilities(
74 *def.tool_capabilities);
77 node_placement_prediction = def.node_placement_prediction;
78 sound_place = def.sound_place;
82 ItemDefinition::~ItemDefinition()
87 void ItemDefinition::resetInitial()
89 // Initialize pointers to NULL so reset() does not delete undefined pointers
90 tool_capabilities = NULL;
94 void ItemDefinition::reset()
101 wield_scale = v3f(1.0, 1.0, 1.0);
104 liquids_pointable = false;
105 if(tool_capabilities)
107 delete tool_capabilities;
108 tool_capabilities = NULL;
111 sound_place = SimpleSoundSpec();
113 node_placement_prediction = "";
116 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
118 if(protocol_version <= 17)
119 writeU8(os, 1); // version
121 writeU8(os, 2); // version
123 os<<serializeString(name);
124 os<<serializeString(description);
125 os<<serializeString(inventory_image);
126 os<<serializeString(wield_image);
127 writeV3F1000(os, wield_scale);
128 writeS16(os, stack_max);
130 writeU8(os, liquids_pointable);
131 std::string tool_capabilities_s = "";
132 if(tool_capabilities){
133 std::ostringstream tmp_os(std::ios::binary);
134 tool_capabilities->serialize(tmp_os, protocol_version);
135 tool_capabilities_s = tmp_os.str();
137 os<<serializeString(tool_capabilities_s);
138 writeU16(os, groups.size());
139 for(std::map<std::string, int>::const_iterator
140 i = groups.begin(); i != groups.end(); i++){
141 os<<serializeString(i->first);
142 writeS16(os, i->second);
144 os<<serializeString(node_placement_prediction);
145 if(protocol_version > 17){
146 //serializeSimpleSoundSpec(sound_place, os);
147 os<<serializeString(sound_place.name);
148 writeF1000(os, sound_place.gain);
152 void ItemDefinition::deSerialize(std::istream &is)
158 int version = readU8(is);
159 if(version != 1 && version != 2)
160 throw SerializationError("unsupported ItemDefinition version");
161 type = (enum ItemType)readU8(is);
162 name = deSerializeString(is);
163 description = deSerializeString(is);
164 inventory_image = deSerializeString(is);
165 wield_image = deSerializeString(is);
166 wield_scale = readV3F1000(is);
167 stack_max = readS16(is);
169 liquids_pointable = readU8(is);
170 std::string tool_capabilities_s = deSerializeString(is);
171 if(!tool_capabilities_s.empty())
173 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
174 tool_capabilities = new ToolCapabilities;
175 tool_capabilities->deSerialize(tmp_is);
178 u32 groups_size = readU16(is);
179 for(u32 i=0; i<groups_size; i++){
180 std::string name = deSerializeString(is);
181 int value = readS16(is);
182 groups[name] = value;
185 // We cant be sure that node_placement_prediction is send in version 1
187 node_placement_prediction = deSerializeString(is);
188 }catch(SerializationError &e) {};
189 // Set the old default sound
190 sound_place.name = "default_place_node";
191 sound_place.gain = 0.5;
192 } else if(version == 2) {
193 node_placement_prediction = deSerializeString(is);
194 //deserializeSimpleSoundSpec(sound_place, is);
195 sound_place.name = deSerializeString(is);
196 sound_place.gain = readF1000(is);
198 // If you add anything here, insert it primarily inside the try-catch
199 // block to not need to increase the version.
202 }catch(SerializationError &e) {};
209 // SUGG: Support chains of aliases?
211 class CItemDefManager: public IWritableItemDefManager
216 video::ITexture *inventory_texture;
217 scene::IMesh *wield_mesh;
220 inventory_texture(NULL),
230 m_main_thread = get_current_thread_id();
235 virtual ~CItemDefManager()
238 const std::list<ClientCached*> &values = m_clientcached.getValues();
239 for(std::list<ClientCached*>::const_iterator
240 i = values.begin(); i != values.end(); ++i)
242 ClientCached *cc = *i;
243 cc->wield_mesh->drop();
247 virtual const ItemDefinition& get(const std::string &name_) const
249 // Convert name according to possible alias
250 std::string name = getAlias(name_);
251 // Get the definition
252 std::map<std::string, ItemDefinition*>::const_iterator i;
253 i = m_item_definitions.find(name);
254 if(i == m_item_definitions.end())
255 i = m_item_definitions.find("unknown");
256 assert(i != m_item_definitions.end());
259 virtual std::string getAlias(const std::string &name) const
261 std::map<std::string, std::string>::const_iterator i;
262 i = m_aliases.find(name);
263 if(i != m_aliases.end())
267 virtual std::set<std::string> getAll() const
269 std::set<std::string> result;
270 for(std::map<std::string, ItemDefinition*>::const_iterator
271 i = m_item_definitions.begin();
272 i != m_item_definitions.end(); i++)
274 result.insert(i->first);
276 for(std::map<std::string, std::string>::const_iterator
277 i = m_aliases.begin();
278 i != m_aliases.end(); i++)
280 result.insert(i->first);
284 virtual bool isKnown(const std::string &name_) const
286 // Convert name according to possible alias
287 std::string name = getAlias(name_);
288 // Get the definition
289 std::map<std::string, ItemDefinition*>::const_iterator i;
290 return m_item_definitions.find(name) != m_item_definitions.end();
293 ClientCached* createClientCachedDirect(const std::string &name,
294 IGameDef *gamedef) const
296 infostream<<"Lazily creating item texture and mesh for \""
297 <<name<<"\""<<std::endl;
299 // This is not thread-safe
300 assert(get_current_thread_id() == m_main_thread);
302 // Skip if already in cache
303 ClientCached *cc = NULL;
304 m_clientcached.get(name, &cc);
308 ITextureSource *tsrc = gamedef->getTextureSource();
309 INodeDefManager *nodedef = gamedef->getNodeDefManager();
310 IrrlichtDevice *device = tsrc->getDevice();
311 video::IVideoDriver *driver = device->getVideoDriver();
312 const ItemDefinition *def = &get(name);
314 // Create new ClientCached
315 cc = new ClientCached();
317 bool need_node_mesh = false;
319 // Create an inventory texture
320 cc->inventory_texture = NULL;
321 if(def->inventory_image != "")
323 cc->inventory_texture = tsrc->getTextureRaw(def->inventory_image);
325 else if(def->type == ITEM_NODE)
327 need_node_mesh = true;
330 // Create a wield mesh
331 if(cc->wield_mesh != NULL)
333 cc->wield_mesh->drop();
334 cc->wield_mesh = NULL;
336 if(def->type == ITEM_NODE && def->wield_image == "")
338 need_node_mesh = true;
340 else if(def->wield_image != "" || def->inventory_image != "")
342 // Extrude the wield image into a mesh
344 std::string imagename;
345 if(def->wield_image != "")
346 imagename = def->wield_image;
348 imagename = def->inventory_image;
350 cc->wield_mesh = createExtrudedMesh(
351 tsrc->getTextureRaw(imagename),
353 def->wield_scale * v3f(40.0, 40.0, 4.0));
354 if(cc->wield_mesh == NULL)
356 infostream<<"ItemDefManager: WARNING: "
357 <<"updateTexturesAndMeshes(): "
358 <<"Unable to create extruded mesh for item "
359 <<def->name<<std::endl;
368 content_t id = nodedef->getId(def->name);
369 const ContentFeatures &f = nodedef->get(id);
372 if(f.param_type == CPT_LIGHT)
376 Make a mesh from the node
378 MeshMakeData mesh_make_data(gamedef);
379 MapNode mesh_make_node(id, param1, 0);
380 mesh_make_data.fillSingleNode(&mesh_make_node);
381 MapBlockMesh mapblock_mesh(&mesh_make_data);
383 scene::IMesh *node_mesh = mapblock_mesh.getMesh();
385 video::SColor c(255, 255, 255, 255);
386 if(g_settings->getS32("enable_shaders") != 0)
387 c = MapBlock_LightColor(255, 0xffff, decode_light(f.light_source));
388 setMeshColor(node_mesh, c);
391 Scale and translate the mesh so it's a unit cube
392 centered on the origin
394 scaleMesh(node_mesh, v3f(1.0/BS, 1.0/BS, 1.0/BS));
395 translateMesh(node_mesh, v3f(-1.0, -1.0, -1.0));
398 Draw node mesh into a render target texture
400 if(cc->inventory_texture == NULL)
402 core::dimension2d<u32> dim(64,64);
403 std::string rtt_texture_name = "INVENTORY_"
404 + def->name + "_RTT";
405 v3f camera_position(0, 1.0, -1.5);
406 camera_position.rotateXZBy(45);
407 v3f camera_lookat(0, 0, 0);
408 core::CMatrix4<f32> camera_projection_matrix;
409 // Set orthogonal projection
410 camera_projection_matrix.buildProjectionMatrixOrthoLH(
413 video::SColorf ambient_light(0.2,0.2,0.2);
414 v3f light_position(10, 100, -50);
415 video::SColorf light_color(0.5,0.5,0.5);
416 f32 light_radius = 1000;
418 cc->inventory_texture = generateTextureFromMesh(
419 node_mesh, device, dim, rtt_texture_name,
422 camera_projection_matrix,
428 // render-to-target didn't work
429 if(cc->inventory_texture == NULL)
431 cc->inventory_texture =
432 tsrc->getTextureRaw(f.tiledef[0].name);
437 Use the node mesh as the wield mesh
439 if(cc->wield_mesh == NULL)
441 // Scale to proper wield mesh proportions
442 scaleMesh(node_mesh, v3f(30.0, 30.0, 30.0)
444 cc->wield_mesh = node_mesh;
445 cc->wield_mesh->grab();
448 // falling outside of here deletes node_mesh
452 m_clientcached.set(name, cc);
456 ClientCached* getClientCached(const std::string &name,
457 IGameDef *gamedef) const
459 ClientCached *cc = NULL;
460 m_clientcached.get(name, &cc);
464 if(get_current_thread_id() == m_main_thread)
466 return createClientCachedDirect(name, gamedef);
470 // We're gonna ask the result to be put into here
471 ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
472 // Throw a request in
473 m_get_clientcached_queue.add(name, 0, 0, &result_queue);
475 // Wait result for a second
476 GetResult<std::string, ClientCached*, u8, u8>
477 result = result_queue.pop_front(1000);
478 // Check that at least something worked OK
479 assert(result.key == name);
483 catch(ItemNotFoundException &e)
485 errorstream<<"Waiting for clientcached timed out."<<std::endl;
486 return &m_dummy_clientcached;
490 // Get item inventory texture
491 virtual video::ITexture* getInventoryTexture(const std::string &name,
492 IGameDef *gamedef) const
494 ClientCached *cc = getClientCached(name, gamedef);
497 return cc->inventory_texture;
499 // Get item wield mesh
500 virtual scene::IMesh* getWieldMesh(const std::string &name,
501 IGameDef *gamedef) const
503 ClientCached *cc = getClientCached(name, gamedef);
506 return cc->wield_mesh;
511 for(std::map<std::string, ItemDefinition*>::const_iterator
512 i = m_item_definitions.begin();
513 i != m_item_definitions.end(); i++)
517 m_item_definitions.clear();
520 // Add the four builtin items:
522 // "unknown" is returned whenever an undefined item is accessed
523 // "air" is the air node
524 // "ignore" is the ignore node
526 ItemDefinition* hand_def = new ItemDefinition;
528 hand_def->wield_image = "wieldhand.png";
529 hand_def->tool_capabilities = new ToolCapabilities;
530 m_item_definitions.insert(std::make_pair("", hand_def));
532 ItemDefinition* unknown_def = new ItemDefinition;
533 unknown_def->name = "unknown";
534 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
536 ItemDefinition* air_def = new ItemDefinition;
537 air_def->type = ITEM_NODE;
538 air_def->name = "air";
539 m_item_definitions.insert(std::make_pair("air", air_def));
541 ItemDefinition* ignore_def = new ItemDefinition;
542 ignore_def->type = ITEM_NODE;
543 ignore_def->name = "ignore";
544 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
546 virtual void registerItem(const ItemDefinition &def)
548 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
549 // Ensure that the "" item (the hand) always has ToolCapabilities
551 assert(def.tool_capabilities != NULL);
553 if(m_item_definitions.count(def.name) == 0)
554 m_item_definitions[def.name] = new ItemDefinition(def);
556 *(m_item_definitions[def.name]) = def;
558 // Remove conflicting alias if it exists
559 bool alias_removed = (m_aliases.erase(def.name) != 0);
561 infostream<<"ItemDefManager: erased alias "<<def.name
562 <<" because item was defined"<<std::endl;
564 virtual void registerAlias(const std::string &name,
565 const std::string &convert_to)
567 if(m_item_definitions.find(name) == m_item_definitions.end())
569 verbosestream<<"ItemDefManager: setting alias "<<name
570 <<" -> "<<convert_to<<std::endl;
571 m_aliases[name] = convert_to;
574 void serialize(std::ostream &os, u16 protocol_version)
576 writeU8(os, 0); // version
577 u16 count = m_item_definitions.size();
579 for(std::map<std::string, ItemDefinition*>::const_iterator
580 i = m_item_definitions.begin();
581 i != m_item_definitions.end(); i++)
583 ItemDefinition *def = i->second;
584 // Serialize ItemDefinition and write wrapped in a string
585 std::ostringstream tmp_os(std::ios::binary);
586 def->serialize(tmp_os, protocol_version);
587 os<<serializeString(tmp_os.str());
589 writeU16(os, m_aliases.size());
590 for(std::map<std::string, std::string>::const_iterator
591 i = m_aliases.begin(); i != m_aliases.end(); i++)
593 os<<serializeString(i->first);
594 os<<serializeString(i->second);
597 void deSerialize(std::istream &is)
602 int version = readU8(is);
604 throw SerializationError("unsupported ItemDefManager version");
605 u16 count = readU16(is);
606 for(u16 i=0; i<count; i++)
608 // Deserialize a string and grab an ItemDefinition from it
609 std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
611 def.deSerialize(tmp_is);
615 u16 num_aliases = readU16(is);
616 for(u16 i=0; i<num_aliases; i++)
618 std::string name = deSerializeString(is);
619 std::string convert_to = deSerializeString(is);
620 registerAlias(name, convert_to);
623 void processQueue(IGameDef *gamedef)
626 while(!m_get_clientcached_queue.empty())
628 GetRequest<std::string, ClientCached*, u8, u8>
629 request = m_get_clientcached_queue.pop();
630 GetResult<std::string, ClientCached*, u8, u8>
632 result.key = request.key;
633 result.callers = request.callers;
634 result.item = createClientCachedDirect(request.key, gamedef);
635 request.dest->push_back(result);
641 std::map<std::string, ItemDefinition*> m_item_definitions;
643 std::map<std::string, std::string> m_aliases;
645 // The id of the thread that is allowed to use irrlicht directly
646 threadid_t m_main_thread;
647 // A reference to this can be returned when nothing is found, to avoid NULLs
648 mutable ClientCached m_dummy_clientcached;
649 // Cached textures and meshes
650 mutable MutexedMap<std::string, ClientCached*> m_clientcached;
651 // Queued clientcached fetches (to be processed by the main thread)
652 mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
656 IWritableItemDefManager* createItemDefManager()
658 return new CItemDefManager();