Struct re_entity_db::entity_tree::ClearCascade

pub struct ClearCascade {
    pub to_be_cleared: BTreeMap<RowId, BTreeMap<EntityPath, (TimePoint, BTreeSet<ComponentPath>)>>,
}

Cascaded clears that need be to applied to the DataStore as a result of modifying the EntityTree.

When an EntityTree gets updated with new data, two cascading effects might happen:

1. If the data contains a Clear component, then inserting it will trigger an immediate clear at this specific timepoint, that can affect an arbitrary number of components and, if the Clear is recursive, even an arbitrary number of entity paths. That Clear then lives on and might affect data added later on, which leads us to side-effect #2 described below.

2. If data is inserted at an entity path that is under the influence of a previously logged Clear component, then the insertion will trigger a pending clear for all components at that path.

Clear components themselves are not affected by clears.

Fields

to_be_cleared: BTreeMap<RowId, BTreeMap<EntityPath, (TimePoint, BTreeSet<ComponentPath>)>>

ComponentPaths that should be cleared as a result of the cascade.

Keep in mind: these are the RowIds of the Clear components that triggered the cascades, they are therefore not unique and, by definition, illegal!

Implementations

impl ClearCascade

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for ClearCascade

fn clone(&self) -> ClearCascade

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClearCascade

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClearCascade

fn default() -> ClearCascade

Returns the “default value” for a type.