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
25 class GenerateNotifier;
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.
33 This algorithm is relatively heavyweight, taking ~80ms to generate an
34 80x80x80 chunk of map on a modern processor. Use sparingly!
36 TODO(hmmmm): Remove dependency on biomes
37 TODO(hmmmm): Find alternative to overgeneration as solution for sunlight issue
39 class CavesNoiseIntersection
42 CavesNoiseIntersection(INodeDefManager *nodedef, BiomeManager *biomemgr,
43 v3s16 chunksize, NoiseParams *np_cave1, NoiseParams *np_cave2,
44 s32 seed, float cave_width);
45 ~CavesNoiseIntersection();
47 void generateCaves(MMVManip *vm, v3s16 nmin, v3s16 nmax, u8 *biomemap);
50 INodeDefManager *m_ndef;
53 // configurable parameters
57 // intermediate state variables
66 CavernsNoise is a cave digging algorithm
71 CavernsNoise(INodeDefManager *nodedef, v3s16 chunksize, NoiseParams *np_cavern,
72 s32 seed, float cavern_limit, float cavern_taper,
73 float cavern_threshold);
76 bool generateCaverns(MMVManip *vm, v3s16 nmin, v3s16 nmax);
79 INodeDefManager *m_ndef;
81 // configurable parameters
85 float m_cavern_threshold;
87 // intermediate state variables
93 content_t c_water_source;
94 content_t c_lava_source;
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.
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.
107 This algorithm is very fast, executing in less than 1ms on average for an
108 80x80x80 chunk of map on a modern processor.
110 class CavesRandomWalk
114 INodeDefManager *ndef;
115 GenerateNotifier *gennotify;
118 // configurable parameters
122 NoiseParams *np_caveliquids;
124 // intermediate state variables
127 s16 min_tunnel_diameter;
128 s16 max_tunnel_diameter;
129 u16 tunnel_routepoints;
130 int part_max_length_rs;
133 bool large_cave_is_flat;
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
151 content_t c_water_source;
152 content_t c_lava_source;
154 // ndef is a mandatory parameter.
155 // If gennotify is NULL, generation events are not logged.
156 CavesRandomWalk(INodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
157 s32 seed = 0, int water_level = 1,
158 content_t water_source = CONTENT_IGNORE,
159 content_t lava_source = CONTENT_IGNORE, int lava_depth = -256);
161 // vm and ps are mandatory parameters.
162 // If heightmap is NULL, the surface level at all points is assumed to
164 void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
165 bool is_large_cave, int max_stone_height, s16 *heightmap);
168 void makeTunnel(bool dirswitch);
169 void carveRoute(v3f vec, float f, bool randomize_xz);
171 inline bool isPosAboveSurface(v3s16 p);
175 CavesV6 is the original version of caves used with Mapgen V6.
177 Though it uses the same fundamental algorithm as CavesRandomWalk, it is made
178 separate to preserve the exact sequence of PseudoRandom calls - any change
179 to this ordering results in the output being radically different.
180 Because caves in Mapgen V6 are responsible for a large portion of the basic
181 terrain shape, modifying this will break our contract of reverse
182 compatibility for a 'stable' mapgen such as V6.
185 *** DO NOT TOUCH THIS CLASS UNLESS YOU KNOW WHAT YOU ARE DOING ***
191 INodeDefManager *ndef;
192 GenerateNotifier *gennotify;
196 // configurable parameters
198 content_t c_water_source;
199 content_t c_lava_source;
202 // intermediate state variables
205 s16 min_tunnel_diameter;
206 s16 max_tunnel_diameter;
207 u16 tunnel_routepoints;
208 int part_max_length_rs;
211 bool large_cave_is_flat;
216 v3f orp; // starting point, relative to caved space
217 v3s16 of; // absolute coordinates of caved space
218 v3s16 ar; // allowed route area
219 s16 rs; // tunnel radius size
225 // ndef is a mandatory parameter.
226 // If gennotify is NULL, generation events are not logged.
227 CavesV6(INodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
228 int water_level = 1, content_t water_source = CONTENT_IGNORE,
229 content_t lava_source = CONTENT_IGNORE);
231 // vm, ps, and ps2 are mandatory parameters.
232 // If heightmap is NULL, the surface level at all points is assumed to
234 void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
235 PseudoRandom *ps2, bool is_large_cave, int max_stone_height,
236 s16 *heightmap = NULL);
239 void makeTunnel(bool dirswitch);
240 void carveRoute(v3f vec, float f, bool randomize_xz, bool tunnel_above_ground);
242 inline s16 getSurfaceFromHeightmap(v3s16 p);