cherry_rs/views/
cutaway.rs

1use std::collections::HashMap;
2
3use serde::Serialize;
4
5use crate::{
6    core::{math::vec3::Vec3, sequential_model::Surface, Float, PI},
7    SequentialModel,
8};
9
10/// A cutaway view through a center transverse plane of a sequential model.
11///
12/// The cutaway view is a 2D representation of the surfaces in the y-z plane.
13#[derive(Debug, Clone, Serialize)]
14pub struct CutawayView {
15    pub path_samples: HashMap<usize, Vec<Vec3>>,
16    pub semi_diameters: HashMap<usize, Float>,
17    pub surface_types: HashMap<usize, String>,
18}
19
20impl CutawayView {
21    pub fn new(sequential_model: &SequentialModel, num_samples_per_surface: usize) -> CutawayView {
22        let largest_semi_diameter = sequential_model.largest_semi_diameter();
23
24        let mut path_samples = HashMap::new();
25        let mut semi_diameters = HashMap::new();
26        let mut surface_types = HashMap::new();
27        for (i, surface) in sequential_model.surfaces().iter().enumerate() {
28            let samples = surface.sample_yz(num_samples_per_surface, largest_semi_diameter);
29            path_samples.insert(i, samples);
30
31            semi_diameters.insert(i, surface.semi_diameter());
32            surface_types.insert(i, surface.to_string());
33        }
34
35        CutawayView {
36            path_samples,
37            semi_diameters,
38            surface_types,
39        }
40    }
41}
42
43impl Surface {
44    /// Determine sequential point samples on the surface in the y-z plane.
45    pub fn sample_yz(&self, num_samples: usize, default_semi_diameter: Float) -> Vec<Vec3> {
46        // Skip object or image planes at infinity
47        match self {
48            Self::Object(_) => {
49                if self.pos().z().abs() == Float::INFINITY {
50                    return Vec::new();
51                }
52            }
53            Self::Image(_) => {
54                if self.pos().z().abs() == Float::INFINITY {
55                    return Vec::new();
56                }
57            }
58            _ => {}
59        }
60
61        // Use the default semi-diameter for object, image, and probe planes because
62        // they have no size.
63        let semi_diameter = match self {
64            Self::Object(_) => default_semi_diameter,
65            Self::Image(_) => default_semi_diameter,
66            Self::Probe(_) => default_semi_diameter,
67            _ => self.semi_diameter(),
68        };
69
70        // Sample the surface in in the y,z plane by creating uniformally spaced (0,y,z)
71        // coordinates
72        let sample_points = Vec3::fan(num_samples, semi_diameter, PI / 2.0, 0.0, 0.0, 0.0);
73
74        let mut sample: Vec3;
75        let mut rot_sample: Vec3;
76        let mut samples = Vec::with_capacity(sample_points.len());
77        for point in sample_points {
78            let (sag, _) = self.sag_norm(point);
79
80            // Transform the sample into the global coordinate system.
81            sample = Vec3::new(point.x(), point.y(), sag);
82            rot_sample = self.rot_mat().transpose() * (sample + self.pos());
83
84            samples.push(rot_sample);
85        }
86
87        samples
88    }
89}
90
91#[cfg(test)]
92mod tests {
93    use super::*;
94    use crate::examples::convexplano_lens::sequential_model;
95
96    #[test]
97    fn test_cutaway_view() {
98        let sequential_model = sequential_model();
99        let cutaways = CutawayView::new(&sequential_model, 10);
100
101        assert_eq!(cutaways.path_samples.len(), 4);
102        assert_eq!(cutaways.path_samples[&0].len(), 0); // Object is at infinity
103        assert_eq!(cutaways.path_samples[&1].len(), 10);
104        assert_eq!(cutaways.path_samples[&2].len(), 10);
105        assert_eq!(cutaways.path_samples[&3].len(), 10);
106
107        assert_eq!(cutaways.surface_types[&0], "Object");
108        assert_eq!(cutaways.surface_types[&1], "Conic");
109        assert_eq!(cutaways.surface_types[&2], "Conic");
110        assert_eq!(cutaways.surface_types[&3], "Image");
111    }
112}
cherry_rs/views/cutaway.rs

cherry_rs/views/
cutaway.rs
