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.
22 #define VMANIP_FLAG_CAVE VOXELFLAG_CHECKED1
24 class GenerateNotifier;
27 CavesNoiseIntersection is a cave digging algorithm that carves smooth,
28 web-like, continuous tunnels at points where the density of the intersection
29 between two separate 3d noises is above a certain value. This value,
30 cave_width, can be modified to set the effective width of these tunnels.
32 This algorithm is relatively heavyweight, taking ~80ms to generate an
33 80x80x80 chunk of map on a modern processor. Use sparingly!
35 TODO(hmmmm): Remove dependency on biomes
36 TODO(hmmmm): Find alternative to overgeneration as solution for sunlight issue
38 class CavesNoiseIntersection
41 CavesNoiseIntersection(INodeDefManager *nodedef, BiomeManager *biomemgr,
42 v3s16 chunksize, NoiseParams *np_cave1, NoiseParams *np_cave2,
43 s32 seed, float cave_width);
44 ~CavesNoiseIntersection();
46 void generateCaves(MMVManip *vm, v3s16 nmin, v3s16 nmax, u8 *biomemap);
49 INodeDefManager *m_ndef;
52 // configurable parameters
56 // intermediate state variables
65 CavernsNoise is a cave digging algorithm
70 CavernsNoise(INodeDefManager *nodedef, v3s16 chunksize, NoiseParams *np_cavern,
71 s32 seed, float cavern_limit, float cavern_taper,
72 float cavern_threshold);
75 bool generateCaverns(MMVManip *vm, v3s16 nmin, v3s16 nmax);
78 INodeDefManager *m_ndef;
80 // configurable parameters
84 float m_cavern_threshold;
86 // intermediate state variables
92 content_t c_water_source;
93 content_t c_lava_source;
97 CavesRandomWalk is an implementation of a cave-digging algorithm that
98 operates on the principle of a "random walk" to approximate the stochiastic
99 activity of cavern development.
101 In summary, this algorithm works by carving a randomly sized tunnel in a
102 random direction a random amount of times, randomly varying in width.
103 All randomness here is uniformly distributed; alternative distributions have
104 not yet been implemented.
106 This algorithm is very fast, executing in less than 1ms on average for an
107 80x80x80 chunk of map on a modern processor.
109 class CavesRandomWalk
113 INodeDefManager *ndef;
114 GenerateNotifier *gennotify;
117 // configurable parameters
121 NoiseParams *np_caveliquids;
123 // intermediate state variables
126 s16 min_tunnel_diameter;
127 s16 max_tunnel_diameter;
128 u16 tunnel_routepoints;
129 int part_max_length_rs;
132 bool large_cave_is_flat;
139 v3f orp; // starting point, relative to caved space
140 v3s16 of; // absolute coordinates of caved space
141 v3s16 ar; // allowed route area
142 s16 rs; // tunnel radius size
150 content_t c_water_source;
151 content_t c_lava_source;
153 // ndef is a mandatory parameter.
154 // If gennotify is NULL, generation events are not logged.
155 CavesRandomWalk(INodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
156 s32 seed = 0, int water_level = 1,
157 content_t water_source = CONTENT_IGNORE,
158 content_t lava_source = CONTENT_IGNORE, int lava_depth = -256);
160 // vm and ps are mandatory parameters.
161 // If heightmap is NULL, the surface level at all points is assumed to
163 void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
164 bool is_large_cave, int max_stone_height, s16 *heightmap);
167 void makeTunnel(bool dirswitch);
168 void carveRoute(v3f vec, float f, bool randomize_xz);
170 inline bool isPosAboveSurface(v3s16 p);
174 CavesV6 is the original version of caves used with Mapgen V6.
176 Though it uses the same fundamental algorithm as CavesRandomWalk, it is made
177 separate to preserve the exact sequence of PseudoRandom calls - any change
178 to this ordering results in the output being radically different.
179 Because caves in Mapgen V6 are responsible for a large portion of the basic
180 terrain shape, modifying this will break our contract of reverse
181 compatibility for a 'stable' mapgen such as V6.
184 *** DO NOT TOUCH THIS CLASS UNLESS YOU KNOW WHAT YOU ARE DOING ***
190 INodeDefManager *ndef;
191 GenerateNotifier *gennotify;
195 // configurable parameters
197 content_t c_water_source;
198 content_t c_lava_source;
201 // intermediate state variables
204 s16 min_tunnel_diameter;
205 s16 max_tunnel_diameter;
206 u16 tunnel_routepoints;
207 int part_max_length_rs;
210 bool large_cave_is_flat;
215 v3f orp; // starting point, relative to caved space
216 v3s16 of; // absolute coordinates of caved space
217 v3s16 ar; // allowed route area
218 s16 rs; // tunnel radius size
224 // ndef is a mandatory parameter.
225 // If gennotify is NULL, generation events are not logged.
226 CavesV6(INodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
227 int water_level = 1, content_t water_source = CONTENT_IGNORE,
228 content_t lava_source = CONTENT_IGNORE);
230 // vm, ps, and ps2 are mandatory parameters.
231 // If heightmap is NULL, the surface level at all points is assumed to
233 void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
234 PseudoRandom *ps2, bool is_large_cave, int max_stone_height,
235 s16 *heightmap = NULL);
238 void makeTunnel(bool dirswitch);
239 void carveRoute(v3f vec, float f, bool randomize_xz, bool tunnel_above_ground);
241 inline s16 getSurfaceFromHeightmap(v3s16 p);