indicatrix-cut 0.7.2

Desktop faceting-design editor: library browsing, spectral 3D rendering, material retargeting, and a solid inspection view.
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

//! Which lighting presets this build offers: the two UV lamps belong to the
//! `physical-color` feature ([`PHYSICS_COLOR_UI`]), like the fluorescence UI they light.
//!
//! The data layer still knows every preset (a scene, a job or a design file may name a UV
//! lamp), so the gate sits where a preset enters the desktop app from outside the combo box:
//! the settings file, a saved lighting preset, a design's own lighting and the combo's index.
//! A UV lamp reaching a build without the feature falls back to the editor default rig
//! ([`DEFAULT_LIGHTING_RIG`]), never an error.

use indicatrix::optics::LightingPreset;

use crate::{gui::optics::physics_state::PHYSICS_COLOR_UI, settings::model::DEFAULT_LIGHTING_RIG};

/// `preset` itself, or the editor default rig when it is a UV lamp and `uv_offered` is false.
#[must_use]
pub fn gate_preset(preset: LightingPreset, uv_offered: bool) -> LightingPreset {
    if uv_offered || !preset.is_uv_lamp() {
        preset
    } else {
        LightingPreset::from_label(DEFAULT_LIGHTING_RIG)
    }
}

/// [`gate_preset`] for this build ([`PHYSICS_COLOR_UI`]).
#[must_use]
pub fn offered(preset: LightingPreset) -> LightingPreset {
    gate_preset(preset, PHYSICS_COLOR_UI)
}

/// The preset a stored label names in this build: `LightingPreset::from_label`, gated.
#[must_use]
pub fn offered_from_label(label: &str) -> LightingPreset {
    offered(LightingPreset::from_label(label))
}

/// The preset the combo's index names in this build: `LightingPreset::from_index`, gated.
#[must_use]
pub fn offered_from_index(index: i32) -> LightingPreset {
    offered(LightingPreset::from_index(index))
}

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

    #[test]
    fn uv_lamps_fall_back_to_the_default_rig_without_the_feature() {
        let default = LightingPreset::from_label(DEFAULT_LIGHTING_RIG);
        assert_eq!(gate_preset(LightingPreset::UvLamp365, false), default);
        assert_eq!(gate_preset(LightingPreset::UvLamp395, false), default);
        assert!(!default.is_uv_lamp());
    }

    #[test]
    fn uv_lamps_are_kept_with_the_feature() {
        assert_eq!(
            gate_preset(LightingPreset::UvLamp365, true),
            LightingPreset::UvLamp365
        );
        assert_eq!(
            gate_preset(LightingPreset::UvLamp395, true),
            LightingPreset::UvLamp395
        );
    }

    #[test]
    fn visible_light_presets_are_never_changed() {
        for preset in LightingPreset::ALL {
            if !preset.is_uv_lamp() {
                assert_eq!(gate_preset(preset, false), preset);
                assert_eq!(gate_preset(preset, true), preset);
            }
        }
    }

    #[test]
    fn stored_labels_and_indices_follow_the_build() {
        let uv_label = LightingPreset::UvLamp365.label();
        let uv_index = LightingPreset::UvLamp395.index();
        let default = LightingPreset::from_label(DEFAULT_LIGHTING_RIG);
        let expect = |uv: LightingPreset| if PHYSICS_COLOR_UI { uv } else { default };
        assert_eq!(
            offered_from_label(uv_label),
            expect(LightingPreset::UvLamp365)
        );
        assert_eq!(
            offered_from_index(uv_index),
            expect(LightingPreset::UvLamp395)
        );
        assert_eq!(offered_from_index(9999), LightingPreset::from_index(9999));
    }
}