3 Copyright (C) 2010-2011 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 Gets the path to a texture by first checking if the texture exists
39 in texture_path and if not, using the data path.
41 Checks all supported extensions by replacing the original extension.
43 If not found, returns "".
45 Utilizes a thread-safe cache.
47 std::string getTexturePath(const std::string &filename);
50 Specifies a texture in an atlas.
52 This is used to specify single textures also.
54 This has been designed to be small enough to be thrown around a lot.
59 video::ITexture *atlas; // Atlas in where the texture is
60 v2f pos; // Position in atlas
61 v2f size; // Size in atlas
62 u16 tiled; // X-wise tiling count. If 0, width of atlas is width of image.
74 video::ITexture *atlas_=NULL,
87 bool operator==(const AtlasPointer &other) const
94 atlas == other.atlas &&
101 bool operator!=(const AtlasPointer &other) const
103 return !(*this == other);
106 float x0(){ return pos.X; }
107 float x1(){ return pos.X + size.X; }
108 float y0(){ return pos.Y; }
109 float y1(){ return pos.Y + size.Y; }
113 TextureSource creates and caches textures.
120 virtual ~ITextureSource(){}
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)
129 virtual AtlasPointer getTextureRawAP(const AtlasPointer &ap)
130 {return AtlasPointer(0);}
131 virtual IrrlichtDevice* getDevice()
133 virtual void updateAP(AtlasPointer &ap){};
136 class IWritableTextureSource : public ITextureSource
139 IWritableTextureSource(){}
140 virtual ~IWritableTextureSource(){}
141 virtual u32 getTextureId(const std::string &name){return 0;}
142 virtual u32 getTextureIdDirect(const std::string &name){return 0;}
143 virtual std::string getTextureName(u32 id){return "";}
144 virtual AtlasPointer getTexture(u32 id){return AtlasPointer(0);}
145 virtual AtlasPointer getTexture(const std::string &name)
146 {return AtlasPointer(0);}
147 virtual video::ITexture* getTextureRaw(const std::string &name)
149 virtual IrrlichtDevice* getDevice()
151 virtual void updateAP(AtlasPointer &ap){};
153 virtual void processQueue()=0;
154 virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
155 virtual void rebuildImagesAndTextures()=0;
156 virtual void buildMainAtlas(class IGameDef *gamedef)=0;
159 IWritableTextureSource* createTextureSource(IrrlichtDevice *device);
163 MATERIAL_ALPHA_VERTEX,
164 MATERIAL_ALPHA_SIMPLE, // >127 = opaque
165 MATERIAL_ALPHA_BLEND,
169 // Should backface culling be enabled?
170 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
171 // Should a crack be drawn?
172 #define MATERIAL_FLAG_CRACK 0x02
173 // Should the crack be drawn on transparent pixels (unset) or not (set)?
174 // Ignored if MATERIAL_FLAG_CRACK is not set.
175 #define MATERIAL_FLAG_CRACK_OVERLAY 0x04
176 // Animation made up by splitting the texture to vertical frames, as
177 // defined by extra parameters
178 #define MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES 0x08
181 This fully defines the looks of a tile.
182 The SMaterial of a tile is constructed according to this.
189 //material_type(MATERIAL_ALPHA_NONE),
190 // Use this so that leaves don't need a separate material
191 material_type(MATERIAL_ALPHA_SIMPLE),
193 //0 // <- DEBUG, Use the one below
194 MATERIAL_FLAG_BACKFACE_CULLING
196 animation_frame_count(1),
197 animation_frame_length_ms(0)
201 bool operator==(const TileSpec &other) const
204 texture == other.texture &&
205 alpha == other.alpha &&
206 material_type == other.material_type &&
207 material_flags == other.material_flags
211 bool operator!=(const TileSpec &other) const
213 return !(*this == other);
216 // Sets everything else except the texture in the material
217 void applyMaterialOptions(video::SMaterial &material) const
219 if(material_type == MATERIAL_ALPHA_NONE)
220 material.MaterialType = video::EMT_SOLID;
221 else if(material_type == MATERIAL_ALPHA_VERTEX)
222 material.MaterialType = video::EMT_TRANSPARENT_VERTEX_ALPHA;
223 else if(material_type == MATERIAL_ALPHA_SIMPLE)
224 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
225 else if(material_type == MATERIAL_ALPHA_BLEND)
226 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
228 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) ? true : false;
231 // NOTE: Deprecated, i guess?
232 void setTexturePos(u8 tx_, u8 ty_, u8 tw_, u8 th_)
234 texture.pos = v2f((float)tx_/256.0, (float)ty_/256.0);
235 texture.size = v2f(((float)tw_ + 1.0)/256.0, ((float)th_ + 1.0)/256.0);
238 AtlasPointer texture;
239 // Vertex alpha (when MATERIAL_ALPHA_VERTEX is used)
241 // Material parameters
244 // Animation parameters
245 u8 animation_frame_count;
246 u16 animation_frame_length_ms;