3 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
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.
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.
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.
20 #ifndef CAVEGEN_HEADER
21 #define CAVEGEN_HEADER
23 #define VMANIP_FLAG_CAVE VOXELFLAG_CHECKED1
24 #define DEFAULT_LAVA_DEPTH (-256)
26 class GenerateNotifier;
29 CavesNoiseIntersection is a cave digging algorithm that carves smooth,
30 web-like, continuous tunnels at points where the density of the intersection
31 between two separate 3d noises is above a certain value. This value,
32 cave_width, can be modified to set the effective width of these tunnels.
34 This algorithm is relatively heavyweight, taking ~80ms to generate an
35 80x80x80 chunk of map on a modern processor. Use sparingly!
37 TODO(hmmmm): Remove dependency on biomes
38 TODO(hmmmm): Find alternative to overgeneration as solution for sunlight issue
40 class CavesNoiseIntersection
43 CavesNoiseIntersection(INodeDefManager *nodedef, BiomeManager *biomemgr,
44 v3s16 chunksize, NoiseParams *np_cave1, NoiseParams *np_cave2,
45 s32 seed, float cave_width);
46 ~CavesNoiseIntersection();
48 void generateCaves(MMVManip *vm, v3s16 nmin, v3s16 nmax, u8 *biomemap);
51 INodeDefManager *m_ndef;
54 // configurable parameters
58 // intermediate state variables
67 CavernsNoise is a cave digging algorithm
72 CavernsNoise(INodeDefManager *nodedef, v3s16 chunksize, NoiseParams *np_cavern,
73 s32 seed, float cavern_limit, float cavern_taper,
74 float cavern_threshold);
77 bool generateCaverns(MMVManip *vm, v3s16 nmin, v3s16 nmax);
80 INodeDefManager *m_ndef;
82 // configurable parameters
86 float m_cavern_threshold;
88 // intermediate state variables
94 content_t c_water_source;
95 content_t c_lava_source;
99 CavesRandomWalk is an implementation of a cave-digging algorithm that
100 operates on the principle of a "random walk" to approximate the stochiastic
101 activity of cavern development.
103 In summary, this algorithm works by carving a randomly sized tunnel in a
104 random direction a random amount of times, randomly varying in width.
105 All randomness here is uniformly distributed; alternative distributions have
106 not yet been implemented.
108 This algorithm is very fast, executing in less than 1ms on average for an
109 80x80x80 chunk of map on a modern processor.
111 class CavesRandomWalk
115 INodeDefManager *ndef;
116 GenerateNotifier *gennotify;
119 // configurable parameters
123 NoiseParams *np_caveliquids;
125 // intermediate state variables
128 s16 min_tunnel_diameter;
129 s16 max_tunnel_diameter;
130 u16 tunnel_routepoints;
131 int part_max_length_rs;
134 bool large_cave_is_flat;
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
152 content_t c_water_source;
153 content_t c_lava_source;
155 // ndef is a mandatory parameter.
156 // If gennotify is NULL, generation events are not logged.
157 CavesRandomWalk(INodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
158 s32 seed = 0, int water_level = 1,
159 content_t water_source = CONTENT_IGNORE,
160 content_t lava_source = CONTENT_IGNORE);
162 // vm and ps are mandatory parameters.
163 // If heightmap is NULL, the surface level at all points is assumed to
165 void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
166 bool is_large_cave, int max_stone_height, s16 *heightmap);
169 void makeTunnel(bool dirswitch);
170 void carveRoute(v3f vec, float f, bool randomize_xz);
172 inline bool isPosAboveSurface(v3s16 p);
176 CavesV6 is the original version of caves used with Mapgen V6.
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.
186 *** DO NOT TOUCH THIS CLASS UNLESS YOU KNOW WHAT YOU ARE DOING ***
192 INodeDefManager *ndef;
193 GenerateNotifier *gennotify;
197 // configurable parameters
199 content_t c_water_source;
200 content_t c_lava_source;
203 // intermediate state variables
206 s16 min_tunnel_diameter;
207 s16 max_tunnel_diameter;
208 u16 tunnel_routepoints;
209 int part_max_length_rs;
212 bool large_cave_is_flat;
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
226 // ndef is a mandatory parameter.
227 // If gennotify is NULL, generation events are not logged.
228 CavesV6(INodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
229 int water_level = 1, content_t water_source = CONTENT_IGNORE,
230 content_t lava_source = CONTENT_IGNORE);
232 // vm, ps, and ps2 are mandatory parameters.
233 // If heightmap is NULL, the surface level at all points is assumed to
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);
240 void makeTunnel(bool dirswitch);
241 void carveRoute(v3f vec, float f, bool randomize_xz, bool tunnel_above_ground);
243 inline s16 getSurfaceFromHeightmap(v3s16 p);