Add Generator Element Management framework
[oweals/minetest.git] / src / emerge.h
1 /*
2 Minetest
3 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
4
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.
9
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.
14
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.
18 */
19
20 #ifndef EMERGE_HEADER
21 #define EMERGE_HEADER
22
23 #include <map>
24 #include "irr_v3d.h"
25 #include "util/container.h"
26 #include "mapgen.h" // for MapgenParams
27 #include "map.h"
28
29 #define MGPARAMS_SET_MGNAME      1
30 #define MGPARAMS_SET_SEED        2
31 #define MGPARAMS_SET_WATER_LEVEL 4
32 #define MGPARAMS_SET_FLAGS       8
33
34 #define BLOCK_EMERGE_ALLOWGEN (1<<0)
35
36 #define EMERGE_DBG_OUT(x) \
37         do {                                                   \
38                 if (enable_mapgen_debug_info)                      \
39                         infostream << "EmergeThread: " x << std::endl; \
40         } while (0)
41
42 class EmergeThread;
43 class INodeDefManager;
44 class Settings;
45 //class ManualMapVoxelManipulator;
46
47 class BiomeManager;
48 class OreManager;
49 class DecorationManager;
50 class SchematicManager;
51
52 struct BlockMakeData {
53         ManualMapVoxelManipulator *vmanip;
54         u64 seed;
55         v3s16 blockpos_min;
56         v3s16 blockpos_max;
57         v3s16 blockpos_requested;
58         UniqueQueue<v3s16> transforming_liquid;
59         INodeDefManager *nodedef;
60
61         BlockMakeData():
62                 vmanip(NULL),
63                 seed(0),
64                 nodedef(NULL)
65         {}
66
67         ~BlockMakeData() { delete vmanip; }
68 };
69
70 struct BlockEmergeData {
71         u16 peer_requested;
72         u8 flags;
73 };
74
75 class EmergeManager {
76 public:
77         INodeDefManager *ndef;
78
79         std::map<std::string, MapgenFactory *> mglist;
80
81         std::vector<Mapgen *> mapgen;
82         std::vector<EmergeThread *> emergethread;
83
84         bool threads_active;
85
86         //settings
87         MapgenParams params;
88         bool mapgen_debug_info;
89         u16 qlimit_total;
90         u16 qlimit_diskonly;
91         u16 qlimit_generate;
92
93         u32 gennotify;
94
95         //// Block emerge queue data structures
96         JMutex queuemutex;
97         std::map<v3s16, BlockEmergeData *> blocks_enqueued;
98         std::map<u16, u16> peer_queue_count;
99
100         //// Managers of map generation-related components
101         BiomeManager *biomemgr;
102         OreManager *oremgr;
103         DecorationManager *decomgr;
104         SchematicManager *schemmgr;
105
106         //// Methods
107         EmergeManager(IGameDef *gamedef);
108         ~EmergeManager();
109
110         void loadMapgenParams();
111         void initMapgens();
112         Mapgen *getCurrentMapgen();
113         Mapgen *createMapgen(std::string mgname, int mgid,
114                 MapgenParams *mgparams);
115         MapgenSpecificParams *createMapgenParams(std::string mgname);
116         void startThreads();
117         void stopThreads();
118         bool enqueueBlockEmerge(u16 peer_id, v3s16 p, bool allow_generate);
119
120         void registerMapgen(std::string name, MapgenFactory *mgfactory);
121         void loadParamsFromSettings(Settings *settings);
122         void saveParamsToSettings(Settings *settings);
123
124         //mapgen helper methods
125         Biome *getBiomeAtPoint(v3s16 p);
126         int getGroundLevelAtPoint(v2s16 p);
127         bool isBlockUnderground(v3s16 blockpos);
128         u32 getBlockSeed(v3s16 p);
129 };
130
131 #endif