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