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         // TODO 'lava_depth' and 'np_caveliquids' are deprecated and should be removed.
 123         // Cave liquids are now defined and located using biome definitions.
 124         int lava_depth;
 125         NoiseParams *np_caveliquids;
 126
 127         // intermediate state variables
 128         u16 ystride;
 129
 130         s16 min_tunnel_diameter;
 131         s16 max_tunnel_diameter;
 132         u16 tunnel_routepoints;
 133         int part_max_length_rs;
 134
 135         bool large_cave;
 136         bool large_cave_is_flat;
 137         bool flooded;
 138         bool use_biome_liquid;
 139
 140         v3s16 node_min;
 141         v3s16 node_max;
 142
 143         v3f orp;  // starting point, relative to caved space
 144         v3s16 of; // absolute coordinates of caved space
 145         v3s16 ar; // allowed route area
 146         s16 rs;   // tunnel radius size
 147         v3f main_direction;
 148
 149         s16 route_y_min;
 150         s16 route_y_max;
 151
 152         PseudoRandom *ps;
 153
 154         content_t c_water_source;
 155         content_t c_lava_source;
 156         content_t c_biome_liquid;
 157
 158         // ndef is a mandatory parameter.
 159         // If gennotify is NULL, generation events are not logged.
 160         // If biomegen is NULL, cave liquids have classic behaviour.
 161         CavesRandomWalk(const NodeDefManager *ndef, GenerateNotifier *gennotify =
 162                 NULL, s32 seed = 0, int water_level = 1, content_t water_source =
 163                 CONTENT_IGNORE, content_t lava_source = CONTENT_IGNORE,
 164                 int lava_depth = -256, BiomeGen *biomegen = NULL);
 165
 166         // vm and ps are mandatory parameters.
 167         // If heightmap is NULL, the surface level at all points is assumed to
 168         // be water_level.
 169         void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
 170                         bool is_large_cave, int max_stone_height, s16 *heightmap);
 171
 172 private:
 173         void makeTunnel(bool dirswitch);
 174         void carveRoute(v3f vec, float f, bool randomize_xz);
 175
 176         inline bool isPosAboveSurface(v3s16 p);
 177 };
 178
 179 /*
 180         CavesV6 is the original version of caves used with Mapgen V6.
 181
 182         Though it uses the same fundamental algorithm as CavesRandomWalk, it is made
 183         separate to preserve the exact sequence of PseudoRandom calls - any change
 184         to this ordering results in the output being radically different.
 185         Because caves in Mapgen V6 are responsible for a large portion of the basic
 186         terrain shape, modifying this will break our contract of reverse
 187         compatibility for a 'stable' mapgen such as V6.
 188
 189         tl;dr,
 190         *** DO NOT TOUCH THIS CLASS UNLESS YOU KNOW WHAT YOU ARE DOING ***
 191 */
 192 class CavesV6
 193 {
 194 public:
 195         MMVManip *vm;
 196         const NodeDefManager *ndef;
 197         GenerateNotifier *gennotify;
 198         PseudoRandom *ps;
 199         PseudoRandom *ps2;
 200
 201         // configurable parameters
 202         s16 *heightmap;
 203         content_t c_water_source;
 204         content_t c_lava_source;
 205         int water_level;
 206
 207         // intermediate state variables
 208         u16 ystride;
 209
 210         s16 min_tunnel_diameter;
 211         s16 max_tunnel_diameter;
 212         u16 tunnel_routepoints;
 213         int part_max_length_rs;
 214
 215         bool large_cave;
 216         bool large_cave_is_flat;
 217
 218         v3s16 node_min;
 219         v3s16 node_max;
 220
 221         v3f orp;  // starting point, relative to caved space
 222         v3s16 of; // absolute coordinates of caved space
 223         v3s16 ar; // allowed route area
 224         s16 rs;   // tunnel radius size
 225         v3f main_direction;
 226
 227         s16 route_y_min;
 228         s16 route_y_max;
 229
 230         // ndef is a mandatory parameter.
 231         // If gennotify is NULL, generation events are not logged.
 232         CavesV6(const NodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
 233                         int water_level = 1, content_t water_source = CONTENT_IGNORE,
 234                         content_t lava_source = CONTENT_IGNORE);
 235
 236         // vm, ps, and ps2 are mandatory parameters.
 237         // If heightmap is NULL, the surface level at all points is assumed to
 238         // be water_level.
 239         void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
 240                         PseudoRandom *ps2, bool is_large_cave, int max_stone_height,
 241                         s16 *heightmap = NULL);
 242
 243 private:
 244         void makeTunnel(bool dirswitch);
 245         void carveRoute(v3f vec, float f, bool randomize_xz, bool tunnel_above_ground);
 246
 247         inline s16 getSurfaceFromHeightmap(v3s16 p);
 248 };