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 <IrrlichtDevice.h>
  27 #include "threads.h"
  28 #include <string>
  29 #include <vector>
  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;
  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 = NULL) = 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 = NULL)=0;
 109         virtual video::ITexture* getTextureForMesh(
 110                         const std::string &name, u32 *id = NULL) = 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 IrrlichtDevice* getDevice()=0;
 119         virtual bool isKnownSourceImage(const std::string &name)=0;
 120         virtual video::ITexture* generateTextureFromMesh(
 121                         const TextureFromMeshParams &params)=0;
 122         virtual video::ITexture* getNormalTexture(const std::string &name)=0;
 123         virtual video::SColor getTextureAverageColor(const std::string &name)=0;
 124         virtual video::ITexture *getShaderFlagsTexture(bool normalmap_present)=0;
 125 };
 126
 127 class IWritableTextureSource : public ITextureSource
 128 {
 129 public:
 130         IWritableTextureSource(){}
 131         virtual ~IWritableTextureSource(){}
 132         virtual u32 getTextureId(const std::string &name)=0;
 133         virtual std::string getTextureName(u32 id)=0;
 134         virtual video::ITexture* getTexture(u32 id)=0;
 135         virtual video::ITexture* getTexture(
 136                         const std::string &name, u32 *id = NULL)=0;
 137         virtual IrrlichtDevice* getDevice()=0;
 138         virtual bool isKnownSourceImage(const std::string &name)=0;
 139         virtual video::ITexture* generateTextureFromMesh(
 140                         const TextureFromMeshParams &params)=0;
 141
 142         virtual void processQueue()=0;
 143         virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
 144         virtual void rebuildImagesAndTextures()=0;
 145         virtual video::ITexture* getNormalTexture(const std::string &name)=0;
 146         virtual video::SColor getTextureAverageColor(const std::string &name)=0;
 147         virtual video::ITexture *getShaderFlagsTexture(bool normalmap_present)=0;
 148 };
 149
 150 IWritableTextureSource* createTextureSource(IrrlichtDevice *device);
 151
 152 #ifdef __ANDROID__
 153 video::IImage * Align2Npot2(video::IImage * image, video::IVideoDriver* driver);
 154 #endif
 155
 156 enum MaterialType{
 157         TILE_MATERIAL_BASIC,
 158         TILE_MATERIAL_ALPHA,
 159         TILE_MATERIAL_LIQUID_TRANSPARENT,
 160         TILE_MATERIAL_LIQUID_OPAQUE,
 161         TILE_MATERIAL_WAVING_LEAVES,
 162         TILE_MATERIAL_WAVING_PLANTS
 163 };
 164
 165 // Material flags
 166 // Should backface culling be enabled?
 167 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
 168 // Should a crack be drawn?
 169 #define MATERIAL_FLAG_CRACK 0x02
 170 // Should the crack be drawn on transparent pixels (unset) or not (set)?
 171 // Ignored if MATERIAL_FLAG_CRACK is not set.
 172 #define MATERIAL_FLAG_CRACK_OVERLAY 0x04
 173 #define MATERIAL_FLAG_ANIMATION 0x08
 174 #define MATERIAL_FLAG_HIGHLIGHTED 0x10
 175 #define MATERIAL_FLAG_TILEABLE_HORIZONTAL 0x20
 176 #define MATERIAL_FLAG_TILEABLE_VERTICAL 0x40
 177
 178 /*
 179         This fully defines the looks of a tile.
 180         The SMaterial of a tile is constructed according to this.
 181 */
 182 struct FrameSpec
 183 {
 184         FrameSpec():
 185                 texture_id(0),
 186                 texture(NULL),
 187                 normal_texture(NULL),
 188                 flags_texture(NULL)
 189         {
 190         }
 191         u32 texture_id;
 192         video::ITexture *texture;
 193         video::ITexture *normal_texture;
 194         video::ITexture *flags_texture;
 195 };
 196
 197 #define MAX_TILE_LAYERS 2
 198
 199 //! Defines a layer of a tile.
 200 struct TileLayer
 201 {
 202         TileLayer():
 203                 texture(NULL),
 204                 texture_id(0),
 205                 color(),
 206                 material_type(TILE_MATERIAL_BASIC),
 207                 material_flags(
 208                         //0 // <- DEBUG, Use the one below
 209                         MATERIAL_FLAG_BACKFACE_CULLING |
 210                         MATERIAL_FLAG_TILEABLE_HORIZONTAL|
 211                         MATERIAL_FLAG_TILEABLE_VERTICAL
 212                 ),
 213                 shader_id(0),
 214                 normal_texture(NULL),
 215                 flags_texture(NULL),
 216                 animation_frame_length_ms(0),
 217                 animation_frame_count(1),
 218                 has_color(false)
 219         {
 220         }
 221
 222         /*!
 223          * Two layers are equal if they can be merged.
 224          */
 225         bool operator==(const TileLayer &other) const
 226         {
 227                 return
 228                         texture_id == other.texture_id &&
 229                         material_type == other.material_type &&
 230                         material_flags == other.material_flags &&
 231                         color == other.color;
 232         }
 233
 234         /*!
 235          * Two tiles are not equal if they must have different vertices.
 236          */
 237         bool operator!=(const TileLayer &other) const
 238         {
 239                 return !(*this == other);
 240         }
 241
 242         // Sets everything else except the texture in the material
 243         void applyMaterialOptions(video::SMaterial &material) const
 244         {
 245                 switch (material_type) {
 246                 case TILE_MATERIAL_BASIC:
 247                 case TILE_MATERIAL_WAVING_LEAVES:
 248                 case TILE_MATERIAL_WAVING_PLANTS:
 249                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
 250                         break;
 251                 case TILE_MATERIAL_ALPHA:
 252                 case TILE_MATERIAL_LIQUID_TRANSPARENT:
 253                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 254                         break;
 255                 case TILE_MATERIAL_LIQUID_OPAQUE:
 256                         material.MaterialType = video::EMT_SOLID;
 257                         break;
 258                 }
 259                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING)
 260                         ? true : false;
 261                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)) {
 262                         material.TextureLayer[0].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
 263                 }
 264                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL)) {
 265                         material.TextureLayer[0].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
 266                 }
 267         }
 268
 269         void applyMaterialOptionsWithShaders(video::SMaterial &material) const
 270         {
 271                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING)
 272                         ? true : false;
 273                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)) {
 274                         material.TextureLayer[0].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
 275                         material.TextureLayer[1].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
 276                 }
 277                 if (!(material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL)) {
 278                         material.TextureLayer[0].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
 279                         material.TextureLayer[1].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
 280                 }
 281         }
 282
 283         bool isTileable() const
 284         {
 285                 return (material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)
 286                         && (material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL);
 287         }
 288
 289         video::ITexture *texture;
 290         u32 texture_id;
 291         /*!
 292          * The color of the tile, or if the tile does not own
 293          * a color then the color of the node owning this tile.
 294          */
 295         video::SColor color;
 296         // Material parameters
 297         u8 material_type;
 298         u8 material_flags;
 299         u32 shader_id;
 300         video::ITexture *normal_texture;
 301         video::ITexture *flags_texture;
 302
 303         // Animation parameters
 304         u16 animation_frame_length_ms;
 305         u8 animation_frame_count;
 306         //! If true, the tile has its own color.
 307         bool has_color;
 308
 309         std::vector<FrameSpec> frames;
 310 };
 311
 312 /*!
 313  * Defines a face of a node. May have up to two layers.
 314  */
 315 struct TileSpec
 316 {
 317         TileSpec():
 318                 rotation(0),
 319                 emissive_light(0)
 320         {
 321                 for (int layer = 0; layer < MAX_TILE_LAYERS; layer++)
 322                         layers[layer] = TileLayer();
 323         }
 324
 325         /*!
 326          * Returns true if this tile can be merged with the other tile.
 327          */
 328         bool isTileable(const TileSpec &other) const {
 329                 for (int layer = 0; layer < MAX_TILE_LAYERS; layer++) {
 330                         if (layers[layer] != other.layers[layer])
 331                                 return false;
 332                         if (!layers[layer].isTileable())
 333                                 return false;
 334                 }
 335                 return rotation == 0
 336                         && rotation == other.rotation
 337                         && emissive_light == other.emissive_light;
 338         }
 339
 340         u8 rotation;
 341         //! This much light does the tile emit.
 342         u8 emissive_light;
 343         //! The first is base texture, the second is overlay.
 344         TileLayer layers[MAX_TILE_LAYERS];
 345 };
 346 #endif