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.
22 #include "irrlichttypes.h"
27 #include <SMaterial.h>
29 #include "util/numeric.h"
33 #include <IVideoDriver.h>
40 typedef std::vector<video::SColor> Palette;
43 tile.{h,cpp}: Texture handling stuff.
47 Find out the full path of an image by trying different filename
52 TODO: Should probably be moved out from here, because things needing
53 this function do not need anything else from this header
55 std::string getImagePath(std::string path);
58 Gets the path to a texture by first checking if the texture exists
59 in texture_path and if not, using the data path.
61 Checks all supported extensions by replacing the original extension.
63 If not found, returns "".
65 Utilizes a thread-safe cache.
67 std::string getTexturePath(const std::string &filename, bool *is_base_pack = nullptr);
69 void clearTextureNameCache();
72 TextureSource creates and caches textures.
75 class ISimpleTextureSource
78 ISimpleTextureSource() = default;
80 virtual ~ISimpleTextureSource() = default;
82 virtual video::ITexture* getTexture(
83 const std::string &name, u32 *id = nullptr) = 0;
86 class ITextureSource : public ISimpleTextureSource
89 ITextureSource() = default;
91 virtual ~ITextureSource() = default;
93 virtual u32 getTextureId(const std::string &name)=0;
94 virtual std::string getTextureName(u32 id)=0;
95 virtual video::ITexture* getTexture(u32 id)=0;
96 virtual video::ITexture* getTexture(
97 const std::string &name, u32 *id = nullptr)=0;
98 virtual video::ITexture* getTextureForMesh(
99 const std::string &name, u32 *id = nullptr) = 0;
101 * Returns a palette from the given texture name.
102 * The pointer is valid until the texture source is
104 * Should be called from the main thread.
106 virtual Palette* getPalette(const std::string &name) = 0;
107 virtual bool isKnownSourceImage(const std::string &name)=0;
108 virtual video::ITexture* getNormalTexture(const std::string &name)=0;
109 virtual video::SColor getTextureAverageColor(const std::string &name)=0;
110 virtual video::ITexture *getShaderFlagsTexture(bool normalmap_present)=0;
113 class IWritableTextureSource : public ITextureSource
116 IWritableTextureSource() = default;
118 virtual ~IWritableTextureSource() = default;
120 virtual u32 getTextureId(const std::string &name)=0;
121 virtual std::string getTextureName(u32 id)=0;
122 virtual video::ITexture* getTexture(u32 id)=0;
123 virtual video::ITexture* getTexture(
124 const std::string &name, u32 *id = nullptr)=0;
125 virtual bool isKnownSourceImage(const std::string &name)=0;
127 virtual void processQueue()=0;
128 virtual void insertSourceImage(const std::string &name, video::IImage *img)=0;
129 virtual void rebuildImagesAndTextures()=0;
130 virtual video::ITexture* getNormalTexture(const std::string &name)=0;
131 virtual video::SColor getTextureAverageColor(const std::string &name)=0;
132 virtual video::ITexture *getShaderFlagsTexture(bool normalmap_present)=0;
135 IWritableTextureSource *createTextureSource();
138 bool hasNPotSupport();
139 video::IImage * Align2Npot2(video::IImage * image, irr::video::IVideoDriver* driver);
145 TILE_MATERIAL_LIQUID_TRANSPARENT,
146 TILE_MATERIAL_LIQUID_OPAQUE,
147 TILE_MATERIAL_WAVING_LEAVES,
148 TILE_MATERIAL_WAVING_PLANTS,
149 TILE_MATERIAL_OPAQUE,
150 TILE_MATERIAL_WAVING_LIQUID_BASIC,
151 TILE_MATERIAL_WAVING_LIQUID_TRANSPARENT,
152 TILE_MATERIAL_WAVING_LIQUID_OPAQUE,
154 TILE_MATERIAL_PLAIN_ALPHA
158 // Should backface culling be enabled?
159 #define MATERIAL_FLAG_BACKFACE_CULLING 0x01
160 // Should a crack be drawn?
161 #define MATERIAL_FLAG_CRACK 0x02
162 // Should the crack be drawn on transparent pixels (unset) or not (set)?
163 // Ignored if MATERIAL_FLAG_CRACK is not set.
164 #define MATERIAL_FLAG_CRACK_OVERLAY 0x04
165 #define MATERIAL_FLAG_ANIMATION 0x08
166 //#define MATERIAL_FLAG_HIGHLIGHTED 0x10
167 #define MATERIAL_FLAG_TILEABLE_HORIZONTAL 0x20
168 #define MATERIAL_FLAG_TILEABLE_VERTICAL 0x40
171 This fully defines the looks of a tile.
172 The SMaterial of a tile is constructed according to this.
176 FrameSpec() = default;
179 video::ITexture *texture = nullptr;
180 video::ITexture *normal_texture = nullptr;
181 video::ITexture *flags_texture = nullptr;
184 #define MAX_TILE_LAYERS 2
186 //! Defines a layer of a tile.
189 TileLayer() = default;
192 * Two layers are equal if they can be merged.
194 bool operator==(const TileLayer &other) const
197 texture_id == other.texture_id &&
198 material_type == other.material_type &&
199 material_flags == other.material_flags &&
200 color == other.color &&
201 scale == other.scale;
205 * Two tiles are not equal if they must have different vertices.
207 bool operator!=(const TileLayer &other) const
209 return !(*this == other);
212 // Sets everything else except the texture in the material
213 void applyMaterialOptions(video::SMaterial &material) const
215 switch (material_type) {
216 case TILE_MATERIAL_OPAQUE:
217 case TILE_MATERIAL_LIQUID_OPAQUE:
218 case TILE_MATERIAL_WAVING_LIQUID_OPAQUE:
219 material.MaterialType = video::EMT_SOLID;
221 case TILE_MATERIAL_BASIC:
222 case TILE_MATERIAL_WAVING_LEAVES:
223 case TILE_MATERIAL_WAVING_PLANTS:
224 case TILE_MATERIAL_WAVING_LIQUID_BASIC:
225 material.MaterialTypeParam = 0.5;
226 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL_REF;
228 case TILE_MATERIAL_ALPHA:
229 case TILE_MATERIAL_LIQUID_TRANSPARENT:
230 case TILE_MATERIAL_WAVING_LIQUID_TRANSPARENT:
231 material.MaterialType = video::EMT_TRANSPARENT_ALPHA_CHANNEL;
236 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) != 0;
237 if (!(material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)) {
238 material.TextureLayer[0].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
240 if (!(material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL)) {
241 material.TextureLayer[0].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
245 void applyMaterialOptionsWithShaders(video::SMaterial &material) const
247 material.BackfaceCulling = (material_flags & MATERIAL_FLAG_BACKFACE_CULLING) != 0;
248 if (!(material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)) {
249 material.TextureLayer[0].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
250 material.TextureLayer[1].TextureWrapU = video::ETC_CLAMP_TO_EDGE;
252 if (!(material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL)) {
253 material.TextureLayer[0].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
254 material.TextureLayer[1].TextureWrapV = video::ETC_CLAMP_TO_EDGE;
258 bool isTileable() const
260 return (material_flags & MATERIAL_FLAG_TILEABLE_HORIZONTAL)
261 && (material_flags & MATERIAL_FLAG_TILEABLE_VERTICAL);
264 // Ordered for size, please do not reorder
266 video::ITexture *texture = nullptr;
267 video::ITexture *normal_texture = nullptr;
268 video::ITexture *flags_texture = nullptr;
274 u16 animation_frame_length_ms = 0;
275 u8 animation_frame_count = 1;
277 u8 material_type = TILE_MATERIAL_BASIC;
279 //0 // <- DEBUG, Use the one below
280 MATERIAL_FLAG_BACKFACE_CULLING |
281 MATERIAL_FLAG_TILEABLE_HORIZONTAL|
282 MATERIAL_FLAG_TILEABLE_VERTICAL;
284 //! If true, the tile has its own color.
285 bool has_color = false;
287 std::shared_ptr<std::vector<FrameSpec>> frames = nullptr;
290 * The color of the tile, or if the tile does not own
291 * a color then the color of the node owning this tile.
299 * Defines a face of a node. May have up to two layers.
303 TileSpec() = default;
306 * Returns true if this tile can be merged with the other tile.
308 bool isTileable(const TileSpec &other) const {
309 for (int layer = 0; layer < MAX_TILE_LAYERS; layer++) {
310 if (layers[layer] != other.layers[layer])
312 if (!layers[layer].isTileable())
316 && rotation == other.rotation
317 && emissive_light == other.emissive_light;
320 //! If true, the tile rotation is ignored.
321 bool world_aligned = false;
324 //! This much light does the tile emit.
325 u8 emissive_light = 0;
326 //! The first is base texture, the second is overlay.
327 TileLayer layers[MAX_TILE_LAYERS];
330 std::vector<std::string> getTextureDirs();