Fixed minimap memory leak
[oweals/minetest.git] / src / mapblock_mesh.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 MAPBLOCK_MESH_HEADER
21 #define MAPBLOCK_MESH_HEADER
22
23 #include "irrlichttypes_extrabloated.h"
24 #include "client/tile.h"
25 #include "voxel.h"
26 #include <map>
27
28 class IGameDef;
29 class IShaderSource;
30
31 /*
32         Mesh making stuff
33 */
34
35
36 class MapBlock;
37 struct MinimapMapblock;
38
39 struct MeshMakeData
40 {
41         VoxelManipulator m_vmanip;
42         v3s16 m_blockpos;
43         v3s16 m_crack_pos_relative;
44         v3s16 m_highlighted_pos_relative;
45         bool m_smooth_lighting;
46         bool m_show_hud;
47         video::SColor m_highlight_mesh_color;
48
49         IGameDef *m_gamedef;
50         bool m_use_shaders;
51
52         MeshMakeData(IGameDef *gamedef, bool use_shaders);
53
54         /*
55                 Copy central data directly from block, and other data from
56                 parent of block.
57         */
58         void fill(MapBlock *block);
59
60         /*
61                 Set up with only a single node at (1,1,1)
62         */
63         void fillSingleNode(MapNode *node);
64
65         /*
66                 Set the (node) position of a crack
67         */
68         void setCrack(int crack_level, v3s16 crack_pos);
69
70         /*
71                 Set the highlighted node position
72         */
73
74         void setHighlighted(v3s16 highlighted_pos, bool show_hud);
75         /*
76                 Enable or disable smooth lighting
77         */
78         void setSmoothLighting(bool smooth_lighting);
79 };
80
81 /*
82         Holds a mesh for a mapblock.
83
84         Besides the SMesh*, this contains information used for animating
85         the vertex positions, colors and texture coordinates of the mesh.
86         For example:
87         - cracks [implemented]
88         - day/night transitions [implemented]
89         - animated flowing liquids [not implemented]
90         - animating vertex positions for e.g. axles [not implemented]
91 */
92 class MapBlockMesh
93 {
94 public:
95         // Builds the mesh given
96         MapBlockMesh(MeshMakeData *data, v3s16 camera_offset);
97         ~MapBlockMesh();
98
99         // Main animation function, parameters:
100         //   faraway: whether the block is far away from the camera (~50 nodes)
101         //   time: the global animation time, 0 .. 60 (repeats every minute)
102         //   daynight_ratio: 0 .. 1000
103         //   crack: -1 .. CRACK_ANIMATION_LENGTH-1 (-1 for off)
104         // Returns true if anything has been changed.
105         bool animate(bool faraway, float time, int crack, u32 daynight_ratio);
106
107         scene::SMesh *getMesh()
108         {
109                 return m_mesh;
110         }
111
112         MinimapMapblock *moveMinimapMapblock()
113         {
114                 MinimapMapblock *p = m_minimap_mapblock;
115                 m_minimap_mapblock = NULL;
116                 return p;
117         }
118
119         bool isAnimationForced() const
120         {
121                 return m_animation_force_timer == 0;
122         }
123
124         void decreaseAnimationForceTimer()
125         {
126                 if(m_animation_force_timer > 0)
127                         m_animation_force_timer--;
128         }
129         
130         void updateCameraOffset(v3s16 camera_offset);
131
132 private:
133         scene::SMesh *m_mesh;
134         MinimapMapblock *m_minimap_mapblock;
135         IGameDef *m_gamedef;
136         ITextureSource *m_tsrc;
137         IShaderSource *m_shdrsrc;
138
139         bool m_enable_shaders;
140         bool m_enable_highlighting;
141
142         video::SColor m_highlight_mesh_color;
143         
144         // Must animate() be called before rendering?
145         bool m_has_animation;
146         int m_animation_force_timer;
147
148         // Animation info: cracks
149         // Last crack value passed to animate()
150         int m_last_crack;
151         // Maps mesh buffer (i.e. material) indices to base texture names
152         std::map<u32, std::string> m_crack_materials;
153         std::list<u32> m_highlighted_materials;
154
155         // Animation info: texture animationi
156         // Maps meshbuffers to TileSpecs
157         std::map<u32, TileSpec> m_animation_tiles;
158         std::map<u32, int> m_animation_frames; // last animation frame
159         std::map<u32, int> m_animation_frame_offsets;
160         
161         // Animation info: day/night transitions
162         // Last daynight_ratio value passed to animate()
163         u32 m_last_daynight_ratio;
164         // For each meshbuffer, maps vertex indices to (day,night) pairs
165         std::map<u32, std::map<u32, std::pair<u8, u8> > > m_daynight_diffs;
166         
167         // Camera offset info -> do we have to translate the mesh?
168         v3s16 m_camera_offset;
169 };
170
171
172
173 /*
174         This is used because CMeshBuffer::append() is very slow
175 */
176 struct PreMeshBuffer
177 {
178         TileSpec tile;
179         std::vector<u16> indices;
180         std::vector<video::S3DVertexTangents> vertices;
181 };
182
183 struct MeshCollector
184 {
185         std::vector<PreMeshBuffer> prebuffers;
186         void append(const TileSpec &material,
187                         const video::S3DVertex *vertices, u32 numVertices,
188                         const u16 *indices, u32 numIndices);
189         void append(const TileSpec &material,
190                         const video::S3DVertex *vertices, u32 numVertices,
191                         const u16 *indices, u32 numIndices,
192                         v3f pos, video::SColor c);
193 };
194
195 // This encodes
196 //   alpha in the A channel of the returned SColor
197 //   day light (0-255) in the R channel of the returned SColor
198 //   night light (0-255) in the G channel of the returned SColor
199 //   light source (0-255) in the B channel of the returned SColor
200 inline video::SColor MapBlock_LightColor(u8 alpha, u16 light, u8 light_source=0)
201 {
202         return video::SColor(alpha, (light & 0xff), (light >> 8), light_source);
203 }
204
205 // Compute light at node
206 u16 getInteriorLight(MapNode n, s32 increment, INodeDefManager *ndef);
207 u16 getFaceLight(MapNode n, MapNode n2, v3s16 face_dir, INodeDefManager *ndef);
208 u16 getSmoothLight(v3s16 p, v3s16 corner, MeshMakeData *data);
209
210 // Converts from day + night color values (0..255)
211 // and a given daynight_ratio to the final SColor shown on screen.
212 void finalColorBlend(video::SColor& result,
213                 u8 day, u8 night, u32 daynight_ratio);
214
215 // Retrieves the TileSpec of a face of a node
216 // Adds MATERIAL_FLAG_CRACK if the node is cracked
217 TileSpec getNodeTileN(MapNode mn, v3s16 p, u8 tileindex, MeshMakeData *data);
218 TileSpec getNodeTile(MapNode mn, v3s16 p, v3s16 dir, MeshMakeData *data);
219
220 #endif
221