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
use ahash::HashSet;
use itertools::Itertools;
use nohash_hasher::IntSet;
use re_entity_db::EntityDb;
use re_log_types::EntityPath;
use re_space_view::view_property_ui;
use re_types::View;
use re_types::{
blueprint::archetypes::Background, components::ViewCoordinates, Loggable,
SpaceViewClassIdentifier,
};
use re_ui::UiExt as _;
use re_viewer_context::{
ApplicableEntities, IdentifiedViewSystem, IndicatedEntities, PerVisualizer,
RecommendedSpaceView, SmallVisualizerSet, SpaceViewClass, SpaceViewClassRegistryError,
SpaceViewId, SpaceViewSpawnHeuristics, SpaceViewState, SpaceViewStateExt as _,
SpaceViewSystemExecutionError, ViewQuery, ViewSystemIdentifier, ViewerContext,
VisualizableEntities, VisualizableFilterContext,
};
use crate::visualizers::{AxisLengthDetector, CamerasVisualizer, Transform3DArrowsVisualizer};
use crate::{
contexts::register_spatial_contexts,
heuristics::default_visualized_entities_for_visualizer_kind,
spatial_topology::{HeuristicHints, SpatialTopology, SubSpaceConnectionFlags},
ui::{format_vector, SpatialSpaceViewState},
view_kind::SpatialSpaceViewKind,
visualizers::register_3d_spatial_visualizers,
};
#[derive(Default)]
pub struct VisualizableFilterContext3D {
// TODO(andreas): Would be nice to use `EntityPathHash` in order to avoid bumping reference counters.
pub entities_in_main_3d_space: IntSet<EntityPath>,
pub entities_under_pinholes: IntSet<EntityPath>,
}
impl VisualizableFilterContext for VisualizableFilterContext3D {
fn as_any(&self) -> &dyn std::any::Any {
self
}
}
#[derive(Default)]
pub struct SpatialSpaceView3D;
type ViewType = re_types::blueprint::views::Spatial3DView;
impl SpaceViewClass for SpatialSpaceView3D {
fn identifier() -> SpaceViewClassIdentifier {
ViewType::identifier()
}
fn display_name(&self) -> &'static str {
"3D"
}
fn icon(&self) -> &'static re_ui::Icon {
&re_ui::icons::SPACE_VIEW_3D
}
fn help_markdown(&self, egui_ctx: &egui::Context) -> String {
super::ui_3d::help_markdown(egui_ctx)
}
fn new_state(&self) -> Box<dyn SpaceViewState> {
Box::<SpatialSpaceViewState>::default()
}
fn on_register(
&self,
system_registry: &mut re_viewer_context::SpaceViewSystemRegistrator<'_>,
) -> Result<(), SpaceViewClassRegistryError> {
// Ensure spatial topology is registered.
crate::spatial_topology::SpatialTopologyStoreSubscriber::subscription_handle();
crate::transform_component_tracker::TransformComponentTrackerStoreSubscriber::subscription_handle();
register_spatial_contexts(system_registry)?;
register_3d_spatial_visualizers(system_registry)?;
Ok(())
}
fn preferred_tile_aspect_ratio(&self, _state: &dyn SpaceViewState) -> Option<f32> {
None
}
fn layout_priority(&self) -> re_viewer_context::SpaceViewClassLayoutPriority {
re_viewer_context::SpaceViewClassLayoutPriority::High
}
fn recommended_root_for_entities(
&self,
entities: &IntSet<EntityPath>,
entity_db: &EntityDb,
) -> Option<EntityPath> {
let common_ancestor = EntityPath::common_ancestor_of(entities.iter());
// For 3D space view, the origin of the subspace defined by the common ancestor is usually
// the best choice. However, if the subspace is defined by a pinhole, we should use its
// parent.
//
// Also, if a ViewCoordinate3D is logged somewhere between the common ancestor and the
// subspace origin, we use it as origin.
SpatialTopology::access(&entity_db.store_id(), |topo| {
let common_ancestor_subspace = topo.subspace_for_entity(&common_ancestor);
// Consider the case where the common ancestor might be in a 2D space that is connected
// to a parent space. In this case, the parent space is the correct space.
let subspace = if common_ancestor_subspace.supports_3d_content() {
Some(common_ancestor_subspace)
} else {
topo.subspace_for_subspace_origin(common_ancestor_subspace.parent_space)
};
let subspace_origin = subspace.map(|subspace| subspace.origin.clone());
// Find the first ViewCoordinates3d logged, walking up from the common ancestor to the
// subspace origin.
EntityPath::incremental_walk(subspace_origin.as_ref(), &common_ancestor)
.collect::<Vec<_>>()
.into_iter()
.rev()
.find(|path| {
subspace.is_some_and(|subspace| {
subspace
.heuristic_hints
.get(path)
.is_some_and(|hint| hint.contains(HeuristicHints::ViewCoordinates3d))
})
})
.or(subspace_origin)
})
.flatten()
}
fn visualizable_filter_context(
&self,
space_origin: &EntityPath,
entity_db: &re_entity_db::EntityDb,
) -> Box<dyn VisualizableFilterContext> {
re_tracing::profile_function!();
// TODO(andreas): The `VisualizableFilterContext` depends entirely on the spatial topology.
// If the topology hasn't changed, we don't need to recompute any of this.
// Also, we arrive at the same `VisualizableFilterContext` for lots of different origins!
let context = SpatialTopology::access(&entity_db.store_id(), |topo| {
let primary_space = topo.subspace_for_entity(space_origin);
if !primary_space.supports_3d_content() {
// If this is strict 2D space, only display the origin entity itself.
// Everything else we have to assume requires some form of transformation.
return VisualizableFilterContext3D {
entities_in_main_3d_space: std::iter::once(space_origin.clone()).collect(),
entities_under_pinholes: Default::default(),
};
}
// All entities in the 3D space are visualizable + everything under pinholes.
let mut entities_in_main_3d_space = primary_space.entities.clone();
let mut entities_under_pinholes = IntSet::<EntityPath>::default();
for child_origin in &primary_space.child_spaces {
let Some(child_space) = topo.subspace_for_subspace_origin(child_origin.hash())
else {
// Should never happen, implies that a child space is not in the list of subspaces.
continue;
};
if child_space
.connection_to_parent
.contains(SubSpaceConnectionFlags::Pinhole)
{
// Note that for this the connection to the parent is allowed to contain the disconnected flag.
// Entities _at_ pinholes are a special case: we display both 3D and 2D visualizers for them.
entities_in_main_3d_space.insert(child_space.origin.clone());
entities_under_pinholes.extend(child_space.entities.iter().cloned());
}
}
VisualizableFilterContext3D {
entities_in_main_3d_space,
entities_under_pinholes,
}
});
Box::new(context.unwrap_or_default())
}
/// Choose the default visualizers to enable for this entity.
fn choose_default_visualizers(
&self,
entity_path: &EntityPath,
applicable_entities_per_visualizer: &PerVisualizer<ApplicableEntities>,
visualizable_entities_per_visualizer: &PerVisualizer<VisualizableEntities>,
indicated_entities_per_visualizer: &PerVisualizer<IndicatedEntities>,
) -> SmallVisualizerSet {
let arrows_viz = Transform3DArrowsVisualizer::identifier();
let axis_detector = AxisLengthDetector::identifier();
let camera_viz = CamerasVisualizer::identifier();
let applicable: HashSet<&ViewSystemIdentifier> = applicable_entities_per_visualizer
.iter()
.filter_map(|(visualizer, ents)| {
if ents.contains(entity_path) {
Some(visualizer)
} else {
None
}
})
.collect();
let visualizable: HashSet<&ViewSystemIdentifier> = visualizable_entities_per_visualizer
.iter()
.filter_map(|(visualizer, ents)| {
if ents.contains(entity_path) {
Some(visualizer)
} else {
None
}
})
.collect();
// We never want to consider `Transform3DArrows` as directly indicated since it uses the
// the Transform3D archetype. This is often used to transform other 3D primitives, where
// it might be annoying to always have the arrows show up.
let indicated: HashSet<&ViewSystemIdentifier> = indicated_entities_per_visualizer
.iter()
.filter_map(|(visualizer, ents)| {
if visualizer != &arrows_viz && ents.contains(entity_path) {
Some(visualizer)
} else {
None
}
})
.collect();
// Start with all the entities which are both indicated and visualizable.
let mut chosen: SmallVisualizerSet = indicated
.intersection(&visualizable)
.copied()
.copied()
.collect();
// There are three cases where we want to activate the [`Transform3DArrowVisualizer`]:
// - If we have no visualizers, but otherwise meet the criteria for Transform3DArrows.
// - If someone set an axis_length explicitly, so [`AxisLengthDetector`] is applicable.
// - If we already have the [`CamerasVisualizer`] active.
if !chosen.contains(&arrows_viz)
&& visualizable.contains(&arrows_viz)
&& ((chosen.is_empty() && visualizable.contains(&arrows_viz))
|| applicable.contains(&axis_detector)
|| chosen.contains(&camera_viz))
{
chosen.push(arrows_viz);
}
chosen
}
fn spawn_heuristics(
&self,
ctx: &ViewerContext<'_>,
) -> re_viewer_context::SpaceViewSpawnHeuristics {
re_tracing::profile_function!();
let mut indicated_entities = default_visualized_entities_for_visualizer_kind(
ctx,
Self::identifier(),
SpatialSpaceViewKind::ThreeD,
);
// ViewCoordinates is a strong indicator that a 3D space view is needed.
// Note that if the root has `ViewCoordinates`, this will stop the root splitting heuristic
// from splitting the root space into several subspaces.
//
// TODO(andreas):
// It's tempting to add a visualizer for view coordinates so that it's already picked up via `entities_with_indicator_for_visualizer_kind`.
// Is there a nicer way for this or do we want a visualizer for view coordinates anyways?
// There's also a strong argument to be made that ViewCoordinates implies a 3D space, thus changing the SpacialTopology accordingly!
let engine = ctx.recording_engine();
ctx.recording().tree().visit_children_recursively(|path| {
if engine
.store()
.entity_has_component(path, &ViewCoordinates::name())
{
indicated_entities.insert(path.clone());
}
});
// Spawn a space view at each subspace that has any potential 3D content.
// Note that visualizability filtering is all about being in the right subspace,
// so we don't need to call the visualizers' filter functions here.
SpatialTopology::access(&ctx.recording_id(), |topo| {
SpaceViewSpawnHeuristics::new(
topo.iter_subspaces()
.filter_map(|subspace| {
if !subspace.supports_3d_content() {
return None;
}
let mut pinhole_child_spaces = subspace
.child_spaces
.iter()
.filter(|child| {
topo.subspace_for_subspace_origin(child.hash()).map_or(
false,
|child_space| {
child_space.connection_to_parent.is_connected_pinhole()
},
)
})
.peekable(); // Don't collect the iterator, we're only interested in 'any'-style operations.
// Empty space views are still of interest if any of the child spaces is connected via a pinhole.
if subspace.entities.is_empty() && pinhole_child_spaces.peek().is_none() {
return None;
}
// Creates space views at each view coordinates if there's any.
// (yes, we do so even if they're empty at the moment!)
//
// An exception to this rule is not to create a view there if this is already _also_ a subspace root.
// (e.g. this also has a camera or a `disconnect` logged there)
let mut origins = subspace
.heuristic_hints
.iter()
.filter(|(path, hint)| {
hint.contains(HeuristicHints::ViewCoordinates3d)
&& !subspace.child_spaces.contains(path)
})
.map(|(path, _)| path.clone())
.collect::<Vec<_>>();
let path_not_covered_yet =
|e: &EntityPath| origins.iter().all(|origin| !e.starts_with(origin));
// If there's no view coordinates or there are still some entities not covered,
// create a view at the subspace origin.
if !origins.iter().contains(&subspace.origin)
&& (indicated_entities
.intersection(&subspace.entities)
.any(path_not_covered_yet)
|| pinhole_child_spaces.any(path_not_covered_yet))
{
origins.push(subspace.origin.clone());
}
Some(origins.into_iter().map(RecommendedSpaceView::new_subtree))
})
.flatten(),
)
})
.unwrap_or_default()
}
fn selection_ui(
&self,
ctx: &re_viewer_context::ViewerContext<'_>,
ui: &mut egui::Ui,
state: &mut dyn SpaceViewState,
space_origin: &EntityPath,
view_id: SpaceViewId,
) -> Result<(), SpaceViewSystemExecutionError> {
let state = state.downcast_mut::<SpatialSpaceViewState>()?;
let scene_view_coordinates = ctx
.recording()
.latest_at_component::<ViewCoordinates>(space_origin, &ctx.current_query())
.map(|(_index, c)| c);
// TODO(andreas): list_item'ify the rest
ui.selection_grid("spatial_settings_ui").show(ui, |ui| {
ui.grid_left_hand_label("Camera")
.on_hover_text("The virtual camera which controls what is shown on screen");
ui.vertical(|ui| {
state.view_eye_ui(ui, scene_view_coordinates);
});
ui.end_row();
ui.grid_left_hand_label("Coordinates")
.on_hover_text("The world coordinate system used for this view");
ui.vertical(|ui| {
let up_description =
if let Some(scene_up) = scene_view_coordinates.and_then(|vc| vc.up()) {
format!("Scene up is {scene_up}")
} else {
"Scene up is unspecified".to_owned()
};
ui.label(up_description).on_hover_ui(|ui| {
ui.markdown_ui("Set with `rerun.ViewCoordinates`.");
});
if let Some(eye) = &state.state_3d.view_eye {
if let Some(eye_up) = eye.eye_up() {
ui.label(format!(
"Current camera-eye up-axis is {}",
format_vector(eye_up)
));
}
}
ui.re_checkbox(&mut state.state_3d.show_axes, "Show origin axes")
.on_hover_text("Show X-Y-Z axes");
ui.re_checkbox(&mut state.state_3d.show_bbox, "Show bounding box")
.on_hover_text("Show the current scene bounding box");
ui.re_checkbox(
&mut state.state_3d.show_smoothed_bbox,
"Show smoothed bounding box",
)
.on_hover_text("Show a smoothed bounding box used for some heuristics");
});
ui.end_row();
state.bounding_box_ui(ui, SpatialSpaceViewKind::ThreeD);
});
re_ui::list_item::list_item_scope(ui, "spatial_view3d_selection_ui", |ui| {
view_property_ui::<Background>(ctx, ui, view_id, self, state);
});
Ok(())
}
fn ui(
&self,
ctx: &ViewerContext<'_>,
ui: &mut egui::Ui,
state: &mut dyn SpaceViewState,
query: &ViewQuery<'_>,
system_output: re_viewer_context::SystemExecutionOutput,
) -> Result<(), SpaceViewSystemExecutionError> {
re_tracing::profile_function!();
let state = state.downcast_mut::<SpatialSpaceViewState>()?;
state.update_frame_statistics(ui, &system_output, SpatialSpaceViewKind::ThreeD);
self.view_3d(ctx, ui, state, query, system_output)
}
}