Struct re_viewer_context::view::visualizer_entity_subscriber::VisualizerEntitySubscriber

pub struct VisualizerEntitySubscriber {
    visualizer: ViewSystemIdentifier,
    indicator_components: ComponentNameSet,
    required_components_indices: IntMap<ComponentName, usize>,
    per_store_mapping: HashMap<StoreId, VisualizerEntityMapping>,
    additional_filter: Box<dyn DataBasedVisualizabilityFilter>,
}

A store subscriber that keep track which entities in a store can be processed by a single given visualizer type.

The list of entities is additive: If an entity was at any point in time passes the “maybe visualizable” filter for the visualizer, it will be kept in the list of entities.

“maybe visualizable” is determined by..

• set of required components
• additional custom data based criteria a visualizer may set

There’s only a single entity subscriber per visualizer type. This means that if the same visualizer is used in multiple views, only a single VisualizerEntitySubscriber is created for all of them.

Fields

visualizer: ViewSystemIdentifier

Visualizer type this subscriber is associated with.

indicator_components: ComponentNameSet

See crate::VisualizerQueryInfo::indicators

required_components_indices: IntMap<ComponentName, usize>

Assigns each required component an index.

per_store_mapping: HashMap<StoreId, VisualizerEntityMapping>

additional_filter: Box<dyn DataBasedVisualizabilityFilter>

Additional filter for visualizability.

Implementations

impl VisualizerEntitySubscriber

pub fn new<T: IdentifiedViewSystem + VisualizerSystem>(visualizer: &T) -> Self

pub fn maybe_visualizable_entities( &self, store: &StoreId, ) -> Option<&MaybeVisualizableEntities>

List of entities that are may be visualizable by the visualizer.

pub fn indicated_entities(&self, store: &StoreId) -> Option<&IndicatedEntities>

List of entities that at some point in time had any of the indicator components advertised by this visualizer.

Useful for quickly evaluating basic “should this visualizer apply by default”-heuristic. Does not imply that any of the given entities is also in the (maybe-)visualizable-set!

If the visualizer has no indicator components, this list will contain all entities in the store.

Trait Implementations

impl ChunkStoreSubscriber for VisualizerEntitySubscriber

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: &[ChunkStoreEvent])

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

fn on_drop(&mut self, store_id: &StoreId)

Notifies a subscriber that an entire store was dropped.