Struct re_viewer_context::DataResult

pub struct DataResult {
    pub entity_path: EntityPath,
    pub visualizers: SmallVisualizerSet,
    pub tree_prefix_only: bool,
    pub property_overrides: PropertyOverrides,
}

This is the primary mechanism through which data is passed to a SpaceView.

It contains everything necessary to properly use this data in the context of the ViewSystems that it is a part of.

Fields

entity_path: EntityPath

Where to retrieve the data from.

visualizers: SmallVisualizerSet

Which ViewSystemss to pass the DataResult to.

tree_prefix_only: bool

If true, this path is not actually included in the query results and is just here because of a common prefix.

If this is true, visualizers must be empty.

property_overrides: PropertyOverrides

The accumulated property overrides for this DataResult.

Implementations

impl DataResult

pub const INDIVIDUAL_OVERRIDES_PREFIX: &'static str = "individual_overrides"

pub const RECURSIVE_OVERRIDES_PREFIX: &'static str = "recursive_overrides"

pub fn recursive_override_path(&self) -> &EntityPath

pub fn individual_override_path(&self) -> &EntityPath

pub fn save_recursive_override_or_clear_if_redundant<C: Component + Eq + Default>( &self, ctx: &ViewerContext<'_>, data_result_tree: &DataResultTree, desired_override: &C )

Saves a recursive override OR clears both (!) individual & recursive overrides if the override is due to a parent recursive override or a default value.

fn lookup_override<C: 'static + Component>( &self, ctx: &ViewerContext<'_> ) -> Option<C>

pub fn component_override_source( &self, result_tree: &DataResultTree, component_name: ComponentName ) -> Option<EntityPath>

Returns from which entity path an override originates from.

Returns None if there was no override at all. Note that if this returns the current path, the override might be either an individual or recursive override.

pub fn is_inherited( &self, result_tree: &DataResultTree, component_name: ComponentName ) -> bool

Returns true if the current component’s value was inherited from a parent entity.

pub fn is_visible(&self, ctx: &ViewerContext<'_>) -> bool

Shorthand for checking for visibility on data overrides.

Note that this won’t check if the chunk store has visibility logged.

pub fn is_interactive(&self, ctx: &ViewerContext<'_>) -> bool

Shorthand for checking for interactivity on data overrides.

Note that this won’t check if the chunk store has interactivity logged.

pub fn query_range(&self) -> &QueryRange

Returns the query range for this data result.

Trait Implementations

impl Clone for DataResult

fn clone(&self) -> DataResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataResult

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

Formats the value using the given formatter.