src/tile.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 "common_irrlicht.h"
  24 #include "threads.h"
  25 #include "utility.h"
  26 #include <string>
  27
  28 class IGameDef;
  29
  30 /*
  31         tile.{h,cpp}: Texture handling stuff.
  32 */
  33
  34 /*
  35         Gets the path to a texture by first checking if the texture exists
  36         in texture_path and if not, using the data path.
  37
  38         Checks all supported extensions by replacing the original extension.
  39
  40         If not found, returns "".
  41
  42         Utilizes a thread-safe cache.
  43 */
  44 std::string getTexturePath(const std::string &filename);
  45
  46 /*
  47         Specifies a texture in an atlas.
  48
  49         This is used to specify single textures also.
  50
  51         This has been designed to be small enough to be thrown around a lot.
  52 */
  53 struct AtlasPointer
  54 {
  55         u32 id; // Texture id
  56         video::ITexture *atlas; // Atlas in where the texture is
  57         v2f pos; // Position in atlas
  58         v2f size; // Size in atlas
  59         u16 tiled; // X-wise tiling count. If 0, width of atlas is width of image.
  60
  61         AtlasPointer(
  62                         u16 id_,
  63                         video::ITexture *atlas_=NULL,
  64                         v2f pos_=v2f(0,0),
  65                         v2f size_=v2f(1,1),
  66                         u16 tiled_=1
  67                 ):
  68                 id(id_),
  69                 atlas(atlas_),
  70                 pos(pos_),
  71                 size(size_),
  72                 tiled(tiled_)
  73         {
  74         }
  75
  76         bool operator==(const AtlasPointer &other)
  77         {
  78                 return (
  79                         id == other.id
  80                 );
  81                 /*return (
  82                         id == other.id &&
  83                         atlas == other.atlas &&
  84                         pos == other.pos &&
  85                         size == other.size &&
  86                         tiled == other.tiled
  87                 );*/
  88         }
  89
  90         float x0(){ return pos.X; }
  91         float x1(){ return pos.X + size.X; }
  92         float y0(){ return pos.Y; }
  93         float y1(){ return pos.Y + size.Y; }
  94 };
  95
  96 /*
  97         TextureSource creates and caches textures.
  98 */
  99
 100 class ITextureSource
 101 {
 102 public:
 103         ITextureSource(){}
 104         virtual ~ITextureSource(){}
 105         virtual u32 getTextureId(const std::string &name){return 0;}
 106         virtual u32 getTextureIdDirect(const std::string &name){return 0;}
 107         virtual std::string getTextureName(u32 id){return "";}
 108         virtual AtlasPointer getTexture(u32 id){return AtlasPointer(0);}
 109         virtual AtlasPointer getTexture(const std::string &name)
 110                 {return AtlasPointer(0);}
 111         virtual video::ITexture* getTextureRaw(const std::string &name)
 112                 {return NULL;}
 113         virtual void updateAP(AtlasPointer &ap){};
 114 };
 115
 116 class IWritableTextureSource : public ITextureSource
 117 {
 118 public:
 119         IWritableTextureSource(){}
 120         virtual ~IWritableTextureSource(){}
 121         virtual u32 getTextureId(const std::string &name){return 0;}
 122         virtual u32 getTextureIdDirect(const std::string &name){return 0;}
 123         virtual std::string getTextureName(u32 id){return "";}
 124         virtual AtlasPointer getTexture(u32 id){return AtlasPointer(0);}
 125         virtual AtlasPointer getTexture(const std::string &name)
 126                 {return AtlasPointer(0);}
 127         virtual video::ITexture* getTextureRaw(const std::string &name)
 128                 {return NULL;}
 129         virtual void updateAP(AtlasPointer &ap){};
 130
 131         virtual void processQueue()=0;
 132         virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
 133         virtual void rebuildImagesAndTextures()=0;
 134         virtual void buildMainAtlas(class IGameDef *gamedef)=0;
 135 };
 136
 137 IWritableTextureSource* createTextureSource(IrrlichtDevice *device);
 138
 139 enum MaterialType{
 140         MATERIAL_ALPHA_NONE,
 141         MATERIAL_ALPHA_VERTEX,
 142         MATERIAL_ALPHA_SIMPLE, // >127 = opaque
 143         MATERIAL_ALPHA_BLEND,
 144 };
 145
 146 // Material flags
 147 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
 148
 149 /*
 150         This fully defines the looks of a tile.
 151         The SMaterial of a tile is constructed according to this.
 152 */
 153 struct TileSpec
 154 {
 155         TileSpec():
 156                 texture(0),
 157                 alpha(255),
 158                 //material_type(MATERIAL_ALPHA_NONE),
 159                 // Use this so that leaves don't need a separate material
 160                 material_type(MATERIAL_ALPHA_SIMPLE),
 161                 material_flags(
 162                         //0 // <- DEBUG, Use the one below
 163                         MATERIAL_FLAG_BACKFACE_CULLING
 164                 )
 165         {
 166         }
 167
 168         bool operator==(TileSpec &other)
 169         {
 170                 return (
 171                         texture == other.texture &&
 172                         alpha == other.alpha &&
 173                         material_type == other.material_type &&
 174                         material_flags == other.material_flags
 175                 );
 176         }
 177
 178         // Sets everything else except the texture in the material
 179         void applyMaterialOptions(video::SMaterial &material) const
 180         {
 181                 if(alpha != 255 && material_type != MATERIAL_ALPHA_VERTEX)
 182                         dstream<<"WARNING: TileSpec: alpha != 255 "
 183                                         "but not MATERIAL_ALPHA_VERTEX"
 184                                         <<std::endl;
 185
 186                 if(material_type == MATERIAL_ALPHA_NONE)
 187                         material.MaterialType = video::EMT_SOLID;
 188                 else if(material_type == MATERIAL_ALPHA_VERTEX)
 189                         material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
 190                 else if(material_type == MATERIAL_ALPHA_SIMPLE)
 191                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
 192                 else if(material_type == MATERIAL_ALPHA_BLEND)
 193                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 194
 195                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
 196         }
 197
 198         // NOTE: Deprecated, i guess?
 199         void setTexturePos(u8 tx_, u8 ty_, u8 tw_, u8 th_)
 200         {
 201                 texture.pos = v2f((float)tx_/256.0, (float)ty_/256.0);
 202                 texture.size = v2f(((float)tw_ + 1.0)/256.0, ((float)th_ + 1.0)/256.0);
 203         }
 204
 205         AtlasPointer texture;
 206         // Vertex alpha
 207         u8 alpha;
 208         // Material type
 209         u8 material_type;
 210         // Material flags
 211         u8 material_flags;
 212 };
 213
 214 #endif