src/client/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 #pragma once
  21
  22 #include "irrlichttypes_extrabloated.h"
  23 #include "client/tile.h"
  24 #include "voxel.h"
  25 #include <array>
  26 #include <map>
  27
  28 class Client;
  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 = v3s16(-1337,-1337,-1337);
  43         v3s16 m_crack_pos_relative = v3s16(-1337,-1337,-1337);
  44         bool m_smooth_lighting = false;
  45
  46         Client *m_client;
  47         bool m_use_shaders;
  48         bool m_use_tangent_vertices;
  49
  50         MeshMakeData(Client *client, bool use_shaders,
  51                         bool use_tangent_vertices = false);
  52
  53         /*
  54                 Copy block data manually (to allow optimizations by the caller)
  55         */
  56         void fillBlockDataBegin(const v3s16 &blockpos);
  57         void fillBlockData(const v3s16 &block_offset, MapNode *data);
  58
  59         /*
  60                 Copy central data directly from block, and other data from
  61                 parent of block.
  62         */
  63         void fill(MapBlock *block);
  64
  65         /*
  66                 Set the (node) position of a crack
  67         */
  68         void setCrack(int crack_level, v3s16 crack_pos);
  69
  70         /*
  71                 Enable or disable smooth lighting
  72         */
  73         void setSmoothLighting(bool smooth_lighting);
  74 };
  75
  76 /*
  77         Holds a mesh for a mapblock.
  78
  79         Besides the SMesh*, this contains information used for animating
  80         the vertex positions, colors and texture coordinates of the mesh.
  81         For example:
  82         - cracks [implemented]
  83         - day/night transitions [implemented]
  84         - animated flowing liquids [not implemented]
  85         - animating vertex positions for e.g. axles [not implemented]
  86 */
  87 class MapBlockMesh
  88 {
  89 public:
  90         // Builds the mesh given
  91         MapBlockMesh(MeshMakeData *data, v3s16 camera_offset);
  92         ~MapBlockMesh();
  93
  94         // Main animation function, parameters:
  95         //   faraway: whether the block is far away from the camera (~50 nodes)
  96         //   time: the global animation time, 0 .. 60 (repeats every minute)
  97         //   daynight_ratio: 0 .. 1000
  98         //   crack: -1 .. CRACK_ANIMATION_LENGTH-1 (-1 for off)
  99         // Returns true if anything has been changed.
 100         bool animate(bool faraway, float time, int crack, u32 daynight_ratio);
 101
 102         scene::IMesh *getMesh()
 103         {
 104                 return m_mesh[0];
 105         }
 106
 107         scene::IMesh *getMesh(u8 layer)
 108         {
 109                 return m_mesh[layer];
 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::IMesh *m_mesh[MAX_TILE_LAYERS];
 134         MinimapMapblock *m_minimap_mapblock;
 135         ITextureSource *m_tsrc;
 136         IShaderSource *m_shdrsrc;
 137
 138         bool m_enable_shaders;
 139         bool m_use_tangent_vertices;
 140         bool m_enable_vbo;
 141
 142         // Must animate() be called before rendering?
 143         bool m_has_animation;
 144         int m_animation_force_timer;
 145
 146         // Animation info: cracks
 147         // Last crack value passed to animate()
 148         int m_last_crack;
 149         // Maps mesh and mesh buffer (i.e. material) indices to base texture names
 150         std::map<std::pair<u8, u32>, std::string> m_crack_materials;
 151
 152         // Animation info: texture animationi
 153         // Maps mesh and mesh buffer indices to TileSpecs
 154         // Keys are pairs of (mesh index, buffer index in the mesh)
 155         std::map<std::pair<u8, u32>, TileLayer> m_animation_tiles;
 156         std::map<std::pair<u8, u32>, int> m_animation_frames; // last animation frame
 157         std::map<std::pair<u8, u32>, int> m_animation_frame_offsets;
 158
 159         // Animation info: day/night transitions
 160         // Last daynight_ratio value passed to animate()
 161         u32 m_last_daynight_ratio;
 162         // For each mesh and mesh buffer, stores pre-baked colors
 163         // of sunlit vertices
 164         // Keys are pairs of (mesh index, buffer index in the mesh)
 165         std::map<std::pair<u8, u32>, std::map<u32, video::SColor > > m_daynight_diffs;
 166
 167         // Camera offset info -> do we have to translate the mesh?
 168         v3s16 m_camera_offset;
 169 };
 170
 171 /*!
 172  * Encodes light of a node.
 173  * The result is not the final color, but a
 174  * half-baked vertex color.
 175  * You have to multiply the resulting color
 176  * with the node's color.
 177  *
 178  * \param light the first 8 bits are day light,
 179  * the last 8 bits are night light
 180  * \param emissive_light amount of light the surface emits,
 181  * from 0 to LIGHT_SUN.
 182  */
 183 video::SColor encode_light(u16 light, u8 emissive_light);
 184
 185 // Compute light at node
 186 u16 getInteriorLight(MapNode n, s32 increment, const NodeDefManager *ndef);
 187 u16 getFaceLight(MapNode n, MapNode n2, const v3s16 &face_dir,
 188         const NodeDefManager *ndef);
 189 u16 getSmoothLightSolid(const v3s16 &p, const v3s16 &face_dir, const v3s16 &corner, MeshMakeData *data);
 190 u16 getSmoothLightTransparent(const v3s16 &p, const v3s16 &corner, MeshMakeData *data);
 191
 192 /*!
 193  * Returns the sunlight's color from the current
 194  * day-night ratio.
 195  */
 196 void get_sunlight_color(video::SColorf *sunlight, u32 daynight_ratio);
 197
 198 /*!
 199  * Gives the final  SColor shown on screen.
 200  *
 201  * \param result output color
 202  * \param light first 8 bits are day light, second 8 bits are
 203  * night light
 204  */
 205 void final_color_blend(video::SColor *result,
 206                 u16 light, u32 daynight_ratio);
 207
 208 /*!
 209  * Gives the final  SColor shown on screen.
 210  *
 211  * \param result output color
 212  * \param data the half-baked vertex color
 213  * \param dayLight color of the sunlight
 214  */
 215 void final_color_blend(video::SColor *result,
 216                 const video::SColor &data, const video::SColorf &dayLight);
 217
 218 // Retrieves the TileSpec of a face of a node
 219 // Adds MATERIAL_FLAG_CRACK if the node is cracked
 220 // TileSpec should be passed as reference due to the underlying TileFrame and its vector
 221 // TileFrame vector copy cost very much to client
 222 void getNodeTileN(MapNode mn, const v3s16 &p, u8 tileindex, MeshMakeData *data, TileSpec &tile);
 223 void getNodeTile(MapNode mn, const v3s16 &p, const v3s16 &dir, MeshMakeData *data, TileSpec &tile);