assets/interlocking.html.LyXconv/interlocking.idv

/*
Minetest
Copyright (C) 2015-2020 paramat
Copyright (C) 2010-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#pragma once

#define VMANIP_FLAG_CAVE VOXELFLAG_CHECKED1

typedef u16 biome_t;  // copy from mg_biome.h to avoid an unnecessary include

class GenerateNotifier;

/*
	CavesNoiseIntersection is a cave digging algorithm that carves smooth,
	web-like, continuous tunnels at points where the density of the intersection
	between two separate 3d noises is above a certain value.  This value,
	cave_width, can be modified to set the effective width of these tunnels.

	This algorithm is relatively heavyweight, taking ~80ms to generate an
	80x80x80 chunk of map on a modern processor.  Use sparingly!

	TODO(hmmmm): Remove dependency on biomes
	TODO(hmmmm): Find alternative to overgeneration as solution for sunlight issue
*/
class CavesNoiseIntersection
{
public:
	CavesNoiseIntersection(const NodeDefManager *nodedef,
		BiomeManager *biomemgr, v3s16 chunksize, NoiseParams *np_cave1,
		NoiseParams *np_cave2, s32 seed, float cave_width);
	~CavesNoiseIntersection();

	void generateCaves(MMVManip *vm, v3s16 nmin, v3s16 nmax, biome_t *biomemap);

private:
	const NodeDefManager *m_ndef;
	BiomeManager *m_bmgr;

	// configurable parameters
	v3s16 m_csize;
	float m_cave_width;

	// intermediate state variables
	u16 m_ystride;
	u16 m_zstride_1d;

	Noise *noise_cave1;
	Noise *noise_cave2;
};

/*
	CavernsNoise is a cave digging algorithm
*/
class CavernsNoise
{
public:
	CavernsNoise(const NodeDefManager *nodedef, v3s16 chunksize,
		NoiseParams *np_cavern, s32 seed, float cavern_limit,
		float cavern_taper, float cavern_threshold);
	~CavernsNoise();

	bool generateCaverns(MMVManip *vm, v3s16 nmin, v3s16 nmax);

private:
	const NodeDefManager *m_ndef;

	// configurable parameters
	v3s16 m_csize;
	float m_cavern_limit;
	float m_cavern_taper;
	float m_cavern_threshold;

	// intermediate state variables
	u16 m_ystride;
	u16 m_zstride_1d;

	Noise *noise_cavern;

	content_t c_water_source;
	content_t c_lava_source;
};

/*
	CavesRandomWalk is an implementation of a cave-digging algorithm that
	operates on the principle of a "random walk" to approximate the stochiastic
	activity of cavern development.

	In summary, this algorithm works by carving a randomly sized tunnel in a
	random direction a random amount of times, randomly varying in width.
	All randomness here is uniformly distributed; alternative distributions have
	not yet been implemented.

	This algorithm is very fast, executing in less than 1ms on average for an
	80x80x80 chunk of map on a modern processor.
*/
class CavesRandomWalk
{
public:
	MMVManip *vm;
	const NodeDefManager *ndef;
	GenerateNotifier *gennotify;
	s16 *heightmap;
	BiomeGen *bmgn;

	s32 seed;
	int water_level;
	float large_cave_flooded;
	// TODO 'np_caveliquids' is deprecated and should eventually be removed.
	// Cave liquids are now defined and located using biome definitions.
	NoiseParams *np_caveliquids;

	u16 ystride;

	s16 min_tunnel_diameter;
	s16 max_tunnel_diameter;
	u16 tunnel_routepoints;
	int part_max_length_rs;

	bool large_cave;
	bool large_cave_is_flat;
	bool flooded;
	bool use_biome_liquid;

	v3s16 node_min;
	v3s16 node_max;

	v3f orp;  // starting point, relative to caved space
	v3s16 of; // absolute coordinates of caved space
	v3s16 ar; // allowed route area
	s16 rs;   // tunnel radius size
	v3f main_direction;

	s16 route_y_min;
	s16 route_y_max;

	PseudoRandom *ps;

	content_t c_water_source;
	content_t c_lava_source;
	content_t c_biome_liquid;

	// ndef is a mandatory parameter.
	// If gennotify is NULL, generation events are not logged.
	// If biomegen is NULL, cave liquids have classic behaviour.
	CavesRandomWalk(const NodeDefManager *ndef, GenerateNotifier *gennotify =
		NULL, s32 seed = 0, int water_level = 1, content_t water_source =
		CONTENT_IGNORE, content_t lava_source = CONTENT_IGNORE,
		float large_cave_flooded = 0.5f, BiomeGen *biomegen = NULL);

	// vm and ps are mandatory parameters.
	// If heightmap is NULL, the surface level at all points is assumed to
	// be water_level.
	void makeCave(MMVManip *vm, v3s16 nmin, v3s16 nmax, PseudoRandom *ps,
			bool is_large_cave, int max_stone_height, s16 *heightmap);

private:
	void makeTunnel(bool dirswitch);
	void carveRoute(v3f vec, float f, bool randomize_xz);

	inline bool isPosAboveSurface(v3s16 p);
};

/*
	CavesV6 is the original version of caves used with Mapgen V6.

	Though it uses the same fundamental algorithm as CavesRandomWalk, it is made
	separate to preserve the exact sequence of PseudoRandom calls - any change
	to this ordering results in the output being radically different.
	Because caves in Mapgen V6 are responsible for a large portion of the basic
	terrain shape, modifying this will break our contract of reverse
	compatibility for a 'stable' mapgen such as V6.

	tl;dr,
	*** DO NOT TOUCH THIS CLASS UNLESS YOU KNOW WHAT YOU ARE DOING ***
*/
class CavesV6
{
public:
	MMVManip *vm;
	const NodeDefManager *ndef;
	GenerateNotifier *gennotify;
	PseudoRandom *ps;
	PseudoRandom *ps2;

