egui_map_view/layers/

mod.rs

//! Layers for the map view that can handle input, and draw on top of the map view different kinds of data.
//!
use egui::{Painter, Pos2, Response};
use std::any::Any;

use crate::projection::MapProjection;

/// GeoJSON serialization and deserialization for layers.
#[cfg(feature = "geojson")]
pub mod geojson;

/// Drawing layer
#[cfg(feature = "drawing-layer")]
pub mod drawing;

/// Text layer
#[cfg(feature = "text-layer")]
pub mod text;

/// SVG layer
#[cfg(feature = "svg-layer")]
pub mod svg;

/// Area layer
#[cfg(feature = "area-layer")]
pub mod area;

// Tile layer
#[cfg(feature = "tile-layer")]
pub mod tile;

/// A module for serializing and deserializing `Color32` to and from hex strings.
pub(crate) mod serde_color32 {
    use egui::Color32;
    use serde::{self, Deserialize, Deserializer, Serializer};

    /// Serializes a `Color32` to a hex string.
    pub fn serialize<S>(color: &Color32, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&color.to_hex())
    }

    /// Deserializes a `Color32` from a hex string.
    pub fn deserialize<'de, D>(deserializer: D) -> Result<Color32, D::Error>
    where
        D: Deserializer<'de>,
    {
        let s = <String as Deserialize>::deserialize(deserializer)?;
        Color32::from_hex(&s).map_err(|err| serde::de::Error::custom(format!("{err:?}")))
    }
}

/// A module for serializing and deserializing `egui::Stroke`.
pub(crate) mod serde_stroke {
    use crate::layers::serde_color32;
    use egui::{Color32, Stroke};
    use serde::{self, Deserialize, Deserializer, Serialize, Serializer};

    #[derive(Serialize, Deserialize)]
    struct StrokeHelper {
        width: f32,
        #[serde(with = "serde_color32")]
        color: Color32,
    }

    pub fn serialize<S>(stroke: &Stroke, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let helper = StrokeHelper {
            width: stroke.width,
            color: stroke.color,
        };
        helper.serialize(serializer)
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<Stroke, D::Error>
    where
        D: Deserializer<'de>,
    {
        let helper = StrokeHelper::deserialize(deserializer)?;
        Ok(Stroke {
            width: helper.width,
            color: helper.color,
        })
    }
}

/// A trait for map layers.
pub trait Layer: Any {
    /// Handles user input for the layer. Returns `true` if the input was handled and should not be
    /// processed further by the map.
    fn handle_input(&mut self, response: &Response, projection: &MapProjection) -> bool;

    /// Draws the layer.
    fn draw(&self, painter: &Painter, projection: &MapProjection);

    /// Gets the layer as a `dyn Any`.
    fn as_any(&self) -> &dyn Any;

    /// Gets the layer as a mutable `dyn Any`.
    fn as_any_mut(&mut self) -> &mut dyn Any;

    /// The opacity of the layer, from 0.0 (completely transparent) to 1.0 (completely opaque).
    fn opacity(&self) -> f32 {
        1.0
    }

    /// Sets the opacity of the layer.
    fn set_opacity(&mut self, _opacity: f32) {}
}

/// A helper function for `serde` to provide a default opacity of 1.0.
pub fn default_opacity() -> f32 {
    1.0
}

/// Calculates the squared distance from a point to a line segment.
pub(crate) fn dist_sq_to_segment(p: Pos2, a: Pos2, b: Pos2) -> f32 {
    let ab = b - a;
    let ap = p - a;
    let l2 = ab.length_sq();

    if l2 == 0.0 {
        // The segment is a point.
        return ap.length_sq();
    }

    // Project point p onto the line defined by a and b.
    // `t` is the normalized distance from a to the projection.
    let t = (ap.dot(ab) / l2).clamp(0.0, 1.0);

    // The closest point on the line segment.
    let closest_point = a + t * ab;

    p.distance_sq(closest_point)
}

/// Calculates the projection factor of a point onto a line segment.
/// Returns a value `t` from 0.0 to 1.0.
pub(crate) fn projection_factor(p: Pos2, a: Pos2, b: Pos2) -> f32 {
    let ab = b - a;
    let ap = p - a;
    let l2 = ab.length_sq();

    if l2 == 0.0 {
        return 0.0;
    }

    // Project point p onto the line defined by a and b.
    (ap.dot(ab) / l2).clamp(0.0, 1.0)
}

/// Checks if two line segments intersect.
pub(crate) fn segments_intersect(p1: Pos2, q1: Pos2, p2: Pos2, q2: Pos2) -> bool {
    fn orientation(p: Pos2, q: Pos2, r: Pos2) -> i8 {
        let val = (q.y - p.y) * (r.x - q.x) - (q.x - p.x) * (r.y - q.y);
        if val.abs() < 1e-6 {
            0 // Collinear
        } else if val > 0.0 {
            1 // Clockwise
        } else {
            -1 // Counter-clockwise
        }
    }

    let o1 = orientation(p1, q1, p2);
    let o2 = orientation(p1, q1, q2);
    let o3 = orientation(p2, q2, p1);
    let o4 = orientation(p2, q2, q1);

    // General case: segments cross each other.
    if o1 != o2 && o3 != o4 {
        return true;
    }

    // Special cases for collinear points are ignored for simplicity,
    // as they are less critical for this UI interaction.
    false
}

#[cfg(test)]
mod tests {
    use super::*;
    use egui::pos2;

    const EPSILON: f32 = 1e-6;

