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
157
158
159
160
161
162
163

use std::{
    ops::{DerefMut, RangeInclusive},
    path::PathBuf,
    time::Duration,
};

pub trait Inspectable {
    /// Inspects this value given its name. This usually is just a wrapper over `inspect_ui`
    /// with a label in front of it.
    ///
    /// This function exists here to allow overriding the default behavior, which is what happens
    /// to objects that implement TreeNode and derive Inspectable. Since we don't want nodes to be
    /// visible in the inspector, we can manually implement this function and remove all default
    /// behavior, thus effectively hiding the object from the inspector while still allowing to
    /// inspect its contents via `inspect_ui`.
    fn inspect_ui_outside(&mut self, name: &str, ui: &mut egui::Ui) {
        ui.horizontal(|ui| {
            ui.label(name);
            self.inspect_ui(ui);
        });
    }

    fn inspect_ui(&mut self, _ui: &mut egui::Ui) {}
}

macro_rules! implement_inspectable_for_numeric {
    ($NumericType: ty) => {
        impl Inspectable for $NumericType {
            fn inspect_ui(&mut self, ui: &mut egui::Ui) {
                ui.add(egui::DragValue::new(self));
            }
        }
    };
}
implement_inspectable_for_numeric!(i8);
implement_inspectable_for_numeric!(u8);
implement_inspectable_for_numeric!(i16);
implement_inspectable_for_numeric!(u16);
implement_inspectable_for_numeric!(i32);
implement_inspectable_for_numeric!(u32);
implement_inspectable_for_numeric!(i64);
implement_inspectable_for_numeric!(u64);
implement_inspectable_for_numeric!(isize);
implement_inspectable_for_numeric!(usize);
implement_inspectable_for_numeric!(f32);
implement_inspectable_for_numeric!(f64);

impl Inspectable for bool {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        ui.checkbox(self, "");
    }
}

impl Inspectable for PathBuf {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        // TODO: Allow editing PathBufs
        ui.add_enabled_ui(false, |ui| {
            ui.text_edit_singleline(&mut self.to_string_lossy().into_owned())
        });
    }
}

impl Inspectable for Duration {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        let mut secs = self.as_secs_f64();
        if ui
            .add(egui::DragValue::new(&mut secs).clamp_range(0.0..=core::f64::INFINITY))
            .changed()
        {
            *self = Duration::from_secs_f64(secs);
        }
    }
}

impl Inspectable for String {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        ui.text_edit_singleline(self);
    }
}

pub struct ClampedValue<'v, T: egui::emath::Numeric> {
    pub range: RangeInclusive<T>,
    pub value: &'v mut T,
    pub speed: f64,
}

impl<T: egui::emath::Numeric> Inspectable for ClampedValue<'_, T> {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        ui.add(
            egui::DragValue::new(self.value)
                .clamp_range(self.range.clone())
                .speed(self.speed),
        );
    }
}

// TODO: Figure out how to take in a const ref instead
pub struct ReadOnlyValue<'v, T: Inspectable>(pub &'v mut T);

// TODO: TreeElement for ReadOnlyValue<T>
impl<'v, T: Inspectable> Inspectable for ReadOnlyValue<'v, T> {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        ui.add_enabled_ui(false, |ui| self.0.inspect_ui(ui));
    }
}

// TODO: TreeElement for Option<T>
impl<T: Inspectable + Default> Inspectable for Option<T> {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        match self {
            Some(x) => {
                if ui
                    .horizontal(|ui| {
                        ui.group(|ui| x.inspect_ui(ui));
                        ui.small_button("-").clicked()
                    })
                    .inner
                {
                    *self = None;
                }
            }
            None => {
                if ui.small_button("+").clicked() {
                    *self = Some(Default::default())
                }
            }
        }
    }
}

impl Inspectable for () {}

impl<T: Inspectable> Inspectable for [T] {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        for element in self.into_iter() {
            element.inspect_ui(ui);
        }
    }
}

impl<T: Inspectable, const X: usize> Inspectable for [T; X] {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        self[..].as_mut().inspect_ui(ui)
    }
}

impl<T: Inspectable> Inspectable for Vec<T> {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        self[..].inspect_ui(ui)
    }
}

impl<T: Inspectable + ?Sized> Inspectable for &mut T {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        (*self).inspect_ui(ui)
    }
}

impl<T: Inspectable + ?Sized> Inspectable for Box<T> {
    fn inspect_ui(&mut self, ui: &mut egui::Ui) {
        self.deref_mut().inspect_ui(ui)
    }
}