src/mapgen/cavegen.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2018 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   4 Copyright (C) 2015-2018 paramat
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #pragma once
  22
  23 #define VMANIP_FLAG_CAVE VOXELFLAG_CHECKED1
  24
  25 class GenerateNotifier;
  26
  27 /*
  28         CavesNoiseIntersection is a cave digging algorithm that carves smooth,
  29         web-like, continuous tunnels at points where the density of the intersection
  30         between two separate 3d noises is above a certain value.  This value,
  31         cave_width, can be modified to set the effective width of these tunnels.
  32
  33         This algorithm is relatively heavyweight, taking ~80ms to generate an
  34         80x80x80 chunk of map on a modern processor.  Use sparingly!
  35
  36         TODO(hmmmm): Remove dependency on biomes
  37         TODO(hmmmm): Find alternative to overgeneration as solution for sunlight issue
  38 */
  39 class CavesNoiseIntersection
  40 {
  41 public:
  42         CavesNoiseIntersection(const NodeDefManager *nodedef,
  43                 BiomeManager *biomemgr, v3s16 chunksize, NoiseParams *np_cave1,
  44                 NoiseParams *np_cave2, s32 seed, float cave_width);
  45         ~CavesNoiseIntersection();
  46
  47         void generateCaves(MMVManip *vm, v3s16 nmin, v3s16 nmax, u8 *biomemap);
  48
  49 private:
  50         const NodeDefManager *m_ndef;
  51         BiomeManager *m_bmgr;
  52
  53         // configurable parameters
  54         v3s16 m_csize;
  55         float m_cave_width;
  56
  57         // intermediate state variables
  58         u16 m_ystride;
  59         u16 m_zstride_1d;
  60
  61         Noise *noise_cave1;
  62         Noise *noise_cave2;
  63 };
  64
  65 /*
  66         CavernsNoise is a cave digging algorithm
  67 */
  68 class CavernsNoise
  69 {
  70 public:
  71         CavernsNoise(const NodeDefManager *nodedef, v3s16 chunksize,
  72                 NoiseParams *np_cavern, s32 seed, float cavern_limit,
  73                 float cavern_taper, float cavern_threshold);
  74         ~CavernsNoise();
  75
  76         bool generateCaverns(MMVManip *vm, v3s16 nmin, v3s16 nmax);
  77
  78 private:
  79         const NodeDefManager *m_ndef;
  80
  81         // configurable parameters
  82         v3s16 m_csize;
  83         float m_cavern_limit;
  84         float m_cavern_taper;
  85         float m_cavern_threshold;
  86
  87         // intermediate state variables
  88         u16 m_ystride;
  89         u16 m_zstride_1d;
  90
  91         Noise *noise_cavern;
  92
  93         content_t c_water_source;
  94         content_t c_lava_source;
  95 };
  96
  97 /*
  98         CavesRandomWalk is an implementation of a cave-digging algorithm that
  99         operates on the principle of a "random walk" to approximate the stochiastic
 100         activity of cavern development.
 101
 102         In summary, this algorithm works by carving a randomly sized tunnel in a
 103         random direction a random amount of times, randomly varying in width.
 104         All randomness here is uniformly distributed; alternative distributions have
 105         not yet been implemented.
 106
 107         This algorithm is very fast, executing in less than 1ms on average for an
 108         80x80x80 chunk of map on a modern processor.
 109 */
 110 class CavesRandomWalk
 111 {
 112 public:
 113         MMVManip *vm;
 114         const NodeDefManager *ndef;
 115         GenerateNotifier *gennotify;
 116         s16 *heightmap;
 117         BiomeGen *bmgn;
 118
 119         // configurable parameters
 120         s32 seed;
 121         int water_level;
 122         int lava_depth;
 123         NoiseParams *np_caveliquids;
 124
 125         // intermediate state variables
 126         u16 ystride;
 127
 128         s16 min_tunnel_diameter;
 129         s16 max_tunnel_diameter;
 130         u16 tunnel_routepoints;
 131         int part_max_length_rs;
 132
 133         bool large_cave;
 134         bool large_cave_is_flat;
 135         bool flooded;
 136
 137         v3s16 node_min;
 138         v3s16 node_max;
 139
 140         v3f orp;  // starting point, relative to caved space
 141         v3s16 of; // absolute coordinates of caved space
 142         v3s16 ar; // allowed route area
 143         s16 rs;   // tunnel radius size
 144         v3f main_direction;
 145
 146         s16 route_y_min;
 147         s16 route_y_max;
 148
 149         PseudoRandom *ps;
 150
 151         content_t c_water_source;
 152         content_t c_lava_source;
 153
 154         // ndef is a mandatory parameter.
 155         // If gennotify is NULL, generation events are not logged.
 156         // If biomegen is NULL, cave liquids have classic behaviour.
 157         CavesRandomWalk(const NodeDefManager *ndef, GenerateNotifier *gennotify =
 158                 NULL, s32 seed = 0, int water_level = 1, content_t water_source =
 159                 CONTENT_IGNORE, content_t lava_source = CONTENT_IGNORE,
 160                 int lava_depth = -256, BiomeGen *biomegen = NULL);
 161
 162         // vm and ps are mandatory parameters.
 163         // If heightmap is NULL, the surface level at all points is assumed to
 164         // be water_level.
 165         void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
 166                         bool is_large_cave, int max_stone_height, s16 *heightmap);
 167
 168 private:
 169         void makeTunnel(bool dirswitch);
 170         void carveRoute(v3f vec, float f, bool randomize_xz);
 171
 172         inline bool isPosAboveSurface(v3s16 p);
 173 };
 174
 175 /*
 176         CavesV6 is the original version of caves used with Mapgen V6.
 177
 178         Though it uses the same fundamental algorithm as CavesRandomWalk, it is made
 179         separate to preserve the exact sequence of PseudoRandom calls - any change
 180         to this ordering results in the output being radically different.
 181         Because caves in Mapgen V6 are responsible for a large portion of the basic
 182         terrain shape, modifying this will break our contract of reverse
 183         compatibility for a 'stable' mapgen such as V6.
 184
 185         tl;dr,
 186         *** DO NOT TOUCH THIS CLASS UNLESS YOU KNOW WHAT YOU ARE DOING ***
 187 */
 188 class CavesV6
 189 {
 190 public:
 191         MMVManip *vm;
 192         const NodeDefManager *ndef;
 193         GenerateNotifier *gennotify;
 194         PseudoRandom *ps;
 195         PseudoRandom *ps2;
 196
 197         // configurable parameters
 198         s16 *heightmap;
 199         content_t c_water_source;
 200         content_t c_lava_source;
 201         int water_level;
 202
 203         // intermediate state variables
 204         u16 ystride;
 205
 206         s16 min_tunnel_diameter;
 207         s16 max_tunnel_diameter;
 208         u16 tunnel_routepoints;
 209         int part_max_length_rs;
 210
 211         bool large_cave;
 212         bool large_cave_is_flat;
 213
 214         v3s16 node_min;
 215         v3s16 node_max;
 216
 217         v3f orp;  // starting point, relative to caved space
 218         v3s16 of; // absolute coordinates of caved space
 219         v3s16 ar; // allowed route area
 220         s16 rs;   // tunnel radius size
 221         v3f main_direction;
 222
 223         s16 route_y_min;
 224         s16 route_y_max;
 225
 226         // ndef is a mandatory parameter.
 227         // If gennotify is NULL, generation events are not logged.
 228         CavesV6(const NodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
 229                         int water_level = 1, content_t water_source = CONTENT_IGNORE,
 230                         content_t lava_source = CONTENT_IGNORE);
 231
 232         // vm, ps, and ps2 are mandatory parameters.
 233         // If heightmap is NULL, the surface level at all points is assumed to
 234         // be water_level.
 235         void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
 236                         PseudoRandom *ps2, bool is_large_cave, int max_stone_height,
 237                         s16 *heightmap = NULL);
 238
 239 private:
 240         void makeTunnel(bool dirswitch);
 241         void carveRoute(v3f vec, float f, bool randomize_xz, bool tunnel_above_ground);
 242
 243         inline s16 getSurfaceFromHeightmap(v3s16 p);
 244 };