src/client/tile.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 #ifndef TILE_HEADER
  21 #define TILE_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include "irr_v3d.h"
  25 #include <ITexture.h>
  26 #include <string>
  27 #include <vector>
  28 #include <SMaterial.h>
  29 #include <memory>
  30 #include "util/numeric.h"
  31
  32 class IGameDef;
  33 struct TileSpec;
  34 struct TileDef;
  35
  36 typedef std::vector<video::SColor> Palette;
  37
  38 /*
  39         tile.{h,cpp}: Texture handling stuff.
  40 */
  41
  42 /*
  43         Find out the full path of an image by trying different filename
  44         extensions.
  45
  46         If failed, return "".
  47
  48         TODO: Should probably be moved out from here, because things needing
  49               this function do not need anything else from this header
  50 */
  51 std::string getImagePath(std::string path);
  52
  53 /*
  54         Gets the path to a texture by first checking if the texture exists
  55         in texture_path and if not, using the data path.
  56
  57         Checks all supported extensions by replacing the original extension.
  58
  59         If not found, returns "".
  60
  61         Utilizes a thread-safe cache.
  62 */
  63 std::string getTexturePath(const std::string &filename);
  64
  65 void clearTextureNameCache();
  66
  67 /*
  68         ITextureSource::generateTextureFromMesh parameters
  69 */
  70 namespace irr {namespace scene {class IMesh;}}
  71 struct TextureFromMeshParams
  72 {
  73         scene::IMesh *mesh = nullptr;
  74         core::dimension2d<u32> dim;
  75         std::string rtt_texture_name;
  76         bool delete_texture_on_shutdown;
  77         v3f camera_position;
  78         v3f camera_lookat;
  79         core::CMatrix4<f32> camera_projection_matrix;
  80         video::SColorf ambient_light;
  81         v3f light_position;
  82         video::SColorf light_color;
  83         f32 light_radius;
  84 };
  85
  86 /*
  87         TextureSource creates and caches textures.
  88 */
  89
  90 class ISimpleTextureSource
  91 {
  92 public:
  93         ISimpleTextureSource(){}
  94         virtual ~ISimpleTextureSource(){}
  95         virtual video::ITexture* getTexture(
  96                         const std::string &name, u32 *id = nullptr) = 0;
  97 };
  98
  99 class ITextureSource : public ISimpleTextureSource
 100 {
 101 public:
 102         ITextureSource(){}
 103         virtual ~ITextureSource(){}
 104         virtual u32 getTextureId(const std::string &name)=0;
 105         virtual std::string getTextureName(u32 id)=0;
 106         virtual video::ITexture* getTexture(u32 id)=0;
 107         virtual video::ITexture* getTexture(
 108                         const std::string &name, u32 *id = nullptr)=0;
 109         virtual video::ITexture* getTextureForMesh(
 110                         const std::string &name, u32 *id = nullptr) = 0;
 111         /*!
 112          * Returns a palette from the given texture name.
 113          * The pointer is valid until the texture source is
 114          * destructed.
 115          * Should be called from the main thread.
 116          */
 117         virtual Palette* getPalette(const std::string &name) = 0;
 118         virtual bool isKnownSourceImage(const std::string &name)=0;
 119         virtual video::ITexture* generateTextureFromMesh(
 120                         const TextureFromMeshParams &params)=0;
 121         virtual video::ITexture* getNormalTexture(const std::string &name)=0;
 122         virtual video::SColor getTextureAverageColor(const std::string &name)=0;
 123         virtual video::ITexture *getShaderFlagsTexture(bool normalmap_present)=0;
 124 };
 125
 126 class IWritableTextureSource : public ITextureSource
 127 {
 128 public:
 129         IWritableTextureSource(){}
 130         virtual ~IWritableTextureSource(){}
 131         virtual u32 getTextureId(const std::string &name)=0;
 132         virtual std::string getTextureName(u32 id)=0;
 133         virtual video::ITexture* getTexture(u32 id)=0;
 134         virtual video::ITexture* getTexture(
 135                         const std::string &name, u32 *id = nullptr)=0;
 136         virtual bool isKnownSourceImage(const std::string &name)=0;
 137         virtual video::ITexture* generateTextureFromMesh(
 138                         const TextureFromMeshParams &params)=0;
 139
 140         virtual void processQueue()=0;
 141         virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
 142         virtual void rebuildImagesAndTextures()=0;
 143         virtual video::ITexture* getNormalTexture(const std::string &name)=0;
 144         virtual video::SColor getTextureAverageColor(const std::string &name)=0;
 145         virtual video::ITexture *getShaderFlagsTexture(bool normalmap_present)=0;
 146 };
 147
 148 IWritableTextureSource *createTextureSource();
 149
 150 #ifdef __ANDROID__
 151 video::IImage * Align2Npot2(video::IImage * image, video::IVideoDriver* driver);
 152 #endif
 153
 154 enum MaterialType{
 155         TILE_MATERIAL_BASIC,
 156         TILE_MATERIAL_ALPHA,
 157         TILE_MATERIAL_LIQUID_TRANSPARENT,
 158         TILE_MATERIAL_LIQUID_OPAQUE,
 159         TILE_MATERIAL_WAVING_LEAVES,
 160         TILE_MATERIAL_WAVING_PLANTS,
 161         TILE_MATERIAL_OPAQUE
 162 };
 163
 164 // Material flags
 165 // Should backface culling be enabled?
 166 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
 167 // Should a crack be drawn?
 168 #define MATERIAL_FLAG_CRACK 0x02
 169 // Should the crack be drawn on transparent pixels (unset) or not (set)?
 170 // Ignored if MATERIAL_FLAG_CRACK is not set.
 171 #define MATERIAL_FLAG_CRACK_OVERLAY 0x04
 172 #define MATERIAL_FLAG_ANIMATION 0x08
 173 #define MATERIAL_FLAG_HIGHLIGHTED 0x10
 174 #define MATERIAL_FLAG_TILEABLE_HORIZONTAL 0x20
 175 #define MATERIAL_FLAG_TILEABLE_VERTICAL 0x40
 176
 177 /*
 178         This fully defines the looks of a tile.
 179         The SMaterial of a tile is constructed according to this.
 180 */
 181 struct FrameSpec
 182 {
 183         FrameSpec() {}
 184         u32 texture_id = 0;
 185         video::ITexture *texture = nullptr;
 186         video::ITexture *normal_texture = nullptr;
 187         video::ITexture *flags_texture = nullptr;
 188 };
 189
 190 #define MAX_TILE_LAYERS 2
 191
 192 //! Defines a layer of a tile.
 193 struct TileLayer
 194 {
 195         TileLayer() {}
 196
 197         /*!
 198          * Two layers are equal if they can be merged.
 199          */
 200         bool operator==(const TileLayer &other) const
 201         {
 202                 return
 203                         texture_id == other.texture_id &&
 204                         material_type == other.material_type &&
 205                         material_flags == other.material_flags &&
 206                         color == other.color;
 207         }
 208
 209         /*!
 210          * Two tiles are not equal if they must have different vertices.
 211          */
 212         bool operator!=(const TileLayer &other) const
 213         {
 214                 return !(*this == other);
 215         }
 216
 217         // Sets everything else except the texture in the material
 218         void applyMaterialOptions(video::SMaterial &material) const
 219         {
 220                 switch (material_type) {
 221                 case TILE_MATERIAL_OPAQUE:
 222                 case TILE_MATERIAL_LIQUID_OPAQUE:
 223                         material.MaterialType = video::EMT_SOLID;
 224                         break;
 225                 case TILE_MATERIAL_BASIC:
 226                 case TILE_MATERIAL_WAVING_LEAVES:
 227                 case TILE_MATERIAL_WAVING_PLANTS:
 228                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
 229                         break;
 230                 case TILE_MATERIAL_ALPHA:
 231                 case TILE_MATERIAL_LIQUID_TRANSPARENT:
 232                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 233                         break;
 234                 }
 235                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING)
 236                         ? true : false;
 237                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)) {
 238                         material.TextureLayer[0].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
 239                 }
 240                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL)) {
 241                         material.TextureLayer[0].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
 242                 }
 243         }
 244
 245         void applyMaterialOptionsWithShaders(video::SMaterial &material) const
 246         {
 247                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING)
 248                         ? true : false;
 249                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)) {
 250                         material.TextureLayer[0].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
 251                         material.TextureLayer[1].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
 252                 }
 253                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL)) {
 254                         material.TextureLayer[0].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
 255                         material.TextureLayer[1].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
 256                 }
 257         }
 258
 259         bool isTileable() const
 260         {
 261                 return (material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)
 262                         && (material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL);
 263         }
 264
 265         // Ordered for size, please do not reorder
 266
 267         video::ITexture *texture = nullptr;
 268         video::ITexture *normal_texture = nullptr;
 269         video::ITexture *flags_texture = nullptr;
 270
 271         u32 shader_id = 0;
 272
 273         u32 texture_id = 0;
 274
 275         u16 animation_frame_length_ms = 0;
 276         u8 animation_frame_count = 1;
 277
 278         u8 material_type = TILE_MATERIAL_BASIC;
 279         u8 material_flags =
 280                 //0 // <- DEBUG, Use the one below
 281                 MATERIAL_FLAG_BACKFACE_CULLING |
 282                 MATERIAL_FLAG_TILEABLE_HORIZONTAL|
 283                 MATERIAL_FLAG_TILEABLE_VERTICAL;
 284
 285         //! If true, the tile has its own color.
 286         bool has_color = false;
 287
 288         std::shared_ptr<std::vector<FrameSpec>> frames = nullptr;
 289
 290         /*!
 291          * The color of the tile, or if the tile does not own
 292          * a color then the color of the node owning this tile.
 293          */
 294         video::SColor color;
 295 };
 296
 297 /*!
 298  * Defines a face of a node. May have up to two layers.
 299  */
 300 struct TileSpec
 301 {
 302         TileSpec() {
 303                 for (int layer = 0; layer < MAX_TILE_LAYERS; layer++)
 304                         layers[layer] = TileLayer();
 305         }
 306
 307         /*!
 308          * Returns true if this tile can be merged with the other tile.
 309          */
 310         bool isTileable(const TileSpec &other) const {
 311                 for (int layer = 0; layer < MAX_TILE_LAYERS; layer++) {
 312                         if (layers[layer] != other.layers[layer])
 313                                 return false;
 314                         if (!layers[layer].isTileable())
 315                                 return false;
 316                 }
 317                 return rotation == 0
 318                         && rotation == other.rotation
 319                         && emissive_light == other.emissive_light;
 320         }
 321
 322         u8 rotation = 0;
 323         //! This much light does the tile emit.
 324         u8 emissive_light = 0;
 325         //! The first is base texture, the second is overlay.
 326         TileLayer layers[MAX_TILE_LAYERS];
 327 };
 328 #endif