rustial-engine 0.0.1

Framework-agnostic 2.5D map engine for rustial
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Flat georeferenced colour grid overlay layer.

use std::any::Any;

use super::{ColorRamp, GeoGrid, ScalarField2D};
use crate::layer::{Layer, LayerId, LayerKind};

/// A flat georeferenced colour grid overlay.
///
/// Each grid cell is coloured by evaluating the [`ColorRamp`] at the
/// cell's normalised [`ScalarField2D`] value.
///
/// This layer participates in the standard `MapState::pick` system:
/// a geographic pick query resolves to the grid cell via
/// [`GeoGrid::cell_at_geo`] and returns the cell index and scalar
/// value in the [`PickHit`](crate::picking::PickHit) result.
#[derive(Debug, Clone)]
pub struct GridScalarLayer {
    id: LayerId,
    name: String,
    visible: bool,
    opacity: f32,
    z_index: i32,
    /// Grid geometry.
    pub grid: GeoGrid,
    /// Scalar field values.
    pub field: ScalarField2D,
    /// Colour transfer function.
    pub ramp: ColorRamp,
}

impl GridScalarLayer {
    /// Create a new grid scalar layer.
    pub fn new(
        name: impl Into<String>,
        grid: GeoGrid,
        field: ScalarField2D,
        ramp: ColorRamp,
    ) -> Self {
        Self {
            id: LayerId::next(),
            name: name.into(),
            visible: true,
            opacity: 1.0,
            z_index: 0,
            grid,
            field,
            ramp,
        }
    }

    /// Replace the scalar field values (value-only update).
    pub fn update_field(&mut self, data: Vec<f32>) {
        self.field.update_values(data);
    }
}

impl Layer for GridScalarLayer {
    fn id(&self) -> LayerId {
        self.id
    }

    fn name(&self) -> &str {
        &self.name
    }

    fn kind(&self) -> LayerKind {
        LayerKind::Visualization
    }

    fn visible(&self) -> bool {
        self.visible
    }

    fn set_visible(&mut self, visible: bool) {
        self.visible = visible;
    }

    fn opacity(&self) -> f32 {
        self.opacity
    }

    fn set_opacity(&mut self, opacity: f32) {
        self.opacity = opacity.clamp(0.0, 1.0);
    }

    fn z_index(&self) -> i32 {
        self.z_index
    }

    fn as_any(&self) -> &dyn Any {
        self
    }

    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::visualization::ColorStop;
    use rustial_math::GeoCoord;

    fn test_ramp() -> ColorRamp {
        ColorRamp::new(vec![
            ColorStop {
                value: 0.0,
                color: [0.0, 0.0, 1.0, 1.0],
            },
            ColorStop {
                value: 1.0,
                color: [1.0, 0.0, 0.0, 1.0],
            },
        ])
    }

    #[test]
    fn grid_scalar_layer_basics() {
        let grid = GeoGrid::new(GeoCoord::from_lat_lon(0.0, 0.0), 4, 4, 100.0, 100.0);
        let field = ScalarField2D::from_data(4, 4, vec![0.0; 16]);
        let layer = GridScalarLayer::new("density", grid, field, test_ramp());
        assert_eq!(layer.name(), "density");
        assert!(layer.visible());
        assert!((layer.opacity() - 1.0).abs() < f32::EPSILON);
        assert_eq!(layer.kind(), LayerKind::Visualization);
    }

    #[test]
    fn grid_scalar_layer_id_stable() {
        let grid = GeoGrid::new(GeoCoord::from_lat_lon(0.0, 0.0), 2, 2, 10.0, 10.0);
        let field = ScalarField2D::from_data(2, 2, vec![1.0; 4]);
        let layer = GridScalarLayer::new("test", grid, field, test_ramp());
        assert_eq!(layer.id(), layer.id());
    }

    #[test]
    fn grid_scalar_layer_downcast() {
        let grid = GeoGrid::new(GeoCoord::from_lat_lon(0.0, 0.0), 2, 2, 10.0, 10.0);
        let field = ScalarField2D::from_data(2, 2, vec![1.0; 4]);
        let layer: Box<dyn Layer> =
            Box::new(GridScalarLayer::new("test", grid, field, test_ramp()));
        assert!(layer.as_any().downcast_ref::<GridScalarLayer>().is_some());
    }

    #[test]
    fn update_field_bumps_value_generation() {
        let grid = GeoGrid::new(GeoCoord::from_lat_lon(0.0, 0.0), 2, 2, 10.0, 10.0);
        let field = ScalarField2D::from_data(2, 2, vec![0.0; 4]);
        let mut layer = GridScalarLayer::new("test", grid, field, test_ramp());
        assert_eq!(layer.field.value_generation, 0);
        layer.update_field(vec![1.0; 4]);
        assert_eq!(layer.field.value_generation, 1);
    }
}