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"
30 #include "wieldmesh.h"
31 #include "client/tile.h"
35 #include "util/serialize.h"
36 #include "util/container.h"
37 #include "util/thread.h"
48 ItemDefinition::ItemDefinition()
53 ItemDefinition::ItemDefinition(const ItemDefinition &def)
59 ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
68 description = def.description;
69 inventory_image = def.inventory_image;
70 wield_image = def.wield_image;
71 wield_scale = def.wield_scale;
72 stack_max = def.stack_max;
74 liquids_pointable = def.liquids_pointable;
75 if(def.tool_capabilities)
77 tool_capabilities = new ToolCapabilities(
78 *def.tool_capabilities);
81 node_placement_prediction = def.node_placement_prediction;
82 sound_place = def.sound_place;
87 ItemDefinition::~ItemDefinition()
92 void ItemDefinition::resetInitial()
94 // Initialize pointers to NULL so reset() does not delete undefined pointers
95 tool_capabilities = NULL;
99 void ItemDefinition::reset()
104 inventory_image = "";
106 wield_scale = v3f(1.0, 1.0, 1.0);
109 liquids_pointable = false;
110 if(tool_capabilities)
112 delete tool_capabilities;
113 tool_capabilities = NULL;
116 sound_place = SimpleSoundSpec();
119 node_placement_prediction = "";
122 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
124 if(protocol_version <= 17)
125 writeU8(os, 1); // version
126 else if(protocol_version <= 20)
127 writeU8(os, 2); // version
129 writeU8(os, 3); // version
131 os<<serializeString(name);
132 os<<serializeString(description);
133 os<<serializeString(inventory_image);
134 os<<serializeString(wield_image);
135 writeV3F1000(os, wield_scale);
136 writeS16(os, stack_max);
138 writeU8(os, liquids_pointable);
139 std::string tool_capabilities_s = "";
140 if(tool_capabilities){
141 std::ostringstream tmp_os(std::ios::binary);
142 tool_capabilities->serialize(tmp_os, protocol_version);
143 tool_capabilities_s = tmp_os.str();
145 os<<serializeString(tool_capabilities_s);
146 writeU16(os, groups.size());
147 for(std::map<std::string, int>::const_iterator
148 i = groups.begin(); i != groups.end(); i++){
149 os<<serializeString(i->first);
150 writeS16(os, i->second);
152 os<<serializeString(node_placement_prediction);
153 if(protocol_version > 17){
154 //serializeSimpleSoundSpec(sound_place, os);
155 os<<serializeString(sound_place.name);
156 writeF1000(os, sound_place.gain);
158 if(protocol_version > 20){
159 writeF1000(os, range);
163 void ItemDefinition::deSerialize(std::istream &is)
169 int version = readU8(is);
170 if(version < 1 || version > 3)
171 throw SerializationError("unsupported ItemDefinition version");
172 type = (enum ItemType)readU8(is);
173 name = deSerializeString(is);
174 description = deSerializeString(is);
175 inventory_image = deSerializeString(is);
176 wield_image = deSerializeString(is);
177 wield_scale = readV3F1000(is);
178 stack_max = readS16(is);
180 liquids_pointable = readU8(is);
181 std::string tool_capabilities_s = deSerializeString(is);
182 if(!tool_capabilities_s.empty())
184 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
185 tool_capabilities = new ToolCapabilities;
186 tool_capabilities->deSerialize(tmp_is);
189 u32 groups_size = readU16(is);
190 for(u32 i=0; i<groups_size; i++){
191 std::string name = deSerializeString(is);
192 int value = readS16(is);
193 groups[name] = value;
196 // We cant be sure that node_placement_prediction is send in version 1
198 node_placement_prediction = deSerializeString(is);
199 }catch(SerializationError &e) {};
200 // Set the old default sound
201 sound_place.name = "default_place_node";
202 sound_place.gain = 0.5;
203 } else if(version >= 2) {
204 node_placement_prediction = deSerializeString(is);
205 //deserializeSimpleSoundSpec(sound_place, is);
206 sound_place.name = deSerializeString(is);
207 sound_place.gain = readF1000(is);
210 range = readF1000(is);
212 // If you add anything here, insert it primarily inside the try-catch
213 // block to not need to increase the version.
215 }catch(SerializationError &e) {};
222 // SUGG: Support chains of aliases?
224 class CItemDefManager: public IWritableItemDefManager
229 video::ITexture *inventory_texture;
230 scene::IMesh *wield_mesh;
233 inventory_texture(NULL),
244 m_main_thread = get_current_thread_id();
248 virtual ~CItemDefManager()
251 const std::vector<ClientCached*> &values = m_clientcached.getValues();
252 for(std::vector<ClientCached*>::const_iterator
253 i = values.begin(); i != values.end(); ++i)
255 ClientCached *cc = *i;
257 cc->wield_mesh->drop();
262 for (std::map<std::string, ItemDefinition*>::iterator iter =
263 m_item_definitions.begin(); iter != m_item_definitions.end();
267 m_item_definitions.clear();
269 virtual const ItemDefinition& get(const std::string &name_) const
271 // Convert name according to possible alias
272 std::string name = getAlias(name_);
273 // Get the definition
274 std::map<std::string, ItemDefinition*>::const_iterator i;
275 i = m_item_definitions.find(name);
276 if(i == m_item_definitions.end())
277 i = m_item_definitions.find("unknown");
278 assert(i != m_item_definitions.end());
281 virtual std::string getAlias(const std::string &name) const
283 std::map<std::string, std::string>::const_iterator i;
284 i = m_aliases.find(name);
285 if(i != m_aliases.end())
289 virtual std::set<std::string> getAll() const
291 std::set<std::string> result;
292 for(std::map<std::string, ItemDefinition*>::const_iterator
293 i = m_item_definitions.begin();
294 i != m_item_definitions.end(); i++)
296 result.insert(i->first);
298 for(std::map<std::string, std::string>::const_iterator
299 i = m_aliases.begin();
300 i != m_aliases.end(); i++)
302 result.insert(i->first);
306 virtual bool isKnown(const std::string &name_) const
308 // Convert name according to possible alias
309 std::string name = getAlias(name_);
310 // Get the definition
311 std::map<std::string, ItemDefinition*>::const_iterator i;
312 return m_item_definitions.find(name) != m_item_definitions.end();
316 ClientCached* createClientCachedDirect(const std::string &name,
317 IGameDef *gamedef) const
319 infostream<<"Lazily creating item texture and mesh for \""
320 <<name<<"\""<<std::endl;
322 // This is not thread-safe
323 sanity_check(get_current_thread_id() == m_main_thread);
325 // Skip if already in cache
326 ClientCached *cc = NULL;
327 m_clientcached.get(name, &cc);
331 ITextureSource *tsrc = gamedef->getTextureSource();
332 INodeDefManager *nodedef = gamedef->getNodeDefManager();
333 const ItemDefinition &def = get(name);
335 // Create new ClientCached
336 cc = new ClientCached();
338 // Create an inventory texture
339 cc->inventory_texture = NULL;
340 if(def.inventory_image != "")
341 cc->inventory_texture = tsrc->getTexture(def.inventory_image);
343 // Additional processing for nodes:
344 // - Create a wield mesh if WieldMeshSceneNode can't render
345 // the node on its own.
346 // - If inventory_texture isn't set yet, create one using
347 // render-to-texture.
348 if (def.type == ITEM_NODE) {
349 // Get node properties
350 content_t id = nodedef->getId(name);
351 const ContentFeatures &f = nodedef->get(id);
353 bool need_rtt_mesh = cc->inventory_texture == NULL;
355 // Keep this in sync with WieldMeshSceneNode::setItem()
356 bool need_wield_mesh =
358 f.drawtype == NDT_NORMAL ||
359 f.drawtype == NDT_ALLFACES ||
360 f.drawtype == NDT_AIRLIKE);
362 scene::IMesh *node_mesh = NULL;
364 if (need_rtt_mesh || need_wield_mesh) {
366 if (f.param_type == CPT_LIGHT)
370 Make a mesh from the node
372 MeshMakeData mesh_make_data(gamedef, false);
374 if (f.param_type_2 == CPT2_WALLMOUNTED)
376 MapNode mesh_make_node(id, param1, param2);
377 mesh_make_data.fillSingleNode(&mesh_make_node);
378 MapBlockMesh mapblock_mesh(&mesh_make_data, v3s16(0, 0, 0));
379 node_mesh = mapblock_mesh.getMesh();
381 video::SColor c(255, 255, 255, 255);
382 setMeshColor(node_mesh, c);
384 // scale and translate the mesh so it's a
385 // unit cube centered on the origin
386 scaleMesh(node_mesh, v3f(1.0/BS, 1.0/BS, 1.0/BS));
387 translateMesh(node_mesh, v3f(-1.0, -1.0, -1.0));
391 Draw node mesh into a render target texture
394 TextureFromMeshParams params;
395 params.mesh = node_mesh;
396 params.dim.set(64, 64);
397 params.rtt_texture_name = "INVENTORY_"
399 params.delete_texture_on_shutdown = true;
400 params.camera_position.set(0, 1.0, -1.5);
401 params.camera_position.rotateXZBy(45);
402 params.camera_lookat.set(0, 0, 0);
403 // Set orthogonal projection
404 params.camera_projection_matrix.buildProjectionMatrixOrthoLH(
406 params.ambient_light.set(1.0, 0.2, 0.2, 0.2);
407 params.light_position.set(10, 100, -50);
408 params.light_color.set(1.0, 0.5, 0.5, 0.5);
409 params.light_radius = 1000;
412 params.camera_position.set(0, -1.0, -1.5);
413 params.camera_position.rotateXZBy(45);
414 params.light_position.set(10, -100, -50);
416 cc->inventory_texture =
417 tsrc->generateTextureFromMesh(params);
419 // render-to-target didn't work
420 if (cc->inventory_texture == NULL) {
421 cc->inventory_texture =
422 tsrc->getTexture(f.tiledef[0].name);
427 Use the node mesh as the wield mesh
429 if (need_wield_mesh) {
430 cc->wield_mesh = node_mesh;
431 cc->wield_mesh->grab();
433 // no way reference count can be smaller than 2 in this place!
434 assert(cc->wield_mesh->getReferenceCount() >= 2);
442 m_clientcached.set(name, cc);
446 ClientCached* getClientCached(const std::string &name,
447 IGameDef *gamedef) const
449 ClientCached *cc = NULL;
450 m_clientcached.get(name, &cc);
454 if(get_current_thread_id() == m_main_thread)
456 return createClientCachedDirect(name, gamedef);
460 // We're gonna ask the result to be put into here
461 static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
463 // Throw a request in
464 m_get_clientcached_queue.add(name, 0, 0, &result_queue);
467 // Wait result for a second
468 GetResult<std::string, ClientCached*, u8, u8>
469 result = result_queue.pop_front(1000);
471 if (result.key == name) {
476 catch(ItemNotFoundException &e)
478 errorstream<<"Waiting for clientcached " << name << " timed out."<<std::endl;
479 return &m_dummy_clientcached;
483 // Get item inventory texture
484 virtual video::ITexture* getInventoryTexture(const std::string &name,
485 IGameDef *gamedef) const
487 ClientCached *cc = getClientCached(name, gamedef);
490 return cc->inventory_texture;
492 // Get item wield mesh
493 virtual scene::IMesh* getWieldMesh(const std::string &name,
494 IGameDef *gamedef) const
496 ClientCached *cc = getClientCached(name, gamedef);
499 return cc->wield_mesh;
504 for(std::map<std::string, ItemDefinition*>::const_iterator
505 i = m_item_definitions.begin();
506 i != m_item_definitions.end(); i++)
510 m_item_definitions.clear();
513 // Add the four builtin items:
515 // "unknown" is returned whenever an undefined item
516 // is accessed (is also the unknown node)
517 // "air" is the air node
518 // "ignore" is the ignore node
520 ItemDefinition* hand_def = new ItemDefinition;
522 hand_def->wield_image = "wieldhand.png";
523 hand_def->tool_capabilities = new ToolCapabilities;
524 m_item_definitions.insert(std::make_pair("", hand_def));
526 ItemDefinition* unknown_def = new ItemDefinition;
527 unknown_def->type = ITEM_NODE;
528 unknown_def->name = "unknown";
529 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
531 ItemDefinition* air_def = new ItemDefinition;
532 air_def->type = ITEM_NODE;
533 air_def->name = "air";
534 m_item_definitions.insert(std::make_pair("air", air_def));
536 ItemDefinition* ignore_def = new ItemDefinition;
537 ignore_def->type = ITEM_NODE;
538 ignore_def->name = "ignore";
539 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
541 virtual void registerItem(const ItemDefinition &def)
543 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
544 // Ensure that the "" item (the hand) always has ToolCapabilities
546 FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
548 if(m_item_definitions.count(def.name) == 0)
549 m_item_definitions[def.name] = new ItemDefinition(def);
551 *(m_item_definitions[def.name]) = def;
553 // Remove conflicting alias if it exists
554 bool alias_removed = (m_aliases.erase(def.name) != 0);
556 infostream<<"ItemDefManager: erased alias "<<def.name
557 <<" because item was defined"<<std::endl;
559 virtual void registerAlias(const std::string &name,
560 const std::string &convert_to)
562 if(m_item_definitions.find(name) == m_item_definitions.end())
564 verbosestream<<"ItemDefManager: setting alias "<<name
565 <<" -> "<<convert_to<<std::endl;
566 m_aliases[name] = convert_to;
569 void serialize(std::ostream &os, u16 protocol_version)
571 writeU8(os, 0); // version
572 u16 count = m_item_definitions.size();
574 for(std::map<std::string, ItemDefinition*>::const_iterator
575 i = m_item_definitions.begin();
576 i != m_item_definitions.end(); i++)
578 ItemDefinition *def = i->second;
579 // Serialize ItemDefinition and write wrapped in a string
580 std::ostringstream tmp_os(std::ios::binary);
581 def->serialize(tmp_os, protocol_version);
582 os<<serializeString(tmp_os.str());
584 writeU16(os, m_aliases.size());
585 for(std::map<std::string, std::string>::const_iterator
586 i = m_aliases.begin(); i != m_aliases.end(); i++)
588 os<<serializeString(i->first);
589 os<<serializeString(i->second);
592 void deSerialize(std::istream &is)
597 int version = readU8(is);
599 throw SerializationError("unsupported ItemDefManager version");
600 u16 count = readU16(is);
601 for(u16 i=0; i<count; i++)
603 // Deserialize a string and grab an ItemDefinition from it
604 std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
606 def.deSerialize(tmp_is);
610 u16 num_aliases = readU16(is);
611 for(u16 i=0; i<num_aliases; i++)
613 std::string name = deSerializeString(is);
614 std::string convert_to = deSerializeString(is);
615 registerAlias(name, convert_to);
618 void processQueue(IGameDef *gamedef)
621 //NOTE this is only thread safe for ONE consumer thread!
622 while(!m_get_clientcached_queue.empty())
624 GetRequest<std::string, ClientCached*, u8, u8>
625 request = m_get_clientcached_queue.pop();
627 m_get_clientcached_queue.pushResult(request,
628 createClientCachedDirect(request.key, gamedef));
634 std::map<std::string, ItemDefinition*> m_item_definitions;
636 std::map<std::string, std::string> m_aliases;
638 // The id of the thread that is allowed to use irrlicht directly
639 threadid_t m_main_thread;
640 // A reference to this can be returned when nothing is found, to avoid NULLs
641 mutable ClientCached m_dummy_clientcached;
642 // Cached textures and meshes
643 mutable MutexedMap<std::string, ClientCached*> m_clientcached;
644 // Queued clientcached fetches (to be processed by the main thread)
645 mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
649 IWritableItemDefManager* createItemDefManager()
651 return new CItemDefManager();