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

//! Extruded georeferenced grid overlay layer.

use std::any::Any;

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

/// An extruded georeferenced grid overlay.
///
/// Each grid cell is rendered as an extruded prism (box) with height
/// proportional to the scalar value multiplied by
/// [`ExtrusionParams::height_scale`].
#[derive(Debug, Clone)]
pub struct GridExtrusionLayer {
    id: LayerId,
    name: String,
    visible: bool,
    opacity: f32,
    z_index: i32,
    /// Grid geometry.
    pub grid: GeoGrid,
    /// Scalar field values driving extrusion height.
    pub field: ScalarField2D,
    /// Colour transfer function.
    pub ramp: ColorRamp,
    /// Extrusion parameters.
    pub params: ExtrusionParams,
}

impl GridExtrusionLayer {
    /// Create a new grid extrusion 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,
            params: ExtrusionParams::default(),
        }
    }

    /// Set extrusion parameters.
    pub fn with_params(mut self, params: ExtrusionParams) -> Self {
        self.params = params;
        self
    }

    /// 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 GridExtrusionLayer {
    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_extrusion_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 = GridExtrusionLayer::new("extrusion", grid, field, test_ramp());
        assert_eq!(layer.name(), "extrusion");
        assert!((layer.params.height_scale - 1.0).abs() < 1e-9);
        assert!((layer.params.base_meters - 0.0).abs() < 1e-9);
    }

    #[test]
    fn grid_extrusion_with_params() {
        let grid = GeoGrid::new(GeoCoord::from_lat_lon(0.0, 0.0), 2, 2, 50.0, 50.0);
        let field = ScalarField2D::from_data(2, 2, vec![1.0; 4]);
        let layer =
            GridExtrusionLayer::new("ext", grid, field, test_ramp()).with_params(ExtrusionParams {
                height_scale: 10.0,
                base_meters: 5.0,
            });
        assert!((layer.params.height_scale - 10.0).abs() < 1e-9);
        assert!((layer.params.base_meters - 5.0).abs() < 1e-9);
    }
}