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
use ahash::HashMap;
use indexmap::IndexMap;
use parking_lot::Mutex;
use re_entity_db::EntityPath;
use crate::{item::resolve_mono_instance_path_item, ViewerContext};
use super::{Item, SelectionHistory};
/// Context information that a space view might attach to an item from [`ItemCollection`] and useful
/// for how a selection might be displayed and interacted with.
#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)]
pub enum ItemSpaceContext {
/// Hovering/Selecting in a 2D space.
TwoD {
space_2d: EntityPath,
/// Where in this 2D space (+ depth)?
pos: glam::Vec3,
},
/// Hovering/Selecting in a 3D space.
ThreeD {
/// The 3D space with the camera(s)
space_3d: EntityPath,
/// The point in 3D space that is hovered, if any.
pos: Option<glam::Vec3>,
/// Path to an entity that is currently tracked by the eye-camera.
/// (None for a free floating Eye)
tracked_entity: Option<EntityPath>,
/// Corresponding 2D spaces and pixel coordinates (with Z=depth)
point_in_space_cameras: Vec<(EntityPath, Option<glam::Vec3>)>,
},
}
/// Selection highlight, sorted from weakest to strongest.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Default)]
pub enum SelectionHighlight {
/// No selection highlight at all.
#[default]
None,
/// A closely related object is selected, should apply similar highlight to selection.
/// (e.g. data in a different space view)
SiblingSelection,
/// Should apply selection highlight (i.e. the exact selection is highlighted).
Selection,
}
/// Hover highlight, sorted from weakest to strongest.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Default)]
pub enum HoverHighlight {
/// No hover highlight.
#[default]
None,
/// Apply hover highlight, does *not* exclude a selection highlight.
Hovered,
}
/// Combination of selection & hover highlight which can occur independently.
#[derive(Copy, Clone, PartialEq, Eq, Default)]
pub struct InteractionHighlight {
pub selection: SelectionHighlight,
pub hover: HoverHighlight,
}
impl InteractionHighlight {
/// Picks the stronger selection & hover highlight from two highlight descriptions.
#[inline]
pub fn max(&self, other: Self) -> Self {
Self {
selection: self.selection.max(other.selection),
hover: self.hover.max(other.hover),
}
}
}
/// An ordered collection of [`Item`] and optional associated space context objects.
///
/// Used to store what is currently selected and/or hovered.
#[derive(Debug, Default, Clone, PartialEq, serde::Deserialize, serde::Serialize)]
pub struct ItemCollection(IndexMap<Item, Option<ItemSpaceContext>>);
impl From<Item> for ItemCollection {
#[inline]
fn from(val: Item) -> Self {
Self([(val, None)].into())
}
}
impl<T> From<T> for ItemCollection
where
T: Iterator<Item = (Item, Option<ItemSpaceContext>)>,
{
#[inline]
fn from(value: T) -> Self {
Self(value.collect())
}
}
impl ItemCollection {
/// For each item in this selection, if it refers to the first element of an instance with a
/// single element, resolve it to a unindexed entity path.
pub fn into_mono_instance_path_items(self, ctx: &ViewerContext<'_>) -> Self {
Self(
self.0
.into_iter()
.map(|(item, space_ctx)| {
(
resolve_mono_instance_path_item(
ctx.recording(),
&ctx.current_query(),
&item,
),
space_ctx,
)
})
.collect(),
)
}
/// The first selected object if any.
pub fn first_item(&self) -> Option<&Item> {
self.0.keys().next()
}
/// Check if the selection contains a single item and returns it if so.
pub fn single_item(&self) -> Option<&Item> {
if self.len() == 1 {
self.first_item()
} else {
None
}
}
pub fn iter_items(&self) -> impl Iterator<Item = &Item> {
self.0.keys()
}
pub fn iter_space_context(&self) -> impl Iterator<Item = &ItemSpaceContext> {
self.0
.iter()
.filter_map(|(_, space_context)| space_context.as_ref())
}
/// Returns true if the exact selection is part of the current selection.
pub fn contains_item(&self, needle: &Item) -> bool {
self.0.iter().any(|(item, _)| item == needle)
}
pub fn are_all_items_same_kind(&self) -> Option<&'static str> {
if let Some(first_item) = self.first_item() {
if self
.iter_items()
.skip(1)
.all(|item| std::mem::discriminant(first_item) == std::mem::discriminant(item))
{
return Some(first_item.kind());
}
}
None
}
/// Retains elements that fulfill a certain condition.
pub fn retain(&mut self, f: impl FnMut(&Item, &mut Option<ItemSpaceContext>) -> bool) {
self.0.retain(f);
}
/// Returns the number of items in the selection.
pub fn len(&self) -> usize {
self.0.len()
}
/// Check if the selection is empty.
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
/// Returns an iterator over the items and their selected space context.
pub fn iter(&self) -> impl Iterator<Item = (&Item, &Option<ItemSpaceContext>)> {
self.0.iter()
}
/// Returns a mutable iterator over the items and their selected space context.
pub fn iter_mut(&mut self) -> impl Iterator<Item = (&Item, &mut Option<ItemSpaceContext>)> {
self.0.iter_mut()
}
/// Extend the selection with more items.
pub fn extend(&mut self, other: impl IntoIterator<Item = (Item, Option<ItemSpaceContext>)>) {
self.0.extend(other);
}
}
/// Selection and hover state.
///
/// Both hover and selection are double buffered:
/// Changes from one frame are only visible in the next frame.
#[derive(Default, serde::Deserialize, serde::Serialize)]
#[serde(default)]
pub struct ApplicationSelectionState {
/// History of selections (what was selected previously).
#[serde(skip)]
pub history: Mutex<SelectionHistory>,
/// Selection of the previous frame. Read from this.
selection_previous_frame: ItemCollection,
/// Selection of the current frame. Write to this.
#[serde(skip)]
selection_this_frame: Mutex<ItemCollection>,
/// What objects are hovered? Read from this.
#[serde(skip)]
hovered_previous_frame: ItemCollection,
/// What objects are hovered? Write to this.
#[serde(skip)]
hovered_this_frame: Mutex<ItemCollection>,
}
impl ApplicationSelectionState {
/// Called at the start of each frame
pub fn on_frame_start(
&mut self,
item_retain_condition: impl Fn(&Item) -> bool,
fallback_selection: Option<Item>,
) {
// Use a different name so we don't get a collision in puffin.
re_tracing::profile_scope!("SelectionState::on_frame_start");
// Purge history of invalid items.
let history = self.history.get_mut();
history.retain(&item_retain_condition);
// Purge selection of invalid items.
let selection_this_frame = self.selection_this_frame.get_mut();
selection_this_frame.retain(|item, _| item_retain_condition(item));
if selection_this_frame.is_empty() {
if let Some(fallback_selection) = fallback_selection {
*selection_this_frame = ItemCollection::from(fallback_selection);
}
}
// Hovering needs to be refreshed every frame: If it wasn't hovered last frame, it's no longer hovered!
self.hovered_previous_frame = std::mem::take(self.hovered_this_frame.get_mut());
// Selection in contrast, is sticky!
if selection_this_frame != &self.selection_previous_frame {
history.update_selection(selection_this_frame);
self.selection_previous_frame = selection_this_frame.clone();
}
}
/// Selects the previous element in the history if any.
pub fn select_previous(&self) {
if let Some(selection) = self.history.lock().select_previous() {
*self.selection_this_frame.lock() = selection;
}
}
/// Selections the next element in the history if any.
pub fn select_next(&self) {
if let Some(selection) = self.history.lock().select_next() {
*self.selection_this_frame.lock() = selection;
}
}
/// Clears the current selection out.
pub fn clear_selection(&self) {
self.set_selection(ItemCollection::default());
}
/// Sets several objects to be selected, updating history as needed.
///
/// Clears the selected space context if none was specified.
pub fn set_selection(&self, items: impl Into<ItemCollection>) {
*self.selection_this_frame.lock() = items.into();
}
/// Returns the current selection.
pub fn selected_items(&self) -> &ItemCollection {
&self.selection_previous_frame
}
/// Returns the currently hovered objects.
pub fn hovered_items(&self) -> &ItemCollection {
&self.hovered_previous_frame
}
/// Set the hovered objects. Will be in [`Self::hovered_items`] on the next frame.
pub fn set_hovered(&self, hovered: impl Into<ItemCollection>) {
*self.hovered_this_frame.lock() = hovered.into();
}
/// Select passed objects unless already selected in which case they get unselected.
/// If however an object is already selected but now gets passed a *different* selected space context, it stays selected after all
/// but with an updated selected space context!
pub fn toggle_selection(&self, toggle_items: ItemCollection) {
re_tracing::profile_function!();
let mut toggle_items_set: HashMap<Item, Option<ItemSpaceContext>> = toggle_items
.iter()
.map(|(item, ctx)| (item.clone(), ctx.clone()))
.collect();
let mut new_selection = self.selection_previous_frame.clone();
// If an item was already selected with the exact same context remove it.
// If an item was already selected and loses its context, remove it.
new_selection.retain(|item, ctx| {
if let Some(new_ctx) = toggle_items_set.get(item) {
if new_ctx == ctx || new_ctx.is_none() {
toggle_items_set.remove(item);
false
} else {
true
}
} else {
true
}
});
// Update context for items that are remaining in the toggle_item_set:
for (item, ctx) in new_selection.iter_mut() {
if let Some(new_ctx) = toggle_items_set.get(item) {
*ctx = new_ctx.clone();
toggle_items_set.remove(item);
}
}
// Make sure we preserve the order - old items kept in same order, new items added to the end.
// Add the new items, unless they were toggling out existing items:
new_selection.extend(
toggle_items
.0
.into_iter()
.filter(|(item, _)| toggle_items_set.contains_key(item)),
);
*self.selection_this_frame.lock() = new_selection;
}
pub fn selection_space_contexts(&self) -> impl Iterator<Item = &ItemSpaceContext> {
self.selection_previous_frame.iter_space_context()
}
pub fn hovered_space_context(&self) -> Option<&ItemSpaceContext> {
self.hovered_previous_frame.iter_space_context().next()
}
pub fn highlight_for_ui_element(&self, test: &Item) -> HoverHighlight {
let hovered = self
.hovered_previous_frame
.iter_items()
.any(|current| match current {
Item::AppId(_)
| Item::DataSource(_)
| Item::StoreId(_)
| Item::SpaceView(_)
| Item::Container(_) => current == test,
Item::ComponentPath(component_path) => match test {
Item::AppId(_)
| Item::DataSource(_)
| Item::StoreId(_)
| Item::SpaceView(_)
| Item::Container(_) => false,
Item::ComponentPath(test_component_path) => {
test_component_path == component_path
}
Item::InstancePath(test_instance_path) => {
!test_instance_path.instance.is_specific()
&& test_instance_path.entity_path == component_path.entity_path
}
Item::DataResult(_, test_instance_path) => {
test_instance_path.entity_path == component_path.entity_path
}
},
Item::InstancePath(current_instance_path) => match test {
Item::AppId(_)
| Item::DataSource(_)
| Item::StoreId(_)
| Item::ComponentPath(_)
| Item::SpaceView(_)
| Item::Container(_) => false,
Item::InstancePath(test_instance_path)
| Item::DataResult(_, test_instance_path) => {
current_instance_path.entity_path == test_instance_path.entity_path
&& either_none_or_same(
¤t_instance_path.instance.specific_index(),
&test_instance_path.instance.specific_index(),
)
}
},
Item::DataResult(_current_space_view_id, current_instance_path) => match test {
Item::AppId(_)
| Item::DataSource(_)
| Item::StoreId(_)
| Item::ComponentPath(_)
| Item::SpaceView(_)
| Item::Container(_) => false,
Item::InstancePath(test_instance_path)
| Item::DataResult(_, test_instance_path) => {
current_instance_path.entity_path == test_instance_path.entity_path
&& either_none_or_same(
¤t_instance_path.instance.specific_index(),
&test_instance_path.instance.specific_index(),
)
}
},
});
if hovered {
HoverHighlight::Hovered
} else {
HoverHighlight::None
}
}
}
fn either_none_or_same<T: PartialEq>(a: &Option<T>, b: &Option<T>) -> bool {
a.is_none() || b.is_none() || a == b
}