More refactoring and duplicate code removal

1 files changed, 36 insertions, 0 deletions

diff --git a/src/openvic-simulation/types/Colour.hpp b/src/openvic-simulation/types/Colour.hpp
new file mode 100644
index 0000000..01f3852
--- /dev/null
+++ b/src/openvic-simulation/types/Colour.hpp
@@ -0,0 +1,36 @@
+#pragma once
+
+#include <algorithm>
+#include <cstdint>
+#include <iomanip>
+#include <sstream>
+#include <string>
+
+namespace OpenVic {
+	// Represents a 24-bit RGB integer OR a 32-bit ARGB integer
+	using colour_t = uint32_t;
+	/* When colour_t is used as an identifier, NULL_COLOUR is disallowed
+	 * and should be reserved as an error value.
+	 * When colour_t is used in a purely graphical context, NULL_COLOUR
+	 * should be allowed.
+	 */
+	static constexpr colour_t NULL_COLOUR = 0, FULL_COLOUR = 0xFF, MAX_COLOUR_RGB = 0xFFFFFF;
+	constexpr colour_t float_to_colour_byte(float f, float min = 0.0f, float max = 1.0f) {
+		return static_cast<colour_t>(std::clamp(min + f * (max - min), min, max) * 255.0f);
+	}
+	constexpr colour_t fraction_to_colour_byte(int n, int d, float min = 0.0f, float max = 1.0f) {
+		return float_to_colour_byte(static_cast<float>(n) / static_cast<float>(d), min, max);
+	}
+	constexpr colour_t float_to_alpha_value(float a) {
+		return float_to_colour_byte(a) << 24;
+	}
+	constexpr float colour_byte_to_float(colour_t colour) {
+		return std::clamp(static_cast<float>(colour) / 255.0f, 0.0f, 1.0f);
+	}
+
+	inline std::string colour_to_hex_string(colour_t colour) {
+		std::ostringstream stream;
+		stream << std::hex << std::setfill('0') << std::setw(6) << colour;
+		return stream.str();
+	}
+}