    #[test]
    fn test_dist_sq_to_segment() {
        let a = pos2(0.0, 0.0);
        let b = pos2(10.0, 0.0);

        // Point on the segment
        let p1 = pos2(5.0, 0.0);
        assert!((dist_sq_to_segment(p1, a, b) - 0.0).abs() < EPSILON);

        // Point off the segment, projection is on the segment
        let p2 = pos2(5.0, 5.0);
        assert!((dist_sq_to_segment(p2, a, b) - 25.0).abs() < EPSILON); // 5*5

        // Point off the segment, projection is before 'a'
        let p3 = pos2(-5.0, 5.0);
        assert!((dist_sq_to_segment(p3, a, b) - 50.0).abs() < EPSILON); // dist^2 from (-5,5) to (0,0) is 25+25 = 50

        // Point off the segment, projection is after 'b'
        let p4 = pos2(15.0, 5.0);
        assert!((dist_sq_to_segment(p4, a, b) - 50.0).abs() < EPSILON); // dist^2 from (15,5) to (10,0) is 25+25 = 50

        // Zero-length segment
        let c = pos2(5.0, 5.0);
        let p5 = pos2(10.0, 10.0);
        assert!((dist_sq_to_segment(p5, c, c) - 50.0).abs() < EPSILON); // dist^2 from (10,10) to (5,5) is 25+25 = 50
    }

    #[test]
    fn test_layer_opacity_defaults() {
        struct MockLayer;
        impl Layer for MockLayer {
            fn handle_input(&mut self, _: &Response, _: &MapProjection) -> bool {
                false
            }
            fn draw(&self, _: &Painter, _: &MapProjection) {}
            fn as_any(&self) -> &dyn Any {
                self
            }
            fn as_any_mut(&mut self) -> &mut dyn Any {
                self
            }
        }

        let mut layer = MockLayer;
        assert_eq!(layer.opacity(), 1.0);
        layer.set_opacity(0.5);
        // Default implementation does nothing, so it should still be 1.0
        assert_eq!(layer.opacity(), 1.0);
    }

    #[test]
    fn test_projection_factor() {
        let a = pos2(0.0, 0.0);
        let b = pos2(10.0, 0.0);

        // Point is 'a'
        assert!((projection_factor(a, a, b) - 0.0).abs() < EPSILON);

        // Point is 'b'
        assert!((projection_factor(b, a, b) - 1.0).abs() < EPSILON);

        // Point is midpoint
        let p1 = pos2(5.0, 0.0);
        assert!((projection_factor(p1, a, b) - 0.5).abs() < EPSILON);

        // Point projects to midpoint
        let p2 = pos2(5.0, 5.0);
        assert!((projection_factor(p2, a, b) - 0.5).abs() < EPSILON);

        // Point projects before 'a' (clamped)
        let p3 = pos2(-5.0, 5.0);
        assert!((projection_factor(p3, a, b) - 0.0).abs() < EPSILON);

        // Point projects after 'b' (clamped)
        let p4 = pos2(15.0, 5.0);
        assert!((projection_factor(p4, a, b) - 1.0).abs() < EPSILON);

        // Zero-length segment
        let c = pos2(5.0, 5.0);
        let p5 = pos2(10.0, 10.0);
        assert!((projection_factor(p5, c, c) - 0.0).abs() < EPSILON);
    }

    #[test]
    fn test_segments_intersect() {
        // General intersection
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(10.0, 10.0);
        let p2 = pos2(0.0, 10.0);
        let q2 = pos2(10.0, 0.0);
        assert!(segments_intersect(p1, q1, p2, q2), "General intersection");

        // No intersection, parallel
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(10.0, 0.0);
        let p2 = pos2(0.0, 5.0);
        let q2 = pos2(10.0, 5.0);
        assert!(
            !segments_intersect(p1, q1, p2, q2),
            "Parallel, no intersection"
        );

        // No intersection, not parallel
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(1.0, 1.0);
        let p2 = pos2(2.0, 2.0);
        let q2 = pos2(3.0, 0.0);
        assert!(
            !segments_intersect(p1, q1, p2, q2),
            "Not parallel, no intersection"
        );

        // T-junction
        let p1 = pos2(0.0, 5.0);
        let q1 = pos2(10.0, 5.0);
        let p2 = pos2(5.0, 0.0);
        let q2 = pos2(5.0, 5.0);
        assert!(segments_intersect(p1, q1, p2, q2), "T-junction");

        // Segments meeting at an endpoint
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(5.0, 5.0);
        let p2 = pos2(5.0, 5.0);
        let q2 = pos2(10.0, 0.0);
        assert!(segments_intersect(p1, q1, p2, q2), "Meeting at an endpoint");

        // Collinear, overlapping
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(10.0, 0.0);
        let p2 = pos2(5.0, 0.0);
        let q2 = pos2(15.0, 0.0);
        assert!(
            !segments_intersect(p1, q1, p2, q2),
            "Collinear, overlapping"
        );

        // Collinear, non-overlapping
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(10.0, 0.0);
        let p2 = pos2(11.0, 0.0);
        let q2 = pos2(20.0, 0.0);
        assert!(
            !segments_intersect(p1, q1, p2, q2),
            "Collinear, non-overlapping"
        );

        // Collinear, one contains another
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(10.0, 0.0);
        let p2 = pos2(2.0, 0.0);
        let q2 = pos2(8.0, 0.0);
        assert!(!segments_intersect(p1, q1, p2, q2), "Collinear, contained");

        // One segment is a point on the other segment
        let p1 = pos2(0.0, 0.0);
        let q1 = pos2(10.0, 0.0);
        let p2 = pos2(5.0, 0.0);
        let q2 = pos2(5.0, 0.0);
        assert!(!segments_intersect(p1, q1, p2, q2), "Point on segment");
    }
}