rg3d-ui 0.15.0

Extendable UI library
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

use crate::{
    core::{inspect::PropertyInfo, pool::Handle},
    inspector::{
        editors::{
            bool::BoolPropertyEditorDefinition,
            color::ColorPropertyEditorDefinition,
            numeric::NumericPropertyEditorDefinition,
            quat::QuatPropertyEditorDefinition,
            range::RangePropertyEditorDefinition,
            rect::RectPropertyEditorDefinition,
            string::StringPropertyEditorDefinition,
            vec::{
                Vec2PropertyEditorDefinition, Vec3PropertyEditorDefinition,
                Vec4PropertyEditorDefinition,
            },
        },
        InspectorEnvironment, InspectorError, PropertyChanged,
    },
    message::UiMessage,
    BuildContext, UiNode, UserInterface,
};
use fxhash::FxHashMap;
use std::{any::TypeId, fmt::Debug, rc::Rc};

pub mod array;
pub mod bool;
pub mod collection;
pub mod color;
pub mod enumeration;
pub mod inspectable;
pub mod numeric;
pub mod quat;
pub mod range;
pub mod rect;
pub mod string;
pub mod vec;

pub struct PropertyEditorBuildContext<'a, 'b, 'c> {
    pub build_context: &'a mut BuildContext<'c>,
    pub property_info: &'b PropertyInfo<'b>,
    pub environment: Option<Rc<dyn InspectorEnvironment>>,
    pub definition_container: Rc<PropertyEditorDefinitionContainer>,
    pub sync_flag: u64,
    pub layer_index: usize,
}

pub struct PropertyEditorMessageContext<'a, 'b> {
    pub sync_flag: u64,
    pub instance: Handle<UiNode>,
    pub ui: &'b mut UserInterface,
    pub property_info: &'a PropertyInfo<'a>,
    pub definition_container: Rc<PropertyEditorDefinitionContainer>,
    pub layer_index: usize,
}

pub enum PropertyEditorInstance {
    Simple {
        /// A property editor. Could be any widget that capable of editing a property
        /// value.
        editor: Handle<UiNode>,
    },
    Custom {
        container: Handle<UiNode>,

        /// A property editor. Could be any widget that capable of editing a property
        /// value.
        editor: Handle<UiNode>,
    },
}

pub trait PropertyEditorDefinition: Debug {
    fn value_type_id(&self) -> TypeId;

    fn create_instance(
        &self,
        ctx: PropertyEditorBuildContext,
    ) -> Result<PropertyEditorInstance, InspectorError>;

    fn create_message(
        &self,
        ctx: PropertyEditorMessageContext,
    ) -> Result<Option<UiMessage>, InspectorError>;

    fn translate_message(
        &self,
        name: &str,
        owner_type_id: TypeId,
        message: &UiMessage,
    ) -> Option<PropertyChanged>;
}

#[derive(Clone, Default)]
pub struct PropertyEditorDefinitionContainer {
    definitions: FxHashMap<TypeId, Rc<dyn PropertyEditorDefinition>>,
}

