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 StringMap::const_iterator it = m_aliases.find(name);
284 if (it != m_aliases.end())
288 virtual std::set<std::string> getAll() const
290 std::set<std::string> result;
291 for(std::map<std::string, ItemDefinition *>::const_iterator
292 it = m_item_definitions.begin();
293 it != m_item_definitions.end(); ++it) {
294 result.insert(it->first);
296 for (StringMap::const_iterator
297 it = m_aliases.begin();
298 it != m_aliases.end(); ++it) {
299 result.insert(it->first);
303 virtual bool isKnown(const std::string &name_) const
305 // Convert name according to possible alias
306 std::string name = getAlias(name_);
307 // Get the definition
308 std::map<std::string, ItemDefinition*>::const_iterator i;
309 return m_item_definitions.find(name) != m_item_definitions.end();
313 ClientCached* createClientCachedDirect(const std::string &name,
314 IGameDef *gamedef) const
316 infostream<<"Lazily creating item texture and mesh for \""
317 <<name<<"\""<<std::endl;
319 // This is not thread-safe
320 sanity_check(get_current_thread_id() == m_main_thread);
322 // Skip if already in cache
323 ClientCached *cc = NULL;
324 m_clientcached.get(name, &cc);
328 ITextureSource *tsrc = gamedef->getTextureSource();
329 INodeDefManager *nodedef = gamedef->getNodeDefManager();
330 const ItemDefinition &def = get(name);
332 // Create new ClientCached
333 cc = new ClientCached();
335 // Create an inventory texture
336 cc->inventory_texture = NULL;
337 if(def.inventory_image != "")
338 cc->inventory_texture = tsrc->getTexture(def.inventory_image);
340 // Additional processing for nodes:
341 // - Create a wield mesh if WieldMeshSceneNode can't render
342 // the node on its own.
343 // - If inventory_texture isn't set yet, create one using
344 // render-to-texture.
345 if (def.type == ITEM_NODE) {
346 // Get node properties
347 content_t id = nodedef->getId(name);
348 const ContentFeatures &f = nodedef->get(id);
350 bool need_rtt_mesh = cc->inventory_texture == NULL;
352 // Keep this in sync with WieldMeshSceneNode::setItem()
353 bool need_wield_mesh =
355 f.drawtype == NDT_NORMAL ||
356 f.drawtype == NDT_ALLFACES ||
357 f.drawtype == NDT_AIRLIKE);
359 scene::IMesh *node_mesh = NULL;
361 if (need_rtt_mesh || need_wield_mesh) {
363 if (f.param_type == CPT_LIGHT)
367 Make a mesh from the node
369 MeshMakeData mesh_make_data(gamedef, false);
371 if (f.param_type_2 == CPT2_WALLMOUNTED)
373 MapNode mesh_make_node(id, param1, param2);
374 mesh_make_data.fillSingleNode(&mesh_make_node);
375 MapBlockMesh mapblock_mesh(&mesh_make_data, v3s16(0, 0, 0));
376 node_mesh = mapblock_mesh.getMesh();
378 video::SColor c(255, 255, 255, 255);
379 setMeshColor(node_mesh, c);
381 // scale and translate the mesh so it's a
382 // unit cube centered on the origin
383 scaleMesh(node_mesh, v3f(1.0/BS, 1.0/BS, 1.0/BS));
384 translateMesh(node_mesh, v3f(-1.0, -1.0, -1.0));
388 Draw node mesh into a render target texture
391 TextureFromMeshParams params;
392 params.mesh = node_mesh;
393 params.dim.set(64, 64);
394 params.rtt_texture_name = "INVENTORY_"
396 params.delete_texture_on_shutdown = true;
397 params.camera_position.set(0, 1.0, -1.5);
398 params.camera_position.rotateXZBy(45);
399 params.camera_lookat.set(0, 0, 0);
400 // Set orthogonal projection
401 params.camera_projection_matrix.buildProjectionMatrixOrthoLH(
403 params.ambient_light.set(1.0, 0.2, 0.2, 0.2);
404 params.light_position.set(10, 100, -50);
405 params.light_color.set(1.0, 0.5, 0.5, 0.5);
406 params.light_radius = 1000;
409 params.camera_position.set(0, -1.0, -1.5);
410 params.camera_position.rotateXZBy(45);
411 params.light_position.set(10, -100, -50);
413 cc->inventory_texture =
414 tsrc->generateTextureFromMesh(params);
416 // render-to-target didn't work
417 if (cc->inventory_texture == NULL) {
418 cc->inventory_texture =
419 tsrc->getTexture(f.tiledef[0].name);
424 Use the node mesh as the wield mesh
426 if (need_wield_mesh) {
427 cc->wield_mesh = node_mesh;
428 cc->wield_mesh->grab();
430 // no way reference count can be smaller than 2 in this place!
431 assert(cc->wield_mesh->getReferenceCount() >= 2);
439 m_clientcached.set(name, cc);
443 ClientCached* getClientCached(const std::string &name,
444 IGameDef *gamedef) const
446 ClientCached *cc = NULL;
447 m_clientcached.get(name, &cc);
451 if(get_current_thread_id() == m_main_thread)
453 return createClientCachedDirect(name, gamedef);
457 // We're gonna ask the result to be put into here
458 static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
460 // Throw a request in
461 m_get_clientcached_queue.add(name, 0, 0, &result_queue);
464 // Wait result for a second
465 GetResult<std::string, ClientCached*, u8, u8>
466 result = result_queue.pop_front(1000);
468 if (result.key == name) {
473 catch(ItemNotFoundException &e)
475 errorstream<<"Waiting for clientcached " << name << " timed out."<<std::endl;
476 return &m_dummy_clientcached;
480 // Get item inventory texture
481 virtual video::ITexture* getInventoryTexture(const std::string &name,
482 IGameDef *gamedef) const
484 ClientCached *cc = getClientCached(name, gamedef);
487 return cc->inventory_texture;
489 // Get item wield mesh
490 virtual scene::IMesh* getWieldMesh(const std::string &name,
491 IGameDef *gamedef) const
493 ClientCached *cc = getClientCached(name, gamedef);
496 return cc->wield_mesh;
501 for(std::map<std::string, ItemDefinition*>::const_iterator
502 i = m_item_definitions.begin();
503 i != m_item_definitions.end(); i++)
507 m_item_definitions.clear();
510 // Add the four builtin items:
512 // "unknown" is returned whenever an undefined item
513 // is accessed (is also the unknown node)
514 // "air" is the air node
515 // "ignore" is the ignore node
517 ItemDefinition* hand_def = new ItemDefinition;
519 hand_def->wield_image = "wieldhand.png";
520 hand_def->tool_capabilities = new ToolCapabilities;
521 m_item_definitions.insert(std::make_pair("", hand_def));
523 ItemDefinition* unknown_def = new ItemDefinition;
524 unknown_def->type = ITEM_NODE;
525 unknown_def->name = "unknown";
526 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
528 ItemDefinition* air_def = new ItemDefinition;
529 air_def->type = ITEM_NODE;
530 air_def->name = "air";
531 m_item_definitions.insert(std::make_pair("air", air_def));
533 ItemDefinition* ignore_def = new ItemDefinition;
534 ignore_def->type = ITEM_NODE;
535 ignore_def->name = "ignore";
536 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
538 virtual void registerItem(const ItemDefinition &def)
540 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
541 // Ensure that the "" item (the hand) always has ToolCapabilities
543 FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
545 if(m_item_definitions.count(def.name) == 0)
546 m_item_definitions[def.name] = new ItemDefinition(def);
548 *(m_item_definitions[def.name]) = def;
550 // Remove conflicting alias if it exists
551 bool alias_removed = (m_aliases.erase(def.name) != 0);
553 infostream<<"ItemDefManager: erased alias "<<def.name
554 <<" because item was defined"<<std::endl;
556 virtual void registerAlias(const std::string &name,
557 const std::string &convert_to)
559 if(m_item_definitions.find(name) == m_item_definitions.end())
561 verbosestream<<"ItemDefManager: setting alias "<<name
562 <<" -> "<<convert_to<<std::endl;
563 m_aliases[name] = convert_to;
566 void serialize(std::ostream &os, u16 protocol_version)
568 writeU8(os, 0); // version
569 u16 count = m_item_definitions.size();
572 for (std::map<std::string, ItemDefinition *>::const_iterator
573 it = m_item_definitions.begin();
574 it != m_item_definitions.end(); ++it) {
575 ItemDefinition *def = it->second;
576 // Serialize ItemDefinition and write wrapped in a string
577 std::ostringstream tmp_os(std::ios::binary);
578 def->serialize(tmp_os, protocol_version);
579 os << serializeString(tmp_os.str());
582 writeU16(os, m_aliases.size());
584 for (StringMap::const_iterator
585 it = m_aliases.begin();
586 it != m_aliases.end(); ++it) {
587 os << serializeString(it->first);
588 os << serializeString(it->second);
591 void deSerialize(std::istream &is)
596 int version = readU8(is);
598 throw SerializationError("unsupported ItemDefManager version");
599 u16 count = readU16(is);
600 for(u16 i=0; i<count; i++)
602 // Deserialize a string and grab an ItemDefinition from it
603 std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
605 def.deSerialize(tmp_is);
609 u16 num_aliases = readU16(is);
610 for(u16 i=0; i<num_aliases; i++)
612 std::string name = deSerializeString(is);
613 std::string convert_to = deSerializeString(is);
614 registerAlias(name, convert_to);
617 void processQueue(IGameDef *gamedef)
620 //NOTE this is only thread safe for ONE consumer thread!
621 while(!m_get_clientcached_queue.empty())
623 GetRequest<std::string, ClientCached*, u8, u8>
624 request = m_get_clientcached_queue.pop();
626 m_get_clientcached_queue.pushResult(request,
627 createClientCachedDirect(request.key, gamedef));
633 std::map<std::string, ItemDefinition*> m_item_definitions;
637 // The id of the thread that is allowed to use irrlicht directly
638 threadid_t m_main_thread;
639 // A reference to this can be returned when nothing is found, to avoid NULLs
640 mutable ClientCached m_dummy_clientcached;
641 // Cached textures and meshes
642 mutable MutexedMap<std::string, ClientCached*> m_clientcached;
643 // Queued clientcached fetches (to be processed by the main thread)
644 mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
648 IWritableItemDefManager* createItemDefManager()
650 return new CItemDefManager();