Refactor a major part of the project

In order to be able to save and load the map, a major rework of the code
seemed necessary, since Vector2 and Rectangle of raylib do not implement
serialize, and it seems cleanest to use the serialize/deserialize traits
of serde, to save for instance to RON. ToolShed was renamed to Editor,
since it should better show, that it does quite a bit more than harbour
tools. The map data is now centrally saved in the editor, instead of
decentralised in the tool structs.

3 files changed, 434 insertions, 0 deletions

diff --git a/src/math/mod.rs b/src/math/mod.rs
new file mode 100644
index 0000000..07d518e
--- /dev/null
+++ b/src/math/mod.rs
@@ -0,0 +1,23 @@
+pub mod rect;
+pub use self::rect::*;
+
+pub mod vec2;
+pub use self::vec2::*;
+
+/// Round a floating point number to the nearest step given by the step argument. For instance, if
+/// the step is 0.5, then all numbers from 0.0 to 0.24999... will be 0., while all numbers from
+/// 0.25 to 0.74999... will be 0.5 and so on.
+pub fn round(num: f32, step: f32) -> f32 {
+    // Only positive steps will be accepted.
+    assert!(step > 0.);
+
+    let lower_bound = ((num / step) as i32) as f32 * step;
+    let upper_bound = lower_bound + step;
+
+    // Compare the distances and prefer the smaller. If they are the same, prefer the upper bound.
+    if (num - lower_bound) < (upper_bound - num) {
+        lower_bound
+    } else {
+        upper_bound
+    }
+}
diff --git a/src/math/rect.rs b/src/math/rect.rs
new file mode 100644
index 0000000..c126d56
--- /dev/null
+++ b/src/math/rect.rs
@@ -0,0 +1,178 @@
+use super::Vec2;
+use nalgebra::{RealField, Scalar};
+use serde::{Deserialize, Serialize};
+use std::ops::{Add, AddAssign};
+
+/// Represents a Rectangle with the value type T.
+#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize)]
+pub struct Rect<T: Scalar + Copy> {
+    /// The x coordinate, or leftmost coordinate of the Rect.
+    pub x: T,
+    /// The y coordinate, or rightmost coordinate of the Rect.
+    pub y: T,
+    /// The width of the Rect.
+    pub w: T,
+    /// The height of the Rect.
+    pub h: T,
+}
+
+// This is sad, but also sadly necessary :/
+impl<T: Into<f32> + Scalar + Copy> Into<raylib::ffi::Rectangle> for Rect<T> {
+    fn into(self) -> raylib::ffi::Rectangle {
+        raylib::ffi::Rectangle {
+            x: self.x.into(),
+            y: self.y.into(),
+            width: self.w.into(),
+            height: self.h.into(),
+        }
+    }
+}
+impl<T: From<f32> + Scalar + Copy> From<raylib::ffi::Rectangle> for Rect<T> {
+    fn from(r: raylib::ffi::Rectangle) -> Self {
+        Self {
+            x: T::from(r.x),
+            y: T::from(r.y),
+            w: T::from(r.width),
+            h: T::from(r.height),
+        }
+    }
+}
+impl<T: Into<f32> + Scalar + Copy> Into<raylib::math::Rectangle> for Rect<T> {
+    fn into(self) -> raylib::math::Rectangle {
+        raylib::math::Rectangle {
+            x: self.x.into(),
+            y: self.y.into(),
+            width: self.w.into(),
+            height: self.h.into(),
+        }
+    }
+}
+impl<T: From<f32> + Scalar + Copy> From<raylib::math::Rectangle> for Rect<T> {
+    fn from(r: raylib::math::Rectangle) -> Self {
+        Self {
+            x: T::from(r.x),
+            y: T::from(r.y),
+            w: T::from(r.width),
+            h: T::from(r.height),
+        }
+    }
+}
+
+impl<T: Scalar + Copy> Rect<T> {
+    pub fn new(x: T, y: T, w: T, h: T) -> Self {
+        Self { x, y, w, h }
+    }
+
+    /// Create a Rectangle from a slice. Indices are [x, y, w, h].
+    pub fn from_slice(slice: [T; 4]) -> Rect<T>
+    where
+        T: Copy,
+    {
+        Rect {
+            x: slice[0],
+            y: slice[1],
+            w: slice[2],
+            h: slice[3],
+        }
+    }
+
+    /// Move by the Vec provided.
+    pub fn translate(&mut self, by: Vec2<T>)
+    where
+        T: AddAssign,
+    {
+        self.x += by.x;
+        self.y += by.y;
+    }
+
+    /// Set the posiotien of the rectangle to the given one without changing its
+    /// size
+    pub fn set_pos(&mut self, pos: Vec2<T>) {
+        self.x = pos.x;
+        self.y = pos.y;
+    }
+
+    /// Test if two rectangles intersect.
+    pub fn intersect<'a>(this: &'a Rect<T>, other: &'a Rect<T>) -> bool
+    where
+        T: Add<Output = T> + PartialOrd + Copy,
+    {
+        !(this.x > other.x + other.w
+            || this.x + this.w < other.x
+            || this.y > other.y + other.h
+            || this.y + this.h < other.y)
+    }
+
+    /// Check if the point is inside this Rect and return true if so.
+    pub fn contains(&self, point: Vec2<T>) -> bool
+    where
+        T: PartialOrd + Add<Output = T>,
+    {
+        point.x >= self.x
+            && point.x <= self.x + self.w
+            && point.y >= self.y
+            && point.y <= self.y + self.h
+    }
+
+    /// Function to calculate the bounding rectangle that is between two vectors. The order of the
+    /// vectors is irrelevent for this. As long as they are diagonally opposite of each other, this
+    /// function will work.
+    pub fn bounding_rect(pos1: Vec2<T>, pos2: Vec2<T>) -> Self
+    where
+        T: RealField,
+    {
+        let min_x = pos1.x.min(pos2.x);
+        let min_y = pos1.y.min(pos2.y);
+        let max_x = pos1.x.max(pos2.x);
+        let max_y = pos1.y.max(pos2.y);
+
+        Self {
+            x: min_x,
+            y: min_y,
+            w: max_x - min_x,
+            h: max_y - min_y,
+        }
+    }
+
+    /// Get the shortest way that must be applied to this Rect to clear out of
+    /// another Rect of the same type so that they would not intersect any more.
+    pub fn shortest_way_out(&self, of: &Rect<T>) -> Vec2<T>
+    where
+        T: RealField,
+    {
+        // Check upwards
+        let mut move_y = of.y - self.y - self.h;
+        // Check downwards
+        let move_down = of.y + of.h - self.y;
+        if move_down < -move_y {
+            move_y = move_down;
+        }
+
+        // Check left
+        let mut move_x = of.x - self.x - self.w;
+        // Check right
+        let move_right = of.x + of.w - self.x;
+        if move_right < -move_x {
+            move_x = move_right;
+        }
+
+        if move_x.abs() < move_y.abs() {
+            Vec2::new(move_x, T::zero())
+        } else {
+            Vec2::new(T::zero(), move_y)
+        }
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_intersect() {
+        let a = Rect::from_slice([0, 0, 4, 4]);
+        let b = Rect::from_slice([-1, -1, 1, 1]);
+
+        assert!(Rect::intersect(&a, &b));
+    }
+}
diff --git a/src/math/vec2.rs b/src/math/vec2.rs
new file mode 100644
index 0000000..ea549d7
--- /dev/null
+++ b/src/math/vec2.rs
@@ -0,0 +1,233 @@
+use crate::math::Rect;
+use alga::general::{ClosedAdd, ClosedSub};
+use nalgebra::{RealField, Scalar};
+use serde::{Deserialize, Serialize};
+use std::cmp::Ordering;
+use std::convert::{From, Into};
+use std::fmt;
+use std::ops::{Add, AddAssign, Div, Mul, Sub, SubAssign};
+
+#[derive(Clone, Copy, Debug, Default, PartialEq, PartialOrd, Serialize, Deserialize, Eq)]
+pub struct Vec2<T: Scalar + Copy> {
+    pub x: T,
+    pub y: T,
+}
+
+impl<T: Scalar + Copy> Vec2<T> {
+    pub fn new(x: T, y: T) -> Self {
+        Self { x, y }
+    }
+
+    pub fn len(&self) -> T
+    where
+        T: RealField,
+    {
+        (self.x * self.x + self.y * self.y).sqrt()
+    }
+}
+
+// This is sad, but also sadly necessary :/
+impl<T> Into<raylib::ffi::Vector2> for Vec2<T>
+where
+    T: Into<f32> + Scalar + Copy,
+{
+    fn into(self) -> raylib::ffi::Vector2 {
+        raylib::ffi::Vector2 {
+            x: self.x.into(),
+            y: self.y.into(),
+        }
+    }
+}
+
+impl<T> From<raylib::ffi::Vector2> for Vec2<T>
+where
+    T: From<f32> + Scalar + Copy,
+{
+    fn from(v: raylib::ffi::Vector2) -> Self {
+        Self {
+            x: T::from(v.x),
+            y: T::from(v.y),
+        }
+    }
+}
+impl<T: Scalar + Copy> Into<raylib::math::Vector2> for Vec2<T>
+where
+    T: Into<f32>,
+{
+    fn into(self) -> raylib::math::Vector2 {
+        raylib::math::Vector2 {
+            x: self.x.into(),
+            y: self.y.into(),
+        }
+    }
+}
+
+impl<T: Scalar + Copy> From<raylib::math::Vector2> for Vec2<T>
+where
+    T: From<f32>,
+{
+    fn from(v: raylib::math::Vector2) -> Self {
+        Self {
+            x: T::from(v.x),
+            y: T::from(v.y),
+        }
+    }
+}
+
+// Begin mathematical operators -----------------------------------------------
+
+// Addition
+impl<T: Scalar + ClosedAdd + Copy> Add for Vec2<T> {
+    type Output = Self;
+
+    fn add(self, rhs: Self) -> Self {
+        Vec2::new(self.x + rhs.x, self.y + rhs.y)
+    }
+}
+
+impl<T: Scalar + ClosedAdd + Copy> Add<(T, T)> for Vec2<T> {
+    type Output = Self;
+
+    fn add(self, (x, y): (T, T)) -> Self {
+        Vec2::new(self.x + x, self.y + y)
+    }
+}
+
+impl<T: Scalar + ClosedAdd + Copy> Add<T> for Vec2<T> {
+    type Output = Self;
+
+    fn add(self, rhs: T) -> Self {
+        Vec2::new(self.x + rhs, self.y + rhs)
+    }
+}
+
+impl<T: Scalar + AddAssign + Copy> AddAssign for Vec2<T> {
+    fn add_assign(&mut self, rhs: Self) {
+        self.x += rhs.x;
+        self.y += rhs.y;
+    }
+}
+
+impl<T: Scalar + AddAssign + Copy> AddAssign<(T, T)> for Vec2<T> {
+    fn add_assign(&mut self, (x, y): (T, T)) {
+        self.x += x;
+        self.y += y;
+    }
+}
+
+// Subtraction
+impl<T: Scalar + ClosedSub + Copy> Sub for Vec2<T> {
+    type Output = Self;
+
+    fn sub(self, rhs: Self) -> Self {
+        Vec2::new(self.x - rhs.x, self.y - rhs.y)
+    }
+}
+
+impl<T: Scalar + ClosedSub + Copy> Sub<(T, T)> for Vec2<T> {
+    type Output = Self;
+
+    fn sub(self, (x, y): (T, T)) -> Self {
+        Vec2::new(self.x - x, self.y - y)
+    }
+}
+
+impl<T: Scalar + ClosedSub + Copy> Sub<T> for Vec2<T> {
+    type Output = Self;
+
+    fn sub(self, rhs: T) -> Self {
+        Vec2::new(self.x - rhs, self.y - rhs)
+    }
+}
+
+impl<T: Scalar + SubAssign + Copy> SubAssign for Vec2<T> {
+    fn sub_assign(&mut self, rhs: Self) {
+        self.x -= rhs.x;
+        self.y -= rhs.y;
+    }
+}
+
+impl<T: Scalar + SubAssign + Copy> SubAssign<(T, T)> for Vec2<T> {
+    fn sub_assign(&mut self, (x, y): (T, T)) {
+        self.x -= x;
+        self.y -= y;
+    }
+}
+
+// Scalar multiplication
+impl<T: Scalar + Add<Output = T> + Mul<Output = T> + Copy> Mul for Vec2<T> {
+    type Output = T;
+
+    fn mul(self, rhs: Self) -> T {
+        self.x * rhs.x + self.y * rhs.y
+    }
+}
+
+impl<T: Scalar + Mul<Output = T> + Copy> Mul<T> for Vec2<T> {
+    type Output = Self;
+
+    fn mul(self, rhs: T) -> Self {
+        Vec2::new(self.x * rhs, self.y * rhs)
+    }
+}
+
+impl<T: Scalar + Div<Output = T> + Copy> Div<T> for Vec2<T> {
+    type Output = Self;
+
+    fn div(self, rhs: T) -> Self {
+        Vec2::new(self.x / rhs, self.y / rhs)
+    }
+}
+
+// End of mathematical operators ----------------------------------------------
+
+// By default, the coordinates are first compared by their y-coordinates, then
+// their x-coordinates
+impl<T: fmt::Debug> Ord for Vec2<T>
+where
+    T: Ord + Copy + 'static,
+{
+    fn cmp(&self, other: &Self) -> Ordering {
+        match self.y.cmp(&other.y) {
+            Ordering::Equal => self.x.cmp(&other.x),
+            y_order => y_order,
+        }
+    }
+}
+
+// Helper function to determine the absolute positive difference between two
+// Values, which don't have to be signed.
+fn difference_abs<T>(a: T, b: T) -> T
+where
+    T: ClosedSub + PartialOrd,
+{
+    if a > b {
+        a - b
+    } else {
+        b - a
+    }
+}
+
+// Helper function that removes all points inside the vector that are not
+// contained inside the optional limit Rect
+fn retain_inside_limits<T: 'static>(items: Vec<Vec2<T>>, limits: Option<Rect<T>>) -> Vec<Vec2<T>>
+where
+    T: PartialOrd + std::fmt::Debug + Copy + Add<Output = T>,
+{
+    // Fast return in case there are no limits
+    if limits.is_none() {
+        return items;
+    }
+    let limits = limits.unwrap();
+
+    // Retain only items that are within the bounds of the limits rect
+    items
+        .into_iter()
+        .filter(|v| {
+            v.x >= limits.x
+                && v.x <= limits.x + limits.w
+                && v.y >= limits.y
+                && v.y <= limits.y + limits.h
+        })
+        .collect()
+}