Biomes: Fix vertical biome blend
[oweals/minetest.git] / src / mapgen / mg_biome.cpp
1 /*
2 Minetest
3 Copyright (C) 2014-2018 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
4 Copyright (C) 2014-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 #include "mg_biome.h"
22 #include "mg_decoration.h"
23 #include "emerge.h"
24 #include "server.h"
25 #include "nodedef.h"
26 #include "map.h" //for MMVManip
27 #include "util/numeric.h"
28 #include "porting.h"
29 #include "settings.h"
30
31
32 ///////////////////////////////////////////////////////////////////////////////
33
34
35 BiomeManager::BiomeManager(Server *server) :
36         ObjDefManager(server, OBJDEF_BIOME)
37 {
38         m_server = server;
39
40         // Create default biome to be used in case none exist
41         Biome *b = new Biome;
42
43         b->name            = "default";
44         b->flags           = 0;
45         b->depth_top       = 0;
46         b->depth_filler    = -MAX_MAP_GENERATION_LIMIT;
47         b->depth_water_top = 0;
48         b->depth_riverbed  = 0;
49         b->min_pos         = v3s16(-MAX_MAP_GENERATION_LIMIT,
50                         -MAX_MAP_GENERATION_LIMIT, -MAX_MAP_GENERATION_LIMIT);
51         b->max_pos         = v3s16(MAX_MAP_GENERATION_LIMIT,
52                         MAX_MAP_GENERATION_LIMIT, MAX_MAP_GENERATION_LIMIT);
53         b->heat_point      = 0.0;
54         b->humidity_point  = 0.0;
55         b->vertical_blend  = 0;
56
57         b->m_nodenames.emplace_back("mapgen_stone");
58         b->m_nodenames.emplace_back("mapgen_stone");
59         b->m_nodenames.emplace_back("mapgen_stone");
60         b->m_nodenames.emplace_back("mapgen_water_source");
61         b->m_nodenames.emplace_back("mapgen_water_source");
62         b->m_nodenames.emplace_back("mapgen_river_water_source");
63         b->m_nodenames.emplace_back("mapgen_stone");
64         b->m_nodenames.emplace_back("ignore");
65         m_ndef->pendNodeResolve(b);
66
67         add(b);
68 }
69
70
71 void BiomeManager::clear()
72 {
73         EmergeManager *emerge = m_server->getEmergeManager();
74
75         // Remove all dangling references in Decorations
76         DecorationManager *decomgr = emerge->decomgr;
77         for (size_t i = 0; i != decomgr->getNumObjects(); i++) {
78                 Decoration *deco = (Decoration *)decomgr->getRaw(i);
79                 deco->biomes.clear();
80         }
81
82         // Don't delete the first biome
83         for (size_t i = 1; i < m_objects.size(); i++)
84                 delete (Biome *)m_objects[i];
85
86         m_objects.resize(1);
87 }
88
89
90 // For BiomeGen type 'BiomeGenOriginal'
91 float BiomeManager::getHeatAtPosOriginal(v3s16 pos, NoiseParams &np_heat,
92         NoiseParams &np_heat_blend, u64 seed)
93 {
94         return
95                 NoisePerlin2D(&np_heat,       pos.X, pos.Z, seed) +
96                 NoisePerlin2D(&np_heat_blend, pos.X, pos.Z, seed);
97 }
98
99
100 // For BiomeGen type 'BiomeGenOriginal'
101 float BiomeManager::getHumidityAtPosOriginal(v3s16 pos, NoiseParams &np_humidity,
102         NoiseParams &np_humidity_blend, u64 seed)
103 {
104         return
105                 NoisePerlin2D(&np_humidity,       pos.X, pos.Z, seed) +
106                 NoisePerlin2D(&np_humidity_blend, pos.X, pos.Z, seed);
107 }
108
109
110 // For BiomeGen type 'BiomeGenOriginal'
111 Biome *BiomeManager::getBiomeFromNoiseOriginal(float heat, float humidity, v3s16 pos)
112 {
113         Biome *biome_closest = nullptr;
114         Biome *biome_closest_blend = nullptr;
115         float dist_min = FLT_MAX;
116         float dist_min_blend = FLT_MAX;
117
118         for (size_t i = 1; i < getNumObjects(); i++) {
119                 Biome *b = (Biome *)getRaw(i);
120                 if (!b ||
121                                 pos.Y < b->min_pos.Y || pos.Y > b->max_pos.Y + b->vertical_blend ||
122                                 pos.X < b->min_pos.X || pos.X > b->max_pos.X ||
123                                 pos.Z < b->min_pos.Z || pos.Z > b->max_pos.Z)
124                         continue;
125
126                 float d_heat = heat - b->heat_point;
127                 float d_humidity = humidity - b->humidity_point;
128                 float dist = (d_heat * d_heat) + (d_humidity * d_humidity);
129
130                 if (pos.Y <= b->max_pos.Y) { // Within y limits of biome b
131                         if (dist < dist_min) {
132                                 dist_min = dist;
133                                 biome_closest = b;
134                         }
135                 } else if (dist < dist_min_blend) { // Blend area above biome b
136                         dist_min_blend = dist;
137                         biome_closest_blend = b;
138                 }
139         }
140
141         mysrand(pos.Y + (heat + humidity) / 2);
142         if (biome_closest_blend && dist_min_blend <= dist_min &&
143                         myrand_range(0, biome_closest_blend->vertical_blend) >=
144                         pos.Y - biome_closest_blend->max_pos.Y)
145                 return biome_closest_blend;
146
147         return (biome_closest) ? biome_closest : (Biome *)getRaw(BIOME_NONE);
148 }
149
150
151 ////////////////////////////////////////////////////////////////////////////////
152
153 void BiomeParamsOriginal::readParams(const Settings *settings)
154 {
155         settings->getNoiseParams("mg_biome_np_heat",           np_heat);
156         settings->getNoiseParams("mg_biome_np_heat_blend",     np_heat_blend);
157         settings->getNoiseParams("mg_biome_np_humidity",       np_humidity);
158         settings->getNoiseParams("mg_biome_np_humidity_blend", np_humidity_blend);
159 }
160
161
162 void BiomeParamsOriginal::writeParams(Settings *settings) const
163 {
164         settings->setNoiseParams("mg_biome_np_heat",           np_heat);
165         settings->setNoiseParams("mg_biome_np_heat_blend",     np_heat_blend);
166         settings->setNoiseParams("mg_biome_np_humidity",       np_humidity);
167         settings->setNoiseParams("mg_biome_np_humidity_blend", np_humidity_blend);
168 }
169
170
171 ////////////////////////////////////////////////////////////////////////////////
172
173 BiomeGenOriginal::BiomeGenOriginal(BiomeManager *biomemgr,
174         BiomeParamsOriginal *params, v3s16 chunksize)
175 {
176         m_bmgr   = biomemgr;
177         m_params = params;
178         m_csize  = chunksize;
179
180         noise_heat           = new Noise(&params->np_heat,
181                                                                         params->seed, m_csize.X, m_csize.Z);
182         noise_humidity       = new Noise(&params->np_humidity,
183                                                                         params->seed, m_csize.X, m_csize.Z);
184         noise_heat_blend     = new Noise(&params->np_heat_blend,
185                                                                         params->seed, m_csize.X, m_csize.Z);
186         noise_humidity_blend = new Noise(&params->np_humidity_blend,
187                                                                         params->seed, m_csize.X, m_csize.Z);
188
189         heatmap  = noise_heat->result;
190         humidmap = noise_humidity->result;
191         biomemap = new biome_t[m_csize.X * m_csize.Z];
192 }
193
194 BiomeGenOriginal::~BiomeGenOriginal()
195 {
196         delete []biomemap;
197
198         delete noise_heat;
199         delete noise_humidity;
200         delete noise_heat_blend;
201         delete noise_humidity_blend;
202 }
203
204 // Only usable in a mapgen thread
205 Biome *BiomeGenOriginal::calcBiomeAtPoint(v3s16 pos) const
206 {
207         float heat =
208                 NoisePerlin2D(&m_params->np_heat,       pos.X, pos.Z, m_params->seed) +
209                 NoisePerlin2D(&m_params->np_heat_blend, pos.X, pos.Z, m_params->seed);
210         float humidity =
211                 NoisePerlin2D(&m_params->np_humidity,       pos.X, pos.Z, m_params->seed) +
212                 NoisePerlin2D(&m_params->np_humidity_blend, pos.X, pos.Z, m_params->seed);
213
214         return calcBiomeFromNoise(heat, humidity, pos);
215 }
216
217
218 void BiomeGenOriginal::calcBiomeNoise(v3s16 pmin)
219 {
220         m_pmin = pmin;
221
222         noise_heat->perlinMap2D(pmin.X, pmin.Z);
223         noise_humidity->perlinMap2D(pmin.X, pmin.Z);
224         noise_heat_blend->perlinMap2D(pmin.X, pmin.Z);
225         noise_humidity_blend->perlinMap2D(pmin.X, pmin.Z);
226
227         for (s32 i = 0; i < m_csize.X * m_csize.Z; i++) {
228                 noise_heat->result[i]     += noise_heat_blend->result[i];
229                 noise_humidity->result[i] += noise_humidity_blend->result[i];
230         }
231 }
232
233
234 biome_t *BiomeGenOriginal::getBiomes(s16 *heightmap, v3s16 pmin)
235 {
236         for (s16 zr = 0; zr < m_csize.Z; zr++)
237         for (s16 xr = 0; xr < m_csize.X; xr++) {
238                 s32 i = zr * m_csize.X + xr;
239                 Biome *biome = calcBiomeFromNoise(
240                         noise_heat->result[i],
241                         noise_humidity->result[i],
242                         v3s16(pmin.X + xr, heightmap[i], pmin.Z + zr));
243
244                 biomemap[i] = biome->index;
245         }
246
247         return biomemap;
248 }
249
250
251 Biome *BiomeGenOriginal::getBiomeAtPoint(v3s16 pos) const
252 {
253         return getBiomeAtIndex(
254                 (pos.Z - m_pmin.Z) * m_csize.X + (pos.X - m_pmin.X),
255                 pos);
256 }
257
258
259 Biome *BiomeGenOriginal::getBiomeAtIndex(size_t index, v3s16 pos) const
260 {
261         return calcBiomeFromNoise(
262                 noise_heat->result[index],
263                 noise_humidity->result[index],
264                 pos);
265 }
266
267
268 Biome *BiomeGenOriginal::calcBiomeFromNoise(float heat, float humidity, v3s16 pos) const
269 {
270         Biome *biome_closest = nullptr;
271         Biome *biome_closest_blend = nullptr;
272         float dist_min = FLT_MAX;
273         float dist_min_blend = FLT_MAX;
274
275         for (size_t i = 1; i < m_bmgr->getNumObjects(); i++) {
276                 Biome *b = (Biome *)m_bmgr->getRaw(i);
277                 if (!b ||
278                                 pos.Y < b->min_pos.Y || pos.Y > b->max_pos.Y + b->vertical_blend ||
279                                 pos.X < b->min_pos.X || pos.X > b->max_pos.X ||
280                                 pos.Z < b->min_pos.Z || pos.Z > b->max_pos.Z)
281                         continue;
282
283                 float d_heat = heat - b->heat_point;
284                 float d_humidity = humidity - b->humidity_point;
285                 float dist = (d_heat * d_heat) + (d_humidity * d_humidity);
286
287                 if (pos.Y <= b->max_pos.Y) { // Within y limits of biome b
288                         if (dist < dist_min) {
289                                 dist_min = dist;
290                                 biome_closest = b;
291                         }
292                 } else if (dist < dist_min_blend) { // Blend area above biome b
293                         dist_min_blend = dist;
294                         biome_closest_blend = b;
295                 }
296         }
297
298         // Carefully tune pseudorandom seed variation to avoid single node dither
299         // and create larger scale blending patterns similar to horizontal biome
300         // blend.
301         mysrand(pos.Y + (heat + humidity) / 2);
302
303         if (biome_closest_blend && dist_min_blend <= dist_min &&
304                         myrand_range(0, biome_closest_blend->vertical_blend) >=
305                         pos.Y - biome_closest_blend->max_pos.Y)
306                 return biome_closest_blend;
307
308         return (biome_closest) ? biome_closest : (Biome *)m_bmgr->getRaw(BIOME_NONE);   
309 }
310
311
312 ////////////////////////////////////////////////////////////////////////////////
313
314 void Biome::resolveNodeNames()
315 {
316         getIdFromNrBacklog(&c_top,         "mapgen_stone",              CONTENT_AIR);
317         getIdFromNrBacklog(&c_filler,      "mapgen_stone",              CONTENT_AIR);
318         getIdFromNrBacklog(&c_stone,       "mapgen_stone",              CONTENT_AIR);
319         getIdFromNrBacklog(&c_water_top,   "mapgen_water_source",       CONTENT_AIR);
320         getIdFromNrBacklog(&c_water,       "mapgen_water_source",       CONTENT_AIR);
321         getIdFromNrBacklog(&c_river_water, "mapgen_river_water_source", CONTENT_AIR);
322         getIdFromNrBacklog(&c_riverbed,    "mapgen_stone",              CONTENT_AIR);
323         getIdFromNrBacklog(&c_dust,        "ignore",                    CONTENT_IGNORE);
324 }