1 files changed, 61 insertions, 0 deletions
diff --git a/src/openvic-simulation/map/Mapmode.hpp b/src/openvic-simulation/map/Mapmode.hpp
new file mode 100644
index 0000000..fa306e9
--- /dev/null
+++ b/src/openvic-simulation/map/Mapmode.hpp
@@ -0,0 +1,61 @@
+#pragma once
+
+#include <functional>
+
+#include "openvic-simulation/types/Colour.hpp"
+#include "openvic-simulation/types/HasIdentifier.hpp"
+#include "openvic-simulation/types/IdentifierRegistry.hpp"
+
+namespace OpenVic {
+	struct MapmodeManager;
+	struct Map;
+	struct ProvinceInstance;
+
+	struct Mapmode : HasIdentifier {
+		friend struct MapmodeManager;
+
+		/* Bottom 32 bits are the base colour, top 32 are the stripe colour, both in ARGB format with the alpha channels
+		 * controlling interpolation with the terrain colour (0 = all terrain, 255 = all corresponding RGB) */
+		struct base_stripe_t {
+			colour_argb_t base_colour;
+			colour_argb_t stripe_colour;
+			constexpr base_stripe_t(colour_argb_t base, colour_argb_t stripe)
+				: base_colour { base }, stripe_colour { stripe } {}
+			constexpr base_stripe_t(colour_argb_t both) : base_stripe_t { both, both } {}
+		};
+		using colour_func_t = std::function<base_stripe_t(Map const&, ProvinceInstance const&)>;
+		using index_t = size_t;
+
+	private:
+		const index_t PROPERTY(index);
+		const colour_func_t colour_func;
+
+		Mapmode(std::string_view new_identifier, index_t new_index, colour_func_t new_colour_func);
+
+	public:
+		static const Mapmode ERROR_MAPMODE;
+
+		Mapmode(Mapmode&&) = default;
+
+		base_stripe_t get_base_stripe_colours(Map const& map, ProvinceInstance const& province) const;
+	};
+
+	struct MapmodeManager {
+	private:
+		IdentifierRegistry<Mapmode> IDENTIFIER_REGISTRY(mapmode);
+
+	public:
+		MapmodeManager() = default;
+
+		bool add_mapmode(std::string_view identifier, Mapmode::colour_func_t colour_func);
+
+		/* The mapmode colour image contains of a list of base colours and stripe colours. Each colour is four bytes
+		 * in RGBA format, with the alpha value being used to interpolate with the terrain colour, so A = 0 is fully terrain
+		 * and A = 255 is fully the RGB colour packaged with A. The base and stripe colours for each province are packed
+		 * together adjacently, so each province's entry is 8 bytes long. The list contains ProvinceDefinition::MAX_INDEX + 1
+		 * entries, that is the maximum allowed number of provinces plus one for the index-zero "null province". */
+		bool generate_mapmode_colours(Map const& map, Mapmode::index_t index, uint8_t* target) const;
+
+		bool setup_mapmodes();
+	};
+}