Struct ViewProperty

pub struct ViewProperty {
    pub blueprint_store_path: EntityPath,
    /* private fields */
}

Utility for querying view properties.

Fields

blueprint_store_path: EntityPath

Entity path in the blueprint store where all components of this view property archetype are stored.

Implementations

impl ViewProperty

pub fn from_archetype<A: Archetype>( blueprint_db: &EntityDb, blueprint_query: &LatestAtQuery, view_id: SpaceViewId, ) -> Self

Query a specific view property for a given view.

pub fn component_or_fallback<C: Component + Default>( &self, ctx: &ViewerContext<'_>, fallback_provider: &dyn ComponentFallbackProvider, view_state: &dyn SpaceViewState, ) -> Result<C, ViewPropertyQueryError>

Get the value of a specific component or its fallback if the component is not present.

pub fn component_array_or_fallback<C: Component + Default>( &self, ctx: &ViewerContext<'_>, fallback_provider: &dyn ComponentFallbackProvider, view_state: &dyn SpaceViewState, ) -> Result<Vec<C>, ViewPropertyQueryError>

Get the component array for a given type or its fallback if the component is not present or empty.

pub fn component_or_empty<C: Component>( &self, ) -> Result<Option<C>, DeserializationError>

Get a single component or None, not using any fallbacks.

pub fn component_array<C: Component>( &self, ) -> Result<Option<Vec<C>>, DeserializationError>

Get the component array for a given type, not using any fallbacks.

pub fn component_array_or_empty<C: Component>( &self, ) -> Result<Vec<C>, DeserializationError>

Get the component array for a given type or an empty array, not using any fallbacks.

pub fn component_row_id(&self, component_name: ComponentName) -> Option<RowId>

pub fn component_raw( &self, component_name: ComponentName, ) -> Option<Box<dyn Array>>

pub fn save_blueprint_component( &self, ctx: &ViewerContext<'_>, components: &dyn ComponentBatch, )

Save change to a blueprint component.

pub fn clear_blueprint_component<C: Component>(&self, ctx: &ViewerContext<'_>)

Clears a blueprint component.

pub fn reset_blueprint_component<C: Component>(&self, ctx: &ViewerContext<'_>)

Resets a blueprint component to the value it had in the default blueprint.

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

Resets all components to the values they had in the default blueprint.

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

Resets all components to empty values, i.e. the fallback.

pub fn any_non_empty(&self) -> bool

Returns whether any property is non-empty.

pub fn query_context<'a>( &'a self, viewer_ctx: &'a ViewerContext<'_>, view_state: &'a dyn SpaceViewState, ) -> QueryContext<'a>

Create a query context for this view property.