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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
use std::any::TypeId;
use bevy_app::prelude::AppTypeRegistry;
use bevy_asset::{Asset, Assets, ReflectAsset};
use bevy_ecs::schedule::StateData;
use bevy_ecs::{component::ComponentId, prelude::*, world::EntityRef};
use bevy_hierarchy::{Children, Parent};
use bevy_reflect::{Reflect, TypeRegistry};
use pretty_type_name::pretty_type_name;
pub(crate) mod errors;
pub mod hierarchy;
use crate::restricted_world_view::RestrictedWorldView;
use crate::{
egui_reflect_inspector::{Context, InspectorUi},
utils::guess_entity_name,
};
use self::errors::show_error;
pub fn ui_for_value(value: &mut dyn Reflect, world: &mut World, ui: &mut egui::Ui) -> bool {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let mut cx = Context {
world: Some(RestrictedWorldView::new(world)),
};
let mut env = InspectorUi::for_bevy(&type_registry, &mut cx);
env.ui_for_reflect(value, ui)
}
pub fn ui_for_world(world: &mut World, ui: &mut egui::Ui) {
egui::CollapsingHeader::new("Entities")
.default_open(true)
.show(ui, |ui| {
ui_for_world_entities(world, ui);
});
egui::CollapsingHeader::new("Resources").show(ui, |ui| {
ui_for_resources(world, ui);
});
egui::CollapsingHeader::new("Assets").show(ui, |ui| {
ui_for_all_assets(world, ui);
});
}
pub fn ui_for_resources(world: &mut World, ui: &mut egui::Ui) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let mut resources: Vec<_> = type_registry
.iter()
.filter(|registration| registration.data::<ReflectResource>().is_some())
.map(|registration| (registration.short_name().to_owned(), registration.type_id()))
.collect();
resources.sort_by(|(name_a, ..), (name_b, ..)| name_a.cmp(name_b));
for (name, type_id) in resources {
ui.collapsing(&name, |ui| {
by_type_id::ui_for_resource(world, type_id, ui, &name, &type_registry);
});
}
}
pub fn ui_for_resource<R: Resource + Reflect>(world: &mut World, ui: &mut egui::Ui) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let Some((mut resource, world)) = RestrictedWorldView::new(world).split_off_resource_typed::<R>() else {
errors::resource_does_not_exist(ui, &pretty_type_name::<R>());
return;
};
let mut cx = Context { world: Some(world) };
let mut env = InspectorUi::for_bevy(&type_registry, &mut cx);
if env.ui_for_reflect(resource.bypass_change_detection(), ui) {
resource.set_changed();
}
}
pub fn ui_for_all_assets(world: &mut World, ui: &mut egui::Ui) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let mut assets: Vec<_> = type_registry
.iter()
.filter(|registration| registration.data::<ReflectAsset>().is_some())
.map(|registration| (registration.short_name().to_owned(), registration.type_id()))
.collect();
assets.sort_by(|(name_a, ..), (name_b, ..)| name_a.cmp(name_b));
for (name, type_id) in assets {
ui.collapsing(&name, |ui| {
by_type_id::ui_for_assets(world, type_id, ui, &type_registry);
});
}
}
pub fn ui_for_assets<A: Asset + Reflect>(world: &mut World, ui: &mut egui::Ui) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let Some((mut assets, world)) = RestrictedWorldView::new(world).split_off_resource_typed::<Assets<A>>() else {
errors::resource_does_not_exist(ui, &pretty_type_name::<Assets<A>>());
return;
};
let mut cx = Context { world: Some(world) };
for (handle_id, asset) in assets.iter_mut() {
let id = egui::Id::new(handle_id);
egui::CollapsingHeader::new(format!("Handle({id:?})"))
.id_source(id)
.show(ui, |ui| {
let mut env = InspectorUi::for_bevy(&type_registry, &mut cx);
env.ui_for_reflect_with_options(asset, ui, id, &());
});
}
}
pub fn ui_for_state<T: StateData + Reflect>(world: &mut World, ui: &mut egui::Ui) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let Some((mut state, world)) = RestrictedWorldView::new(world).split_off_resource_typed::<State<T>>() else {
errors::state_does_not_exist(ui, &pretty_type_name::<T>());
return;
};
let mut cx = Context { world: Some(world) };
let mut env = InspectorUi::for_bevy(&type_registry, &mut cx);
let mut current = state.current().clone();
let changed = env.ui_for_reflect(&mut current, ui);
if changed {
if let Err(e) = state.set(current) {
ui.label(format!("{e:?}"));
}
}
}
pub fn ui_for_world_entities(world: &mut World, ui: &mut egui::Ui) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let mut root_entities = world.query_filtered::<Entity, Without<Parent>>();
let mut entities = root_entities.iter(world).collect::<Vec<_>>();
entities.sort();
let id = egui::Id::new("world ui");
for entity in entities {
ui_for_entity_inner(world, entity, ui, id.with(entity), &type_registry, true);
}
}
pub fn ui_for_entity(world: &mut World, entity: Entity, ui: &mut egui::Ui, in_header: bool) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
ui_for_entity_inner(
world,
entity,
ui,
egui::Id::new(entity),
&type_registry,
in_header,
)
}
fn ui_for_entity_inner(
world: &mut World,
entity: Entity,
ui: &mut egui::Ui,
id: egui::Id,
type_registry: &TypeRegistry,
in_header: bool,
) {
let entity_name = guess_entity_name::entity_name(world, type_registry, entity);
let mut inner = |ui: &mut egui::Ui| {
ui_for_entity_components(world, entity, ui, id, type_registry);
let children = world
.get::<Children>(entity)
.map(|children| children.iter().copied().collect::<Vec<_>>());
if let Some(children) = children {
if !children.is_empty() {
ui.label("Children");
for &child in children.iter() {
let id = id.with(child);
ui_for_entity_inner(world, child, ui, id, type_registry, true);
}
}
}
};
if in_header {
egui::CollapsingHeader::new(entity_name)
.id_source(id)
.show(ui, |ui| {
inner(ui);
});
} else {
ui.label(entity_name);
inner(ui);
}
}
fn ui_for_entity_components(
world: &mut World,
entity: Entity,
ui: &mut egui::Ui,
id: egui::Id,
type_registry: &TypeRegistry,
) {
let entity_ref = match world.get_entity(entity) {
Some(entity) => entity,
None => {
errors::entity_does_not_exist(ui, entity);
return;
}
};
let components = components_of_entity(entity_ref, world);
for (name, component_id, component_type_id, size) in components {
let id = id.with(component_id);
egui::CollapsingHeader::new(&name)
.id_source(id)
.show(ui, |ui| {
if size == 0 {
return;
}
let Some(component_type_id) = component_type_id else {
return errors::error_message_no_type_id(ui, &name);
};
let mut world = RestrictedWorldView::new(world);
let (mut component_view, world) =
world.split_off_component((entity, component_type_id));
let mut cx = Context { world: Some(world) };
let (value, set_changed) = match component_view.get_entity_component_reflect(
entity,
component_type_id,
type_registry,
) {
Ok(value) => value,
Err(e) => return show_error(e, ui, &name),
};
let changed = InspectorUi::for_bevy(type_registry, &mut cx)
.ui_for_reflect_with_options(value, ui, id.with(component_id), &());
if changed {
set_changed();
}
});
}
}
fn components_of_entity(
entity_ref: EntityRef,
world: &World,
) -> Vec<(String, ComponentId, Option<TypeId>, usize)> {
let archetype = entity_ref.archetype();
let mut components: Vec<_> = archetype
.components()
.map(|component_id| {
let info = world.components().get_info(component_id).unwrap();
let name = pretty_type_name::pretty_type_name_str(info.name());
(name, component_id, info.type_id(), info.layout().size())
})
.collect();
components.sort_by(|(name_a, ..), (name_b, ..)| name_a.cmp(name_b));
components
}
pub fn ui_for_entities_shared_components(
world: &mut World,
entities: &[Entity],
ui: &mut egui::Ui,
) {
let type_registry = world.resource::<AppTypeRegistry>().0.clone();
let type_registry = type_registry.read();
let Some(&first) = entities.first() else { return };
let Some(entity_ref) = world.get_entity(first) else {
return errors::entity_does_not_exist(ui, first);
};
let mut components = components_of_entity(entity_ref, world);
for &entity in entities.iter().skip(1) {
components.retain(|(_, id, _, _)| {
world
.get_entity(entity)
.map_or(true, |entity| entity.contains_id(*id))
})
}
let (resources_view, components_view) = RestrictedWorldView::resources_components(world);
let mut cx = Context {
world: Some(resources_view),
};
let mut env = InspectorUi::for_bevy(&type_registry, &mut cx);
let id = egui::Id::null();
for (name, component_id, component_type_id, size) in components {
let id = id.with(component_id);
egui::CollapsingHeader::new(&name)
.id_source(id)
.show(ui, |ui| {
if size == 0 {
return;
}
let Some(component_type_id) = component_type_id else {
return errors::error_message_no_type_id(ui, &name);
};
let mut values = Vec::with_capacity(entities.len());
let mut mark_changeds = Vec::with_capacity(entities.len());
for (i, &entity) in entities.iter().enumerate() {
if entities[0..i].contains(&entity) {
continue;
};
match unsafe {
components_view.get_entity_component_reflect_unchecked(
entity,
component_type_id,
&type_registry,
)
} {
Ok((value, mark_changed)) => {
values.push(value);
mark_changeds.push(mark_changed);
}
Err(error) => {
errors::show_error(error, ui, &name);
return;
}
}
}
let changed = env.ui_for_reflect_many_with_options(
component_type_id,
&name,
ui,
id.with(component_id),
&(),
values.as_mut_slice(),
&|a| a,
);
if changed {
mark_changeds.into_iter().for_each(|f| f());
}
});
}
}
pub mod by_type_id {
use std::any::TypeId;
use bevy_asset::{HandleUntyped, ReflectAsset, ReflectHandle};
use bevy_ecs::prelude::*;
use bevy_reflect::TypeRegistry;
use crate::{
egui_reflect_inspector::{Context, InspectorUi},
restricted_world_view::RestrictedWorldView,
};
use super::errors::{self, name_of_type};
pub fn ui_for_resource(
world: &mut World,
resource_type_id: TypeId,
ui: &mut egui::Ui,
name_of_type: &str,
type_registry: &TypeRegistry,
) {
let mut world = RestrictedWorldView::new(world);
let (mut resource_view, world) = world.split_off_resource(resource_type_id);
let mut cx = Context { world: Some(world) };
let mut env = InspectorUi::for_bevy(type_registry, &mut cx);
let (resource, set_changed) =
match resource_view.get_resource_reflect_mut_by_id(resource_type_id, type_registry) {
Ok(resource) => resource,
Err(err) => return errors::show_error(err, ui, name_of_type),
};
let changed = env.ui_for_reflect(resource, ui);
if changed {
set_changed();
}
}
pub fn ui_for_assets(
world: &mut World,
asset_type_id: TypeId,
ui: &mut egui::Ui,
type_registry: &TypeRegistry,
) {
let Some(registration) = type_registry.get(asset_type_id) else {
return crate::egui_reflect_inspector::errors::error_message_not_in_type_registry(ui, &name_of_type(asset_type_id, type_registry));
};
let Some(reflect_asset) = registration.data::<ReflectAsset>() else {
return errors::no_type_data(ui, &name_of_type(asset_type_id, type_registry), "ReflectAsset");
};
let Some(reflect_handle) = type_registry.get_type_data::<ReflectHandle>(reflect_asset.handle_type_id()) else {
return errors::no_type_data(ui, &name_of_type(reflect_asset.handle_type_id(), type_registry), "ReflectHandle");
};
let mut ids: Vec<_> = reflect_asset.ids(world).collect();
ids.sort();
let world = RestrictedWorldView::new(world);
let mut cx = Context { world: Some(world) };
for handle_id in ids {
let id = egui::Id::new(handle_id);
let mut handle = reflect_handle.typed(HandleUntyped::weak(handle_id));
egui::CollapsingHeader::new(format!("Handle({id:?})"))
.id_source(id)
.show(ui, |ui| {
let mut env = InspectorUi::for_bevy(type_registry, &mut cx);
env.ui_for_reflect_with_options(&mut *handle, ui, id, &());
});
}
}
}
impl<'a, 'c> InspectorUi<'a, 'c> {
pub fn for_bevy(
type_registry: &'a TypeRegistry,
context: &'a mut Context<'c>,
) -> InspectorUi<'a, 'c> {
InspectorUi::new(
type_registry,
context,
Some(short_circuit::short_circuit),
Some(short_circuit::short_circuit_readonly),
Some(short_circuit::short_circuit_many),
)
}
}
pub mod short_circuit {
use std::any::{Any, TypeId};
use bevy_asset::ReflectAsset;
use bevy_reflect::Reflect;
use crate::egui_reflect_inspector::{Context, InspectorUi};
use super::errors::{self, name_of_type};
pub fn short_circuit(
env: &mut InspectorUi,
value: &mut dyn Reflect,
ui: &mut egui::Ui,
id: egui::Id,
options: &dyn Any,
) -> Option<bool> {
if let Some(reflect_handle) = env
.type_registry
.get_type_data::<bevy_asset::ReflectHandle>(Any::type_id(value))
{
let handle = reflect_handle
.downcast_handle_untyped(value.as_any())
.unwrap();
let handle_id = handle.id;
let Some(reflect_asset) = env
.type_registry
.get_type_data::<ReflectAsset>(reflect_handle.asset_type_id())
else {
errors::no_type_data(ui, &name_of_type(reflect_handle.asset_type_id(), env.type_registry), "ReflectAsset");
return Some(false);
};
let Some(world) = &mut env.context.world else {
errors::no_world_in_context(ui, value.type_name());
return Some(false);
};
let (assets_view, world) =
world.split_off_resource(reflect_asset.assets_resource_type_id());
let asset_value = {
let interior_mutable_world = unsafe { assets_view.get() };
assert!(
assets_view.allows_access_to_resource(reflect_asset.assets_resource_type_id())
);
let asset_value =
unsafe { reflect_asset.get_unchecked_mut(interior_mutable_world, handle) };
match asset_value {
Some(value) => value,
None => {
errors::dead_asset_handle(ui, handle_id);
return Some(false);
}
}
};
let mut restricted_env = InspectorUi {
type_registry: env.type_registry,
context: &mut Context { world: Some(world) },
short_circuit: env.short_circuit,
short_circuit_readonly: env.short_circuit_readonly,
short_circuit_many: env.short_circuit_many,
};
return Some(restricted_env.ui_for_reflect_with_options(
asset_value,
ui,
id.with("asset"),
options,
));
}
None
}
pub fn short_circuit_many(
env: &mut InspectorUi,
type_id: TypeId,
type_name: &str,
ui: &mut egui::Ui,
id: egui::Id,
options: &dyn Any,
values: &mut [&mut dyn Reflect],
projector: &dyn Fn(&mut dyn Reflect) -> &mut dyn Reflect,
) -> Option<bool> {
if let Some(reflect_handle) = env
.type_registry
.get_type_data::<bevy_asset::ReflectHandle>(type_id)
{
let Some(reflect_asset) = env
.type_registry
.get_type_data::<ReflectAsset>(reflect_handle.asset_type_id())
else {
errors::no_type_data(ui, &name_of_type(reflect_handle.asset_type_id(), env.type_registry), "ReflectAsset");
return Some(false);
};
let Some(world) = &mut env.context.world else {
errors::no_world_in_context(ui, type_name);
return Some(false);
};
let (assets_view, world) =
world.split_off_resource(reflect_asset.assets_resource_type_id());
let mut new_values = Vec::with_capacity(values.len());
let mut used_handles = Vec::with_capacity(values.len());
for value in values {
let handle = projector(*value);
let handle = reflect_handle
.downcast_handle_untyped(handle.as_any())
.unwrap();
let handle_id = handle.id;
if used_handles.contains(&handle_id) {
continue;
};
used_handles.push(handle.id);
let asset_value = {
let interior_mutable_world = unsafe { assets_view.get() };
assert!(assets_view
.allows_access_to_resource(reflect_asset.assets_resource_type_id()));
let asset_value =
unsafe { reflect_asset.get_unchecked_mut(interior_mutable_world, handle) };
match asset_value {
Some(value) => value,
None => {
errors::dead_asset_handle(ui, handle_id);
return Some(false);
}
}
};
new_values.push(asset_value);
}
let mut restricted_env = InspectorUi {
type_registry: env.type_registry,
context: &mut Context { world: Some(world) },
short_circuit: env.short_circuit,
short_circuit_readonly: env.short_circuit_readonly,
short_circuit_many: env.short_circuit_many,
};
return Some(restricted_env.ui_for_reflect_many_with_options(
reflect_handle.asset_type_id(),
"",
ui,
id.with("asset"),
options,
new_values.as_mut_slice(),
&|a| a,
));
}
None
}
pub fn short_circuit_readonly(
env: &mut InspectorUi,
value: &dyn Reflect,
ui: &mut egui::Ui,
id: egui::Id,
options: &dyn Any,
) -> Option<()> {
if let Some(reflect_handle) = env
.type_registry
.get_type_data::<bevy_asset::ReflectHandle>(Any::type_id(value))
{
let handle = reflect_handle
.downcast_handle_untyped(value.as_any())
.unwrap();
let handle_id = handle.id;
let Some(reflect_asset) = env
.type_registry
.get_type_data::<ReflectAsset>(reflect_handle.asset_type_id())
else {
errors::no_type_data(ui, &name_of_type(reflect_handle.asset_type_id(), env.type_registry), "ReflectAsset");
return Some(());
};
let Some(world) = &mut env.context.world else {
errors::no_world_in_context(ui, value.type_name());
return Some(());
};
let (assets_view, world) =
world.split_off_resource(reflect_asset.assets_resource_type_id());
let asset_value = {
let interior_mutable_world = unsafe { assets_view.get() };
assert!(
assets_view.allows_access_to_resource(reflect_asset.assets_resource_type_id())
);
let asset_value = reflect_asset.get(interior_mutable_world, handle);
match asset_value {
Some(value) => value,
None => {
errors::dead_asset_handle(ui, handle_id);
return Some(());
}
}
};
let mut restricted_env = InspectorUi {
type_registry: env.type_registry,
context: &mut Context { world: Some(world) },
short_circuit: env.short_circuit,
short_circuit_readonly: env.short_circuit_readonly,
short_circuit_many: env.short_circuit_many,
};
restricted_env.ui_for_reflect_readonly_with_options(
asset_value,
ui,
id.with("asset"),
options,
);
return Some(());
}
None
}
}