src/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_v2d.h"
  25 #include "irr_v3d.h"
  26 #include <ITexture.h>
  27 #include <IrrlichtDevice.h>
  28 #include "threads.h"
  29 #include <string>
  30
  31 class IGameDef;
  32
  33 /*
  34         tile.{h,cpp}: Texture handling stuff.
  35 */
  36
  37 /*
  38         Find out the full path of an image by trying different filename
  39         extensions.
  40
  41         If failed, return "".
  42
  43         TODO: Should probably be moved out from here, because things needing
  44               this function do not need anything else from this header
  45 */
  46 std::string getImagePath(std::string path);
  47
  48 /*
  49         Gets the path to a texture by first checking if the texture exists
  50         in texture_path and if not, using the data path.
  51
  52         Checks all supported extensions by replacing the original extension.
  53
  54         If not found, returns "".
  55
  56         Utilizes a thread-safe cache.
  57 */
  58 std::string getTexturePath(const std::string &filename);
  59
  60 void clearTextureNameCache();
  61
  62 /*
  63         ITextureSource::generateTextureFromMesh parameters
  64 */
  65 namespace irr {namespace scene {class IMesh;}}
  66 struct TextureFromMeshParams
  67 {
  68         scene::IMesh *mesh;
  69         core::dimension2d<u32> dim;
  70         std::string rtt_texture_name;
  71         bool delete_texture_on_shutdown;
  72         v3f camera_position;
  73         v3f camera_lookat;
  74         core::CMatrix4<f32> camera_projection_matrix;
  75         video::SColorf ambient_light;
  76         v3f light_position;
  77         video::SColorf light_color;
  78         f32 light_radius;
  79 };
  80
  81 /*
  82         TextureSource creates and caches textures.
  83 */
  84
  85 class ITextureSource
  86 {
  87 public:
  88         ITextureSource(){}
  89         virtual ~ITextureSource(){}
  90         virtual u32 getTextureId(const std::string &name){return 0;}
  91         virtual u32 getTextureIdDirect(const std::string &name){return 0;}
  92         virtual std::string getTextureName(u32 id){return "";}
  93         virtual video::ITexture* getTexture(u32 id){return NULL;}
  94         virtual video::ITexture* getTexture(
  95                         const std::string &name, u32 *id = NULL){
  96                 if(id) *id = 0;
  97                 return NULL;
  98         }
  99         virtual IrrlichtDevice* getDevice()
 100                 {return NULL;}
 101         virtual bool isKnownSourceImage(const std::string &name)=0;
 102         virtual video::ITexture* generateTextureFromMesh(
 103                         const TextureFromMeshParams &params)=0;
 104 };
 105
 106 class IWritableTextureSource : public ITextureSource
 107 {
 108 public:
 109         IWritableTextureSource(){}
 110         virtual ~IWritableTextureSource(){}
 111         virtual u32 getTextureId(const std::string &name){return 0;}
 112         virtual u32 getTextureIdDirect(const std::string &name){return 0;}
 113         virtual std::string getTextureName(u32 id){return "";}
 114         virtual video::ITexture* getTexture(u32 id){return NULL;}
 115         virtual video::ITexture* getTexture(
 116                         const std::string &name, u32 *id = NULL){
 117                 if(id) *id = 0;
 118                 return NULL;
 119         }
 120         virtual IrrlichtDevice* getDevice(){return NULL;}
 121         virtual bool isKnownSourceImage(const std::string &name)=0;
 122
 123         virtual void processQueue()=0;
 124         virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
 125         virtual void rebuildImagesAndTextures()=0;
 126         virtual video::ITexture* generateTextureFromMesh(
 127                         const TextureFromMeshParams &params)=0;
 128 };
 129
 130 IWritableTextureSource* createTextureSource(IrrlichtDevice *device);
 131
 132 enum MaterialType{
 133         TILE_MATERIAL_BASIC,
 134         TILE_MATERIAL_ALPHA,
 135         TILE_MATERIAL_LIQUID_TRANSPARENT,
 136         TILE_MATERIAL_LIQUID_OPAQUE,
 137 };
 138
 139 // Material flags
 140 // Should backface culling be enabled?
 141 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
 142 // Should a crack be drawn?
 143 #define MATERIAL_FLAG_CRACK 0x02
 144 // Should the crack be drawn on transparent pixels (unset) or not (set)?
 145 // Ignored if MATERIAL_FLAG_CRACK is not set.
 146 #define MATERIAL_FLAG_CRACK_OVERLAY 0x04
 147 // Animation made up by splitting the texture to vertical frames, as
 148 // defined by extra parameters
 149 #define MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES 0x08
 150
 151 /*
 152         This fully defines the looks of a tile.
 153         The SMaterial of a tile is constructed according to this.
 154 */
 155 struct TileSpec
 156 {
 157         TileSpec():
 158                 texture_id(0),
 159                 texture(NULL),
 160                 alpha(255),
 161                 material_type(TILE_MATERIAL_BASIC),
 162                 material_flags(
 163                         //0 // <- DEBUG, Use the one below
 164                         MATERIAL_FLAG_BACKFACE_CULLING
 165                 ),
 166                 animation_frame_count(1),
 167                 animation_frame_length_ms(0),
 168                 rotation(0)
 169         {
 170         }
 171
 172         bool operator==(const TileSpec &other) const
 173         {
 174                 return (
 175                         texture_id == other.texture_id &&
 176                         /* texture == other.texture && */
 177                         alpha == other.alpha &&
 178                         material_type == other.material_type &&
 179                         material_flags == other.material_flags &&
 180                         rotation == other.rotation
 181                 );
 182         }
 183
 184         bool operator!=(const TileSpec &other) const
 185         {
 186                 return !(*this == other);
 187         }
 188
 189         // Sets everything else except the texture in the material
 190         void applyMaterialOptions(video::SMaterial &material) const
 191         {
 192                 switch(material_type){
 193                 case TILE_MATERIAL_BASIC:
 194                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
 195                         break;
 196                 case TILE_MATERIAL_ALPHA:
 197                         material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
 198                         break;
 199                 case TILE_MATERIAL_LIQUID_TRANSPARENT:
 200                         material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
 201                         break;
 202                 case TILE_MATERIAL_LIQUID_OPAQUE:
 203                         material.MaterialType = video::EMT_SOLID;
 204                         break;
 205                 }
 206                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
 207         }
 208         void applyMaterialOptionsWithShaders(video::SMaterial &material,
 209                         const video::E_MATERIAL_TYPE &basic,
 210                         const video::E_MATERIAL_TYPE &liquid,
 211                         const video::E_MATERIAL_TYPE &alpha) const
 212         {
 213                 switch(material_type){
 214                 case TILE_MATERIAL_BASIC:
 215                         material.MaterialType = basic;
 216                         break;
 217                 case TILE_MATERIAL_ALPHA:
 218                         material.MaterialType = alpha;
 219                         break;
 220                 case TILE_MATERIAL_LIQUID_TRANSPARENT:
 221                         material.MaterialType = liquid;
 222                         break;
 223                 case TILE_MATERIAL_LIQUID_OPAQUE:
 224                         material.MaterialType = liquid;
 225                         break;
 226                 }
 227                 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
 228         }
 229
 230         u32 texture_id;
 231         video::ITexture *texture;
 232         // Vertex alpha (when MATERIAL_ALPHA_VERTEX is used)
 233         u8 alpha;
 234         // Material parameters
 235         u8 material_type;
 236         u8 material_flags;
 237         // Animation parameters
 238         u8 animation_frame_count;
 239         u16 animation_frame_length_ms;
 240         u8 rotation;
 241 };
 242
 243 #endif