Struct re_entity_db::entity_tree::EntityTree

pub struct EntityTree {
    pub path: EntityPath,
    pub children: BTreeMap<EntityPathPart, EntityTree>,
    pub entity: EntityInfo,
    pub subtree: SubtreeInfo,
}

A recursive, manually updated re_data_store::StoreSubscriber that maintains the entity hierarchy.

The tree contains a list of subtrees, and so on recursively.

Fields

path: EntityPath

Full path prefix to the root of this (sub)tree.

children: BTreeMap<EntityPathPart, EntityTree>

Direct descendants of this (sub)tree.

entity: EntityInfo

Information about this specific entity (excluding children).

subtree: SubtreeInfo

Info about this subtree, including all children, recursively.

Implementations

impl EntityTree

pub fn root() -> Self

pub fn new( path: EntityPath, recursive_clears: BTreeMap<RowId, TimePoint> ) -> Self

pub fn is_leaf(&self) -> bool

Has no child entities.

pub fn num_children_and_fields(&self) -> usize

pub fn num_static_messages_recursive(&self) -> u64

Number of timeless messages in this tree, or any child, recursively.

pub fn time_histogram_for_component( &self, timeline: &Timeline, component_name: impl Into<ComponentName> ) -> Option<&TimeHistogram>

pub fn on_store_additions(&mut self, events: &[StoreEvent]) -> ClearCascade

Updates the EntityTree by applying a batch of StoreEvents.

Returns an ClearCascade that describes the cascading side-effects to be applied to the DataStore as a result, if any. See ClearCascade’s documentation for more information.

Only reacts to additions (event.kind == StoreDiffKind::Addition).

pub fn on_store_deletions( &mut self, store_events: &[&StoreEvent], compacted: &CompactedStoreEvents )

Updates the EntityTree by applying a batch of StoreEvents.

Returns an ClearCascade that describes a list of deletions that should be applied to the store as a result.

Only reacts to additions (event.kind == StoreDiffKind::Addition).

pub fn subtree(&self, path: &EntityPath) -> Option<&Self>

pub fn visit_children_recursively( &self, visitor: &mut impl FnMut(&EntityPath, &EntityInfo) )

Trait Implementations

impl StoreSubscriber for EntityTree

fn name(&self) -> String

Arbitrary name for the subscriber.

fn as_any(&self) -> &dyn Any

Workaround for downcasting support, simply return self:

fn as_any_mut(&mut self) -> &mut dyn Any

Workaround for downcasting support, simply return self:

fn on_events(&mut self, _events: &[StoreEvent])

The core of this trait: get notified of changes happening in all DataStores.