src/client/wieldmesh.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2014 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21
  22 #include <string>
  23 #include <vector>
  24 #include "irrlichttypes_extrabloated.h"
  25
  26 struct ItemStack;
  27 class Client;
  28 class ITextureSource;
  29 struct ContentFeatures;
  30
  31 /*!
  32  * Holds color information of an item mesh's buffer.
  33  */
  34 struct ItemPartColor
  35 {
  36         /*!
  37          * If this is false, the global base color of the item
  38          * will be used instead of the specific color of the
  39          * buffer.
  40          */
  41         bool override_base = false;
  42         /*!
  43          * The color of the buffer.
  44          */
  45         video::SColor color = 0;
  46
  47         ItemPartColor() = default;
  48
  49         ItemPartColor(bool override, video::SColor color) :
  50                         override_base(override), color(color)
  51         {
  52         }
  53 };
  54
  55 struct ItemMesh
  56 {
  57         scene::IMesh *mesh = nullptr;
  58         /*!
  59          * Stores the color of each mesh buffer.
  60          */
  61         std::vector<ItemPartColor> buffer_colors;
  62         /*!
  63          * If false, all faces of the item should have the same brightness.
  64          * Disables shading based on normal vectors.
  65          */
  66         bool needs_shading = true;
  67
  68         ItemMesh() = default;
  69 };
  70
  71 /*
  72         Wield item scene node, renders the wield mesh of some item
  73 */
  74 class WieldMeshSceneNode : public scene::ISceneNode
  75 {
  76 public:
  77         WieldMeshSceneNode(scene::ISceneManager *mgr, s32 id = -1, bool lighting = false);
  78         virtual ~WieldMeshSceneNode();
  79
  80         void setCube(const ContentFeatures &f, v3f wield_scale);
  81         void setExtruded(const std::string &imagename, const std::string &overlay_image,
  82                         v3f wield_scale, ITextureSource *tsrc, u8 num_frames);
  83         void setItem(const ItemStack &item, Client *client,
  84                         bool check_wield_image = true);
  85
  86         // Sets the vertex color of the wield mesh.
  87         // Must only be used if the constructor was called with lighting = false
  88         void setColor(video::SColor color);
  89
  90         void setNodeLightColor(video::SColor color);
  91
  92         scene::IMesh *getMesh() { return m_meshnode->getMesh(); }
  93
  94         virtual void render();
  95
  96         virtual const aabb3f &getBoundingBox() const { return m_bounding_box; }
  97
  98 private:
  99         void changeToMesh(scene::IMesh *mesh);
 100
 101         // Child scene node with the current wield mesh
 102         scene::IMeshSceneNode *m_meshnode = nullptr;
 103         video::E_MATERIAL_TYPE m_material_type;
 104
 105         // True if EMF_LIGHTING should be enabled.
 106         bool m_lighting;
 107
 108         bool m_enable_shaders;
 109         bool m_anisotropic_filter;
 110         bool m_bilinear_filter;
 111         bool m_trilinear_filter;
 112         /*!
 113          * Stores the colors of the mesh's mesh buffers.
 114          * This does not include lighting.
 115          */
 116         std::vector<ItemPartColor> m_colors;
 117         /*!
 118          * The base color of this mesh. This is the default
 119          * for all mesh buffers.
 120          */
 121         video::SColor m_base_color;
 122
 123         // Bounding box culling is disabled for this type of scene node,
 124         // so this variable is just required so we can implement
 125         // getBoundingBox() and is set to an empty box.
 126         aabb3f m_bounding_box;
 127 };
 128
 129 void getItemMesh(Client *client, const ItemStack &item, ItemMesh *result);
 130
 131 scene::SMesh *getExtrudedMesh(ITextureSource *tsrc, const std::string &imagename,
 132                 const std::string &overlay_name);
 133
 134 /*!
 135  * Applies overlays, textures and optionally materials to the given mesh and
 136  * extracts tile colors for colorization.
 137  * \param mattype overrides the buffer's material type, but can also
 138  * be NULL to leave the original material.
 139  * \param colors returns the colors of the mesh buffers in the mesh.
 140  */
 141 void postProcessNodeMesh(scene::SMesh *mesh, const ContentFeatures &f, bool use_shaders,
 142                 bool set_material, const video::E_MATERIAL_TYPE *mattype,
 143                 std::vector<ItemPartColor> *colors, bool apply_scale = false);