impl PropertyEditorDefinitionContainer {
    pub fn new() -> Self {
        let mut container = Self::default();

        container.insert(BoolPropertyEditorDefinition);

        container.insert(StringPropertyEditorDefinition);

        container.insert(NumericPropertyEditorDefinition::<f64>::default());
        container.insert(NumericPropertyEditorDefinition::<f32>::default());
        container.insert(NumericPropertyEditorDefinition::<i64>::default());
        container.insert(NumericPropertyEditorDefinition::<u64>::default());
        container.insert(NumericPropertyEditorDefinition::<i32>::default());
        container.insert(NumericPropertyEditorDefinition::<u32>::default());
        container.insert(NumericPropertyEditorDefinition::<i16>::default());
        container.insert(NumericPropertyEditorDefinition::<u16>::default());
        container.insert(NumericPropertyEditorDefinition::<i8>::default());
        container.insert(NumericPropertyEditorDefinition::<u8>::default());
        container.insert(NumericPropertyEditorDefinition::<usize>::default());
        container.insert(NumericPropertyEditorDefinition::<isize>::default());

        container.insert(Vec4PropertyEditorDefinition::<f64>::default());
        container.insert(Vec4PropertyEditorDefinition::<f32>::default());
        container.insert(Vec4PropertyEditorDefinition::<i64>::default());
        container.insert(Vec4PropertyEditorDefinition::<u64>::default());
        container.insert(Vec4PropertyEditorDefinition::<i32>::default());
        container.insert(Vec4PropertyEditorDefinition::<u32>::default());
        container.insert(Vec4PropertyEditorDefinition::<i16>::default());
        container.insert(Vec4PropertyEditorDefinition::<u16>::default());
        container.insert(Vec4PropertyEditorDefinition::<i8>::default());
        container.insert(Vec4PropertyEditorDefinition::<u8>::default());
        container.insert(Vec4PropertyEditorDefinition::<usize>::default());
        container.insert(Vec4PropertyEditorDefinition::<isize>::default());

        container.insert(Vec3PropertyEditorDefinition::<f64>::default());
        container.insert(Vec3PropertyEditorDefinition::<f32>::default());
        container.insert(Vec3PropertyEditorDefinition::<i64>::default());
        container.insert(Vec3PropertyEditorDefinition::<u64>::default());
        container.insert(Vec3PropertyEditorDefinition::<i32>::default());
        container.insert(Vec3PropertyEditorDefinition::<u32>::default());
        container.insert(Vec3PropertyEditorDefinition::<i16>::default());
        container.insert(Vec3PropertyEditorDefinition::<u16>::default());
        container.insert(Vec3PropertyEditorDefinition::<i8>::default());
        container.insert(Vec3PropertyEditorDefinition::<u8>::default());
        container.insert(Vec3PropertyEditorDefinition::<usize>::default());
        container.insert(Vec3PropertyEditorDefinition::<isize>::default());

        container.insert(Vec2PropertyEditorDefinition::<f64>::default());
        container.insert(Vec2PropertyEditorDefinition::<f32>::default());
        container.insert(Vec2PropertyEditorDefinition::<i64>::default());
        container.insert(Vec2PropertyEditorDefinition::<u64>::default());
        container.insert(Vec2PropertyEditorDefinition::<i32>::default());
        container.insert(Vec2PropertyEditorDefinition::<u32>::default());
        container.insert(Vec2PropertyEditorDefinition::<i16>::default());
        container.insert(Vec2PropertyEditorDefinition::<u16>::default());
        container.insert(Vec2PropertyEditorDefinition::<i8>::default());
        container.insert(Vec2PropertyEditorDefinition::<u8>::default());
        container.insert(Vec2PropertyEditorDefinition::<usize>::default());
        container.insert(Vec2PropertyEditorDefinition::<isize>::default());

        container.insert(RangePropertyEditorDefinition::<f64>::new());
        container.insert(RangePropertyEditorDefinition::<f32>::new());
        container.insert(RangePropertyEditorDefinition::<i64>::new());
        container.insert(RangePropertyEditorDefinition::<u64>::new());
        container.insert(RangePropertyEditorDefinition::<i32>::new());
        container.insert(RangePropertyEditorDefinition::<u32>::new());
        container.insert(RangePropertyEditorDefinition::<i16>::new());
        container.insert(RangePropertyEditorDefinition::<u16>::new());
        container.insert(RangePropertyEditorDefinition::<i8>::new());
        container.insert(RangePropertyEditorDefinition::<u8>::new());
        container.insert(RangePropertyEditorDefinition::<usize>::new());
        container.insert(RangePropertyEditorDefinition::<isize>::new());

        container.insert(QuatPropertyEditorDefinition::<f64>::default());
        container.insert(QuatPropertyEditorDefinition::<f32>::default());

        container.insert(RectPropertyEditorDefinition::<f64>::new());
        container.insert(RectPropertyEditorDefinition::<f32>::new());
        container.insert(RectPropertyEditorDefinition::<i32>::new());
        container.insert(RectPropertyEditorDefinition::<u32>::new());
        container.insert(RectPropertyEditorDefinition::<i16>::new());
        container.insert(RectPropertyEditorDefinition::<u16>::new());
        container.insert(RectPropertyEditorDefinition::<i8>::new());
        container.insert(RectPropertyEditorDefinition::<u8>::new());
        container.insert(RectPropertyEditorDefinition::<usize>::new());
        container.insert(RectPropertyEditorDefinition::<isize>::new());

        container.insert(ColorPropertyEditorDefinition);

        container
    }

    pub fn insert<T: PropertyEditorDefinition + 'static>(
        &mut self,
        definition: T,
    ) -> Option<Rc<dyn PropertyEditorDefinition>> {
        self.definitions
            .insert(definition.value_type_id(), Rc::new(definition))
    }

    pub fn definitions(&self) -> &FxHashMap<TypeId, Rc<dyn PropertyEditorDefinition>> {
        &self.definitions
    }
}