Struct re_viewer_context::space_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>,
    applicability_filter: Box<dyn VisualizerAdditionalApplicabilityFilter>,
}

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 applicable to the visualizer, it will be kept in the list of entities.

Applicability is determined by the visualizer’s set of required components.

There’s only a single entity subscriber per visualizer type. This means that if the same visualizer is used in multiple space 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>

applicability_filter: Box<dyn VisualizerAdditionalApplicabilityFilter>

Additional filter for applicability.

Implementations

impl VisualizerEntitySubscriber

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

pub fn applicable_entities( &self, store: &StoreId ) -> Option<&ApplicableEntities>

List of entities that are applicable to 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 applicable-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.