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 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
use std::{
collections::BTreeMap,
sync::{
atomic::{AtomicBool, Ordering},
Arc,
},
};
use ahash::HashMap;
use egui_tiles::{SimplificationOptions, TileId};
use nohash_hasher::IntSet;
use parking_lot::Mutex;
use smallvec::SmallVec;
use re_chunk_store::LatestAtQuery;
use re_entity_db::EntityPath;
use re_types::blueprint::{
archetypes as blueprint_archetypes,
components::{AutoLayout, AutoViews, RootContainer, ViewMaximized},
};
use re_types::{
blueprint::components::ViewerRecommendationHash, Archetype as _, ViewClassIdentifier,
};
use re_viewer_context::{
blueprint_id_to_tile_id, ContainerId, Contents, Item, ViewId, ViewerContext,
};
use crate::{container::ContainerBlueprint, ViewBlueprint, ViewportCommand, VIEWPORT_PATH};
// ----------------------------------------------------------------------------
/// Describes the layout and contents of the Viewport Panel.
///
/// This datastructure is loaded from the blueprint store at the start of each frame.
///
/// It remain immutable during the frame.
///
/// Any change is queued up into [`Self::deferred_commands`] and applied at the end of the frame,
/// right before saving to the blueprint store.
pub struct ViewportBlueprint {
/// Where the views are stored.
///
/// Not a hashmap in order to preserve the order of the views.
pub views: BTreeMap<ViewId, ViewBlueprint>,
/// All the containers found in the viewport.
pub containers: BTreeMap<ContainerId, ContainerBlueprint>,
/// The root container.
pub root_container: ContainerId,
/// The layouts of all the views.
///
/// If [`Self::maximized`] is set, this tree is ignored.
pub tree: egui_tiles::Tree<ViewId>,
/// Show only one view as maximized?
///
/// If set, [`Self::tree`] is ignored.
pub maximized: Option<ViewId>,
/// Whether the viewport layout is determined automatically.
///
/// If `true`, we auto-layout all views whenever a new view is added.
///
/// Set to `false` the first time the user messes around with the viewport blueprint.
/// Note: we use an atomic here because writes needs to be effective immediately during the frame.
auto_layout: AtomicBool,
/// Whether views should be created automatically for entities that are not already in a space.
///
/// Note: we use an atomic here because writes needs to be effective immediately during the frame.
auto_views: AtomicBool,
/// Hashes of all recommended views the viewer has already added and that should not be added again.
past_viewer_recommendations: IntSet<ViewerRecommendationHash>,
/// Blueprint mutation events that will be processed at the end of the frame.
pub deferred_commands: Arc<Mutex<Vec<ViewportCommand>>>,
}
impl ViewportBlueprint {
/// Attempt to load a [`ViewBlueprint`] from the blueprint store.
pub fn try_from_db(blueprint_db: &re_entity_db::EntityDb, query: &LatestAtQuery) -> Self {
re_tracing::profile_function!();
let blueprint_engine = blueprint_db.storage_engine();
let results = blueprint_engine.cache().latest_at(
query,
&VIEWPORT_PATH.into(),
blueprint_archetypes::ViewportBlueprint::all_components().iter(),
);
let blueprint_archetypes::ViewportBlueprint {
root_container,
maximized,
auto_layout,
auto_views,
past_viewer_recommendations,
} = blueprint_archetypes::ViewportBlueprint {
root_container: results.component_instance(0),
maximized: results.component_instance(0),
auto_layout: results.component_instance(0),
auto_views: results.component_instance(0),
past_viewer_recommendations: results.component_batch(),
};
let root_container: Option<ContainerId> = root_container.map(|id| id.0.into());
re_log::trace_once!("Loaded root_container: {root_container:?}");
let mut containers: BTreeMap<ContainerId, ContainerBlueprint> = Default::default();
let mut all_view_ids: Vec<ViewId> = Default::default();
if let Some(root_container) = root_container {
re_tracing::profile_scope!("visit_all_containers");
let mut container_ids_to_visit: Vec<ContainerId> = vec![root_container];
while let Some(id) = container_ids_to_visit.pop() {
if let Some(container) = ContainerBlueprint::try_from_db(blueprint_db, query, id) {
re_log::trace_once!("Container {id} contents: {:?}", container.contents);
for &content in &container.contents {
match content {
Contents::Container(id) => container_ids_to_visit.push(id),
Contents::View(id) => {
all_view_ids.push(id);
}
}
}
containers.insert(id, container);
} else {
re_log::warn_once!("Failed to load container {id}");
}
}
}
let views: BTreeMap<ViewId, ViewBlueprint> = all_view_ids
.into_iter()
.filter_map(|view: ViewId| ViewBlueprint::try_from_db(view, blueprint_db, query))
.map(|sv| (sv.id, sv))
.collect();
// Auto layouting and auto view are only enabled if no blueprint has been provided by the user.
// Only enable auto-views if this is the app-default blueprint
let is_app_default_blueprint = blueprint_db
.store_info()
.map_or(false, |ri| ri.is_app_default_blueprint());
let auto_layout =
AtomicBool::new(auto_layout.map_or(is_app_default_blueprint, |auto| *auto.0));
let auto_views =
AtomicBool::new(auto_views.map_or(is_app_default_blueprint, |auto| *auto.0));
let root_container = root_container.unwrap_or_else(|| {
let new_root_id = ContainerId::hashed_from_str("placeholder_root_container");
containers.insert(new_root_id, ContainerBlueprint::new(new_root_id));
new_root_id
});
let tree = build_tree_from_views_and_containers(
views.values(),
containers.values(),
root_container,
);
re_log::trace_once!("Loaded tree: {tree:#?}");
let past_viewer_recommendations = past_viewer_recommendations
.unwrap_or_default()
.iter()
.cloned()
.collect();
Self {
views,
containers,
root_container,
tree,
maximized: maximized.map(|id| id.0.into()),
auto_layout,
auto_views,
past_viewer_recommendations,
deferred_commands: Default::default(),
}
}
/// Determine whether all views in a blueprint are invalid.
///
/// This most commonly happens due to a change in struct definition that
/// breaks the definition of a serde-field, which means all views will
/// become invalid.
///
/// Note: the invalid check is used to potentially reset the blueprint, so we
/// take the conservative stance that if any view is still usable we will still
/// treat the blueprint as valid and show it.
pub fn is_invalid(&self) -> bool {
!self.views.is_empty()
&& self
.views
.values()
.all(|sv| sv.class_identifier() == ViewClassIdentifier::invalid())
}
pub fn view_ids(&self) -> impl Iterator<Item = &ViewId> + '_ {
self.views.keys()
}
/// Find the parent container of a given contents.
///
/// Returns `None` if this is unknown contents, or if it is the root contaioner.
pub fn parent(&self, needle: &Contents) -> Option<ContainerId> {
self.containers
.iter()
.find_map(|(container_id, container)| {
container.contents.contains(needle).then_some(*container_id)
})
}
pub fn view(&self, view: &ViewId) -> Option<&ViewBlueprint> {
self.views.get(view)
}
pub fn container(&self, container_id: &ContainerId) -> Option<&ContainerBlueprint> {
self.containers.get(container_id)
}
/// Duplicates a view and its entity property overrides.
pub fn duplicate_view(&self, view_id: &ViewId, ctx: &ViewerContext<'_>) -> Option<ViewId> {
let view = self.view(view_id)?;
let new_view = view.duplicate(ctx.store_context, ctx.blueprint_query);
let new_view_id = new_view.id;
let parent_and_pos = self.find_parent_and_position_index(&Contents::View(*view_id));
self.add_views(
std::iter::once(new_view),
parent_and_pos.map(|(parent, _)| parent),
parent_and_pos.map(|(_, pos)| pos),
);
self.mark_user_interaction(ctx);
Some(new_view_id)
}
/// If `false`, the item is referring to data that is not present in this blueprint.
///
/// TODO(#5742): note that `Item::DataResult` with entity path set to the space origin or some
/// of its descendent are always considered valid.
pub fn is_item_valid(
&self,
store_context: &re_viewer_context::StoreContext<'_>,
item: &Item,
) -> bool {
match item {
Item::AppId(app_id) => store_context
.hub
.store_bundle()
.entity_dbs()
.any(|db| db.app_id() == Some(app_id)),
Item::DataSource(_)
| Item::StoreId(_)
| Item::ComponentPath(_)
| Item::InstancePath(_) => true,
Item::View(view_id) => self.view(view_id).is_some(),
Item::DataResult(view_id, instance_path) => {
self.view(view_id).map_or(false, |view| {
let entity_path = &instance_path.entity_path;
// TODO(#5742): including any path that is—or descend from—the space origin is
// necessary because such items may actually be displayed in the blueprint tree.
entity_path == &view.space_origin
|| entity_path.is_descendant_of(&view.space_origin)
|| view
.contents
.entity_path_filter
.matches(&instance_path.entity_path)
})
}
Item::Container(container_id) => self.container(container_id).is_some(),
}
}
fn enqueue_command(&self, action: ViewportCommand) {
self.deferred_commands.lock().push(action);
}
pub fn mark_user_interaction(&self, ctx: &ViewerContext<'_>) {
if self.auto_layout() {
re_log::trace!("User edits - will no longer auto-layout");
}
self.set_auto_layout(false, ctx);
self.set_auto_views(false, ctx);
}
/// Spawns new views if enabled.
pub fn spawn_heuristic_views(&self, ctx: &ViewerContext<'_>) {
if !self.auto_views() {
return;
}
re_tracing::profile_function!();
for entry in ctx.view_class_registry.iter_registry() {
let class_id = entry.identifier;
let mut recommended_views = entry.class.spawn_heuristics(ctx).into_vec();
re_tracing::profile_scope!("filter_recommendations_for", class_id);
// Remove all views that we already spawned via heuristic before.
recommended_views.retain(|recommended_view| {
!self
.past_viewer_recommendations
.contains(&recommended_view.recommendation_hash(class_id))
});
// Each of the remaining recommendations would individually be a candidate for spawning if there were
// no other views in the viewport.
// In the following steps we further filter this list depending on what's on screen already,
// as well as redundancy within the recommendation itself BUT this is an important checkpoint:
// All the other views may change due to user interaction, but this does *not* mean
// that we should suddenly spawn the views we're filtering out here.
// Therefore everything so far needs to be added to `past_viewer_recommendations`,
// which marks this as "already processed recommendation".
//
// Example:
// Recommendation contains `/**` and `/camera/**`.
// We filter out `/camera/**` because that would be redundant to `/**`.
// If now the user edits the view at `/**` to be `/points/**`, that does *not*
// mean we should suddenly add `/camera/**` to the viewport.
if !recommended_views.is_empty() {
let new_viewer_recommendation_hashes: Vec<ViewerRecommendationHash> = self
.past_viewer_recommendations
.iter()
.cloned()
.chain(
recommended_views
.iter()
.map(|recommendation| recommendation.recommendation_hash(class_id)),
)
.collect();
ctx.save_blueprint_component(
&VIEWPORT_PATH.into(),
&new_viewer_recommendation_hashes,
);
}
// Remove all views that have all the entities we already have on screen.
let existing_path_filters = self
.views
.values()
.filter(|view| view.class_identifier() == class_id)
.map(|view| &view.contents.entity_path_filter)
.collect::<Vec<_>>();
recommended_views.retain(|recommended_view| {
existing_path_filters.iter().all(|existing_filter| {
!existing_filter.is_superset_of(&recommended_view.query_filter)
})
});
// Remove all views that are redundant within the remaining recommendation.
// This n^2 loop should only run ever for frames that add new views.
let final_recommendations = recommended_views
.iter()
.enumerate()
.filter(|(j, candidate)| {
recommended_views.iter().enumerate().all(|(i, other)| {
i == *j || !other.query_filter.is_superset_of(&candidate.query_filter)
})
})
.map(|(_, recommendation)| recommendation);
self.add_views(
final_recommendations
.map(|recommendation| ViewBlueprint::new(class_id, recommendation.clone())),
None,
None,
);
}
}
/// Add a set of views to the viewport.
///
/// The view is added to the root container, or, if provided, to a given parent container.
/// The list of created view IDs is returned.
///
/// Note that this doesn't focus the corresponding tab. Use [`Self::focus_tab`] with the returned ID
/// if needed.
pub fn add_views(
&self,
views: impl Iterator<Item = ViewBlueprint>,
parent_container: Option<ContainerId>,
position_in_parent: Option<usize>,
) {
for view in views {
self.enqueue_command(ViewportCommand::AddView {
view,
parent_container,
position_in_parent,
});
}
}
/// Returns an iterator over all the contents (views and containers) in the viewport.
pub fn contents_iter(&self) -> impl Iterator<Item = Contents> + '_ {
self.views
.keys()
.map(|view_id| Contents::View(*view_id))
.chain(
self.containers
.keys()
.map(|container_id| Contents::Container(*container_id)),
)
}
/// Walk the entire [`Contents`] tree, starting from the root container.
///
/// See [`Self::visit_contents_in_container`] for details.
pub fn visit_contents(&self, visitor: &mut impl FnMut(&Contents, &SmallVec<[ContainerId; 4]>)) {
self.visit_contents_in_container(&self.root_container, visitor);
}
/// Walk the subtree defined by the provided container id and call `visitor` for each
/// [`Contents`].
///
/// Note:
/// - `visitor` is first called for the container passed in argument
/// - `visitor`'s second argument contains the hierarchy leading to the visited contents, from
/// (and including) the container passed in argument
pub fn visit_contents_in_container(
&self,
container_id: &ContainerId,
visitor: &mut impl FnMut(&Contents, &SmallVec<[ContainerId; 4]>),
) {
let mut hierarchy = SmallVec::new();
self.visit_contents_in_container_impl(container_id, &mut hierarchy, visitor);
}
fn visit_contents_in_container_impl(
&self,
container_id: &ContainerId,
hierarchy: &mut SmallVec<[ContainerId; 4]>,
visitor: &mut impl FnMut(&Contents, &SmallVec<[ContainerId; 4]>),
) {
visitor(&Contents::Container(*container_id), hierarchy);
if let Some(container) = self.container(container_id) {
hierarchy.push(*container_id);
for contents in &container.contents {
visitor(contents, hierarchy);
match contents {
Contents::Container(container_id) => {
self.visit_contents_in_container_impl(container_id, hierarchy, visitor);
}
Contents::View(_) => {}
}
}
hierarchy.pop();
}
}
/// Given a predicate, finds the (first) matching contents by recursively walking from the root
/// container.
pub fn find_contents_by(&self, predicate: &impl Fn(&Contents) -> bool) -> Option<Contents> {
self.find_contents_in_container_by(predicate, &self.root_container)
}
/// Given a predicate, finds the (first) matching contents by recursively walking from the given
/// container.
pub fn find_contents_in_container_by(
&self,
predicate: &impl Fn(&Contents) -> bool,
container_id: &ContainerId,
) -> Option<Contents> {
if predicate(&Contents::Container(*container_id)) {
return Some(Contents::Container(*container_id));
}
let container = self.container(container_id)?;
for contents in &container.contents {
if predicate(contents) {
return Some(*contents);
}
match contents {
Contents::Container(container_id) => {
let res = self.find_contents_in_container_by(predicate, container_id);
if res.is_some() {
return res;
}
}
Contents::View(_) => {}
}
}
None
}
/// Checks if some content is (directly or indirectly) contained in the given container.
pub fn is_contents_in_container(
&self,
contents: &Contents,
container_id: &ContainerId,
) -> bool {
self.find_contents_in_container_by(&|c| c == contents, container_id)
.is_some()
}
/// Given a container or a view, find its enclosing container and its position within it.
pub fn find_parent_and_position_index(
&self,
contents: &Contents,
) -> Option<(ContainerId, usize)> {
if *contents == Contents::Container(self.root_container) {
// root doesn't have a parent
return None;
}
self.find_parent_and_position_index_impl(contents, &self.root_container)
}
fn find_parent_and_position_index_impl(
&self,
contents: &Contents,
container_id: &ContainerId,
) -> Option<(ContainerId, usize)> {
let container = self.container(container_id)?;
for (pos, child_contents) in container.contents.iter().enumerate() {
if child_contents == contents {
return Some((*container_id, pos));
}
match child_contents {
Contents::Container(child_container_id) => {
let res =
self.find_parent_and_position_index_impl(contents, child_container_id);
if res.is_some() {
return res;
}
}
Contents::View(_) => {}
}
}
None
}
/// Add a container of the provided kind.
///
/// The container is added to the root container or, if provided, to the given parent container.
pub fn add_container(
&self,
kind: egui_tiles::ContainerKind,
parent_container: Option<ContainerId>,
) {
self.enqueue_command(ViewportCommand::AddContainer {
container_kind: kind,
parent_container,
});
}
/// Recursively remove a container or a view.
pub fn remove_contents(&self, contents: Contents) {
self.enqueue_command(ViewportCommand::RemoveContents(contents));
}
/// Move the `contents` container or view to the specified target container and position.
pub fn move_contents(
&self,
contents_to_move: Vec<Contents>,
target_container: ContainerId,
target_position_in_container: usize,
) {
self.enqueue_command(ViewportCommand::MoveContents {
contents_to_move,
target_container,
target_position_in_container,
});
}
/// Move some [`Contents`] to a newly created container of the given kind.
pub fn move_contents_to_new_container(
&self,
contents: Vec<Contents>,
new_container_kind: egui_tiles::ContainerKind,
target_container: ContainerId,
target_position_in_container: usize,
) {
self.enqueue_command(ViewportCommand::MoveContentsToNewContainer {
contents_to_move: contents,
new_container_kind,
target_container,
target_position_in_container,
});
}
/// Make sure the tab corresponding to this view is focused.
pub fn focus_tab(&self, view_id: ViewId) {
self.enqueue_command(ViewportCommand::FocusTab(view_id));
}
/// Set the kind of the provided container.
pub fn set_container_kind(&self, container_id: ContainerId, kind: egui_tiles::ContainerKind) {
// no-op check
if let Some(container) = self.container(&container_id) {
if container.container_kind == kind {
return;
}
}
self.enqueue_command(ViewportCommand::SetContainerKind(container_id, kind));
}
/// Simplify the container tree with the provided options.
pub fn simplify_container(
&self,
container_id: &ContainerId,
simplification_options: SimplificationOptions,
) {
self.enqueue_command(ViewportCommand::SimplifyContainer(
*container_id,
simplification_options,
));
}
/// Make all children of the given container the same size.
pub fn make_all_children_same_size(&self, container_id: &ContainerId) {
self.enqueue_command(ViewportCommand::MakeAllChildrenSameSize(*container_id));
}
/// Check the visibility of the provided content.
///
/// This function may be called from UI code.
pub fn is_contents_visible(&self, contents: &Contents) -> bool {
match contents {
Contents::Container(container_id) => {
if let Some(container) = self.container(container_id) {
container.visible
} else {
re_log::warn_once!(
"Visibility check failed due to unknown container id {container_id:?}"
);
false
}
}
Contents::View(view_id) => {
if let Some(view) = self.view(view_id) {
view.visible
} else {
re_log::warn_once!(
"Visibility check failed due to unknown view id {view_id:?}"
);
false
}
}
}
}
/// Sets the visibility for the provided content.
///
/// This function may be called from UI code.
pub fn set_content_visibility(
&self,
ctx: &ViewerContext<'_>,
contents: &Contents,
visible: bool,
) {
match contents {
Contents::Container(container_id) => {
if let Some(container) = self.container(container_id) {
if visible != container.visible {
if self.auto_layout() {
re_log::trace!(
"Container visibility changed - will no longer auto-layout"
);
}
self.set_auto_layout(false, ctx);
container.set_visible(ctx, visible);
}
} else {
re_log::warn_once!(
"Visibility change failed due to unknown container id {container_id:?}"
);
}
}
Contents::View(view_id) => {
if let Some(view) = self.view(view_id) {
if visible != view.visible {
if self.auto_layout() {
re_log::trace!("view visibility changed - will no longer auto-layout");
}
self.set_auto_layout(false, ctx);
view.set_visible(ctx, visible);
}
} else {
re_log::warn_once!(
"Visibility change failed due to unknown view id {view_id:?}"
);
}
}
}
}
#[allow(clippy::unused_self)]
pub fn views_containing_entity_path(
&self,
ctx: &ViewerContext<'_>,
path: &EntityPath,
) -> Vec<ViewId> {
self.views
.iter()
.filter_map(|(view_id, view)| {
let query_result = ctx.lookup_query_result(view.id);
if query_result.tree.lookup_result_by_path(path).is_some() {
Some(*view_id)
} else {
None
}
})
.collect()
}
/// Whether the viewport layout is determined automatically.
///
/// If `true`, we auto-layout all views whenever a new view is added.
///
/// Set to `false` the first time the user messes around with the viewport blueprint.
#[inline]
pub fn auto_layout(&self) -> bool {
self.auto_layout.load(Ordering::SeqCst)
}
/// Whether the viewport layout is determined automatically.
///
/// If `true`, we auto-layout all views whenever a new view is added.
///
/// Set to `false` the first time the user messes around with the viewport blueprint.
#[inline]
pub fn set_auto_layout(&self, value: bool, ctx: &ViewerContext<'_>) {
let old_value = self.auto_layout.swap(value, Ordering::SeqCst);
if old_value != value {
let auto_layout = AutoLayout::from(value);
ctx.save_blueprint_component(&VIEWPORT_PATH.into(), &auto_layout);
}
}
/// Whether views should be created automatically for entities that are not already in a space.
#[inline]
pub fn auto_views(&self) -> bool {
self.auto_views.load(Ordering::SeqCst)
}
/// Whether views should be created automatically for entities that are not already in a space.
#[inline]
pub fn set_auto_views(&self, value: bool, ctx: &ViewerContext<'_>) {
let old_value = self.auto_views.swap(value, Ordering::SeqCst);
if old_value != value {
let auto_views = AutoViews::from(value);
ctx.save_blueprint_component(&VIEWPORT_PATH.into(), &auto_views);
}
}
#[inline]
pub fn set_maximized(&self, view_id: Option<ViewId>, ctx: &ViewerContext<'_>) {
if self.maximized != view_id {
let view_maximized = view_id.map(|id| ViewMaximized(id.into()));
ctx.save_blueprint_component(&VIEWPORT_PATH.into(), &view_maximized);
}
}
/// Save the current state of the viewport to the blueprint store.
/// This should only be called if the tree was edited.
pub fn save_tree_as_containers(&self, ctx: &ViewerContext<'_>) {
re_tracing::profile_function!();
re_log::trace!("Saving tree: {:#?}", self.tree);
// First, update the mapping for all the previously known containers.
// These were inserted with their ids, so we want to keep these
// constant if we find them again.
let mut contents_from_tile_id: HashMap<TileId, Contents> = self
.containers
.keys()
.map(|id| (blueprint_id_to_tile_id(id), Contents::Container(*id)))
.collect();
// Now, update the content mapping for all the new tiles in the tree.
for (tile_id, tile) in self.tree.tiles.iter() {
// If we already know about this tile, then we don't need
// to do anything.
if contents_from_tile_id.contains_key(tile_id) {
continue;
}
match tile {
egui_tiles::Tile::Pane(view_id) => {
// If a container has a pointer to a view
// we want it to point at the view in the blueprint.
contents_from_tile_id.insert(*tile_id, Contents::View(*view_id));
}
egui_tiles::Tile::Container(container) => {
if self.tree.root != Some(*tile_id)
&& container.kind() == egui_tiles::ContainerKind::Tabs
&& container.num_children() == 1
{
// If this is a tab-container with a single child, then it might be a
// "Trivial Tab", which egui_tiles adds to all views during simplification
// but doesn't need to be persisted back to the store.
if let Some(egui_tiles::Tile::Pane(view_id)) = container
.children()
.next()
.and_then(|child| self.tree.tiles.get(*child))
{
// This is a trivial tab -- this tile can point directly to
// the View and not to a Container.
contents_from_tile_id.insert(*tile_id, Contents::View(*view_id));
continue;
}
}
// If this wasn't a container we knew about and wasn't a trivial container
// we will need to create a new container for it.
let container_id = ContainerId::random();
contents_from_tile_id.insert(*tile_id, Contents::Container(container_id));
}
}
}
// Clear any existing container blueprints that aren't referenced by any tiles,
// allowing the GC to remove the previous (non-clear) data from the store (saving RAM).
for (container_id, container) in &self.containers {
let tile_id = blueprint_id_to_tile_id(container_id);
if self.tree.tiles.get(tile_id).is_none() {
container.clear(ctx);
}
}
// Now save any contents that are a container back to the blueprint
for (tile_id, contents) in &contents_from_tile_id {
if let Contents::Container(container_id) = contents {
if let Some(egui_tiles::Tile::Container(container)) = self.tree.tiles.get(*tile_id)
{
let visible = self.tree.is_visible(*tile_id);
// TODO(jleibs): Make this only update the changed fields.
let blueprint = ContainerBlueprint::from_egui_tiles_container(
*container_id,
container,
visible,
&contents_from_tile_id,
);
blueprint.save_to_blueprint_store(ctx);
}
}
}
// Finally update the root
if let Some(root_container) = self
.tree
.root()
.and_then(|root| contents_from_tile_id.get(&root))
.and_then(|contents| contents.as_container_id())
.map(|container_id| RootContainer((container_id).into()))
{
re_log::trace!("Saving with a root container");
ctx.save_blueprint_component(&VIEWPORT_PATH.into(), &root_container);
} else {
re_log::trace!("Saving empty viewport");
ctx.save_empty_blueprint_component::<RootContainer>(&VIEWPORT_PATH.into());
}
}
}
fn build_tree_from_views_and_containers<'a>(
views: impl Iterator<Item = &'a ViewBlueprint>,
containers: impl Iterator<Item = &'a ContainerBlueprint>,
root_container: ContainerId,
) -> egui_tiles::Tree<ViewId> {
re_tracing::profile_function!();
let mut tree = egui_tiles::Tree::empty("viewport_tree");
// First add all the views
for view in views {
let tile_id = blueprint_id_to_tile_id(&view.id);
let pane = egui_tiles::Tile::Pane(view.id);
tree.tiles.insert(tile_id, pane);
tree.set_visible(tile_id, view.visible);
}
// Now add all the containers
for container in containers {
let tile_id = blueprint_id_to_tile_id(&container.id);
tree.tiles.insert(tile_id, container.to_tile());
tree.set_visible(tile_id, container.visible);
}
// And finally, set the root
tree.root = Some(blueprint_id_to_tile_id(&root_container));
tree
}