	// configurable parameters
	s16 *heightmap;
	content_t c_water_source;
	content_t c_lava_source;
	int water_level;

	// intermediate state variables
	u16 ystride;

	s16 min_tunnel_diameter;
	s16 max_tunnel_diameter;
	u16 tunnel_routepoints;
	int part_max_length_rs;

	bool large_cave;
	bool large_cave_is_flat;

	v3s16 node_min;
	v3s16 node_max;

	v3f orp;  // starting point, relative to caved space
	v3s16 of; // absolute coordinates of caved space
	v3s16 ar; // allowed route area
	s16 rs;   // tunnel radius size
	v3f main_direction;

	s16 route_y_min;
	s16 route_y_max;

	// ndef is a mandatory parameter.
	// If gennotify is NULL, generation events are not logged.
	CavesV6(const NodeDefManager *ndef, GenerateNotifier *gennotify = NULL,
			int water_level = 1, content_t water_source = CONTENT_IGNORE,
			content_t lava_source = CONTENT_IGNORE);
ofs	hex dump	ascii
0000	f7 02 01 83 92 c0 1c 3b 00 00 00 00 03 e8 1b 20 54 65 58 20 6f 75 74 70 75 74 20 32 30 31 38 2e	.......;........TeX.output.2018.
0020	31 30 2e 31 35 3a 32 32 30 34 8b 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00	10.15:2204......................
0040	00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ff ff ff ff 8d 92 00 00 00 00 a0 00 00	................................
0060	00 00 f2 00 00 00 1f 70 61 70 65 72 73 69 7a 65 3d 36 31 34 2e 32 39 35 70 74 2c 37 39 34 2e 39	.......papersize=614.295pt,794.9
0080	36 39 39 39 70 74 f2 00 00 00 1f 70 61 70 65 72 73 69 7a 65 3d 36 31 34 2e 32 39 35 70 74 2c 37	6999pt.....papersize=614.295pt,7
00a0	39 34 2e 39 36 39 39 39 70 74 f3 0e 0c 31 ea b1 00 0a 00 00 00 0a 00 00 00 08 65 63 72 6d 31 30	94.96999pt...1............ecrm10
00c0	30 30 b9 f3 11 13 d1 4e 3c 00 11 47 ae 00 11 47 ae 00 08 65 63 73 78 31 37 32 38 bc f3 18 c4 4e	00.....N<..G...G...ecsx1728....N
00e0	bd bf 00 0e 66 66 00 0e 66 66 00 08 65 63 73 74 31 34 34 30 c3 f3 1b 00 02 7d 15 00 0c 00 00 00	....ff..ff..ecst1440.....}......
0100	0c 00 00 00 08 65 63 73 78 31 32 30 30 c6 b9 c6 b9 c6 b9 c6 f3 1d bb 79 26 b3 00 0a 00 00 00 0a	.....ecsx1200..........y&.......
0120	00 00 00 08 65 63 73 78 31 30 30 30 c8 b9 c8 b9 c8 b9 c8 b9 c6 b9 c6 b9 b9 c6 b9 c6 b9 c6 b9 b9	....ecsx1000....................
0140	f3 1e 02 5d 66 8c 00 0a 00 00 00 0a 00 00 00 08 65 63 62 78 31 30 30 30 c9 b9 c6 b9 b9 c6 c9 b9	...]f...........ecbx1000........
0160	f3 1f bd 48 d0 83 00 0a 00 00 00 0a 00 00 00 08 65 63 74 69 31 30 30 30 ca b9 c6 b9 c6 b9 b9 f3	...H............ecti1000........
0180	20 71 4c 06 cb 00 0a 00 00 00 0a 00 00 00 08 65 63 74 74 31 30 30 30 cb b9 c6 b9 b9 c6 b9 c6 b9	.qL............ectt1000.........
01a0	c6 b9 c6 b9 8e 8c f8 00 00 00 2a 01 83 92 c0 1c 3b 00 00 00 00 03 e8 02 d4 3f 4c 02 2d 63 b7 00	..........*.....;........?L.-c..
01c0	08 00 01 f3 20 71 4c 06 cb 00 0a 00 00 00 0a 00 00 00 08 65 63 74 74 31 30 30 30 f3 1f bd 48 d0	.....qL............ectt1000...H.
01e0	83 00 0a 00 00 00 0a 00 00 00 08 65 63 74 69 31 30 30 30 f3 1e 02 5d 66 8c 00 0a 00 00 00 0a 00	...........ecti1000...]f........
0200	00 00 08 65 63 62 78 31 30 30 30 f3 1d bb 79 26 b3 00 0a 00 00 00 0a 00 00 00 08 65 63 73 78 31	...ecbx1000...y&...........ecsx1
0220	30 30 30 f3 1b 00 02 7d 15 00 0c 00 00 00 0c 00 00 00 08 65 63 73 78 31 32 30 30 f3 18 c4 4e bd	000....}...........ecsx1200...N.
0240	bf 00 0e 66 66 00 0e 66 66 00 08 65 63 73 74 31 34 34 30 f3 11 13 d1 4e 3c 00 11 47 ae 00 11 47	...ff..ff..ecst1440....N<..G...G
0260	ae 00 08 65 63 73 78 31 37 32 38 f3 0e 0c 31 ea b1 00 0a 00 00 00 0a 00 00 00 08 65 63 72 6d 31	...ecsx1728...1............ecrm1
0280	30 30 30 f9 00 00 01 a6 02 df df df df df df df df	000..............