Struct re_viewport_blueprint::ViewContents

pub struct ViewContents {
    pub blueprint_entity_path: EntityPath,
    pub view_class_identifier: ViewClassIdentifier,
    pub entity_path_filter: EntityPathFilter,
}

Data to be added to a view, built from a blueprint_archetypes::ViewContents.

During execution, it will walk an EntityTree and return a DataResultTree containing any entities that match a EntityPathFilter.

Note: ViewContents doesn’t implement Clone because it depends on its parent’s ViewId used for identifying the path of its data in the blueprint store. It’s ambiguous whether the intent is for a clone to write to the same place.

If you want a new view otherwise identical to an existing one, use ViewBlueprint::duplicate.

Fields

blueprint_entity_path: EntityPath

view_class_identifier: ViewClassIdentifier

entity_path_filter: EntityPathFilter

Implementations

impl ViewContents

pub fn is_equivalent(&self, other: &Self) -> bool

pub fn entity_path_filter_is_superset_of(&self, other: &Self) -> bool

Checks whether the results of this query “fully contains” the results of another query.

If this returns true then the DataQueryResult returned by this query should always contain any EntityPath that would be included in the results of the other query.

This is a conservative estimate, and may return false in situations where the query does in fact cover the other query. However, it should never return true in a case where the other query would not be fully covered.

impl ViewContents

pub fn new( id: ViewId, view_class_identifier: ViewClassIdentifier, entity_path_filter: EntityPathFilter, ) -> Self

Creates a new ViewContents.

This ViewContents is ephemeral. It must be saved by calling save_to_blueprint_store on the enclosing ViewBlueprint.

pub fn from_db_or_default( view_id: ViewId, blueprint_db: &EntityDb, query: &LatestAtQuery, view_class_identifier: ViewClassIdentifier, space_env: &EntityPathSubs, ) -> Self

Attempt to load a ViewContents from the blueprint store.

pub fn save_to_blueprint_store(&self, ctx: &ViewerContext<'_>)

Persist the entire ViewContents to the blueprint store.

This only needs to be called if the ViewContents was created with Self::new.

Otherwise, incremental calls to set_ functions will write just the necessary component update directly to the store.

pub fn set_entity_path_filter( &self, ctx: &ViewerContext<'_>, new_entity_path_filter: &EntityPathFilter, )

Set the entity path filter. WARNING: a single mutation is allowed per frame, or data will be lost.

pub fn build_resolver<'a>( &self, view_class_registry: &'a ViewClassRegistry, view: &'a ViewBlueprint, applicable_entities_per_visualizer: &'a PerVisualizer<ApplicableEntities>, visualizable_entities_per_visualizer: &'a PerVisualizer<VisualizableEntities>, indicated_entities_per_visualizer: &'a PerVisualizer<IndicatedEntities>, ) -> DataQueryPropertyResolver<'a>

pub fn mutate_entity_path_filter( &self, ctx: &ViewerContext<'_>, f: impl FnOnce(&mut EntityPathFilter), )

Perform arbitrary mutation on the entity path filter. WARNING: a single mutation is allowed per frame, or data will be lost.

This method exists because of the single mutation per frame limitation. It currently is the only way to perform multiple mutations on the entity path filter in a single frame.

pub fn remove_subtree_and_matching_rules( &self, ctx: &ViewerContext<'_>, path: EntityPath, )

Remove a subtree and any existing rules that it would match. WARNING: a single mutation is allowed per frame, or data will be lost.

Because most-specific matches win, if we only add a subtree exclusion it can still be overridden by existing inclusions. This method ensures that not only do we add a subtree exclusion, but clear out any existing inclusions or (now redundant) exclusions that would match the subtree.

pub fn raw_add_entity_exclusion( &self, ctx: &ViewerContext<'_>, rule: EntityPathRule, )

Directly add an exclusion rule to the EntityPathFilter. WARNING: a single mutation is allowed per frame, or data will be lost.

This is a direct modification of the filter and will not do any simplification related to overlapping or conflicting rules.

If you are trying to remove an entire subtree, prefer using Self::remove_subtree_and_matching_rules.

pub fn raw_add_entity_inclusion( &self, ctx: &ViewerContext<'_>, rule: EntityPathRule, )

Directly add an inclusion rule to the EntityPathFilter. WARNING: a single mutation is allowed per frame, or data will be lost.

This is a direct modification of the filter and will not do any simplification related to overlapping or conflicting rules.

pub fn remove_filter_rule_for( &self, ctx: &ViewerContext<'_>, ent_path: &EntityPath, )

Remove rules for a given entity. WARNING: a single mutation is allowed per frame, or data will be lost.

pub fn execute_query( &self, ctx: &StoreContext<'_>, view_class_registry: &ViewClassRegistry, blueprint_query: &LatestAtQuery, view_id: ViewId, visualizable_entities_for_visualizer_systems: &PerVisualizer<VisualizableEntities>, ) -> DataQueryResult

Build up the initial DataQueryResult for this ViewContents

Note that this result will not have any resolved PropertyOverrides. Those can be added by separately calling DataQueryPropertyResolver::update_overrides on the result.

Trait Implementations

impl Clone for ViewContents

fn clone(&self) -> ViewContents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewContents

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

Formats the value using the given formatter.