3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
23 #include "irrlichttypes.h"
27 #include <IrrlichtDevice.h>
34 tile.{h,cpp}: Texture handling stuff.
38 Find out the full path of an image by trying different filename
43 TODO: Should probably be moved out from here, because things needing
44 this function do not need anything else from this header
46 std::string getImagePath(std::string path);
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.
52 Checks all supported extensions by replacing the original extension.
54 If not found, returns "".
56 Utilizes a thread-safe cache.
58 std::string getTexturePath(const std::string &filename);
60 void clearTextureNameCache();
63 ITextureSource::generateTextureFromMesh parameters
65 namespace irr {namespace scene {class IMesh;}}
66 struct TextureFromMeshParams
69 core::dimension2d<u32> dim;
70 std::string rtt_texture_name;
71 bool delete_texture_on_shutdown;
74 core::CMatrix4<f32> camera_projection_matrix;
75 video::SColorf ambient_light;
77 video::SColorf light_color;
82 TextureSource creates and caches textures.
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){
99 virtual IrrlichtDevice* getDevice()
101 virtual bool isKnownSourceImage(const std::string &name)=0;
102 virtual video::ITexture* generateTextureFromMesh(
103 const TextureFromMeshParams ¶ms)=0;
106 class IWritableTextureSource : public ITextureSource
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){
120 virtual IrrlichtDevice* getDevice(){return NULL;}
121 virtual bool isKnownSourceImage(const std::string &name)=0;
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 ¶ms)=0;
130 IWritableTextureSource* createTextureSource(IrrlichtDevice *device);
135 TILE_MATERIAL_LIQUID_TRANSPARENT,
136 TILE_MATERIAL_LIQUID_OPAQUE,
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
152 This fully defines the looks of a tile.
153 The SMaterial of a tile is constructed according to this.
161 material_type(TILE_MATERIAL_BASIC),
163 //0 // <- DEBUG, Use the one below
164 MATERIAL_FLAG_BACKFACE_CULLING
166 animation_frame_count(1),
167 animation_frame_length_ms(0),
172 bool operator==(const TileSpec &other) const
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
184 bool operator!=(const TileSpec &other) const
186 return !(*this == other);
189 // Sets everything else except the texture in the material
190 void applyMaterialOptions(video::SMaterial &material) const
192 switch(material_type){
193 case TILE_MATERIAL_BASIC:
194 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
196 case TILE_MATERIAL_ALPHA:
197 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
199 case TILE_MATERIAL_LIQUID_TRANSPARENT:
200 material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
202 case TILE_MATERIAL_LIQUID_OPAQUE:
203 material.MaterialType = video::EMT_SOLID;
206 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
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
213 switch(material_type){
214 case TILE_MATERIAL_BASIC:
215 material.MaterialType = basic;
217 case TILE_MATERIAL_ALPHA:
218 material.MaterialType = alpha;
220 case TILE_MATERIAL_LIQUID_TRANSPARENT:
221 material.MaterialType = liquid;
223 case TILE_MATERIAL_LIQUID_OPAQUE:
224 material.MaterialType = liquid;
227 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
231 video::ITexture *texture;
232 // Vertex alpha (when MATERIAL_ALPHA_VERTEX is used)
234 // Material parameters
237 // Animation parameters
238 u8 animation_frame_count;
239 u16 animation_frame_length_ms;