Struct re_viewer_context::ViewerContext
source · pub struct ViewerContext<'a> {Show 18 fields
pub app_options: &'a AppOptions,
pub cache: &'a Caches,
pub reflection: &'a Reflection,
pub component_ui_registry: &'a ComponentUiRegistry,
pub view_class_registry: &'a ViewClassRegistry,
pub store_context: &'a StoreContext<'a>,
pub maybe_visualizable_entities_per_visualizer: &'a PerVisualizer<MaybeVisualizableEntities>,
pub indicated_entities_per_visualizer: &'a PerVisualizer<IndicatedEntities>,
pub query_results: &'a HashMap<ViewId, DataQueryResult>,
pub rec_cfg: &'a RecordingConfig,
pub blueprint_cfg: &'a RecordingConfig,
pub selection_state: &'a ApplicationSelectionState,
pub blueprint_query: &'a LatestAtQuery,
pub egui_ctx: &'a Context,
pub render_ctx: &'a RenderContext,
pub command_sender: &'a CommandSender,
pub focused_item: &'a Option<Item>,
pub drag_and_drop_manager: &'a DragAndDropManager,
}
Expand description
Common things needed by many parts of the viewer.
Fields§
§app_options: &'a AppOptions
Global options for the whole viewer.
cache: &'a Caches
Things that need caching and are shared across the whole viewer.
Use this only for things that you expected be shared across different panels and/or views.
reflection: &'a Reflection
Runtime info about components and archetypes.
The component placeholder values for components are to be used when crate::ComponentFallbackProvider::try_provide_fallback
is not able to provide a value.
⚠️ In almost all cases you should not use this directly, but instead use the currently best fitting
crate::ComponentFallbackProvider
and call crate::ComponentFallbackProvider::fallback_for
instead.
component_ui_registry: &'a ComponentUiRegistry
How to display components.
view_class_registry: &'a ViewClassRegistry
Registry of all known classes of views.
store_context: &'a StoreContext<'a>
The current view of the store
maybe_visualizable_entities_per_visualizer: &'a PerVisualizer<MaybeVisualizableEntities>
Mapping from class and system to entities for the store
TODO(andreas): This should have a generation id, allowing to update heuristics(?)/visualizable entities etc.
indicated_entities_per_visualizer: &'a PerVisualizer<IndicatedEntities>
For each visualizer, the set of entities that have at least one matching indicator component.
TODO(andreas): Should we always do the intersection with maybe_visualizable_entities_per_visualizer
or are we ever interested in a (definitely-)non-visualizable but indicator-matching entity?
query_results: &'a HashMap<ViewId, DataQueryResult>
All the query results for this frame.
rec_cfg: &'a RecordingConfig
UI config for the current recording (found in EntityDb
).
blueprint_cfg: &'a RecordingConfig
UI config for the current blueprint.
selection_state: &'a ApplicationSelectionState
Selection & hovering state.
blueprint_query: &'a LatestAtQuery
The blueprint query used for resolving blueprint in this frame
egui_ctx: &'a Context
The [egui::Context
].
render_ctx: &'a RenderContext
The global re_renderer
context, holds on to all GPU resources.
command_sender: &'a CommandSender
Interface for sending commands back to the app
focused_item: &'a Option<Item>
Item that got focused on the last frame if any.
The focused item is cleared every frame, but views may react with side-effects that last several frames.
drag_and_drop_manager: &'a DragAndDropManager
Helper object to manage drag-and-drop operations.
Implementations§
source§impl ViewerContext<'_>
impl ViewerContext<'_>
pub fn save_blueprint_archetype( &self, entity_path: &EntityPath, components: &dyn AsComponents, )
pub fn save_blueprint_component( &self, entity_path: &EntityPath, component_batch: &dyn ComponentBatch, )
pub fn save_blueprint_array( &self, entity_path: &EntityPath, component_name: ComponentName, array: ArrayRef, )
sourcepub fn save_empty_blueprint_component<'a, C>(&self, entity_path: &EntityPath)where
C: Component + 'a,
pub fn save_empty_blueprint_component<'a, C>(&self, entity_path: &EntityPath)where
C: Component + 'a,
Helper to save a component to the blueprint store.
sourcepub fn raw_latest_at_in_default_blueprint(
&self,
entity_path: &EntityPath,
component_name: ComponentName,
) -> Option<ArrayRef>
pub fn raw_latest_at_in_default_blueprint( &self, entity_path: &EntityPath, component_name: ComponentName, ) -> Option<ArrayRef>
Queries a raw component from the default blueprint.
sourcepub fn reset_blueprint_component_by_name(
&self,
entity_path: &EntityPath,
component_name: ComponentName,
)
pub fn reset_blueprint_component_by_name( &self, entity_path: &EntityPath, component_name: ComponentName, )
Resets a blueprint component to the value it had in the default blueprint.
sourcepub fn clear_blueprint_component_by_name(
&self,
entity_path: &EntityPath,
component_name: ComponentName,
)
pub fn clear_blueprint_component_by_name( &self, entity_path: &EntityPath, component_name: ComponentName, )
Clears a component in the blueprint store by logging an empty array if it exists.
source§impl ViewerContext<'_>
impl ViewerContext<'_>
pub fn lookup_query_result(&self, id: ViewId) -> &DataQueryResult
source§impl ViewerContext<'_>
impl ViewerContext<'_>
sourcepub fn blueprint_db(&self) -> &EntityDb
pub fn blueprint_db(&self) -> &EntityDb
The active blueprint.
sourcepub fn recording_engine(&self) -> StorageEngineReadGuard<'_>
pub fn recording_engine(&self) -> StorageEngineReadGuard<'_>
The StorageEngine
for the active recording.
sourcepub fn blueprint_engine(&self) -> StorageEngineReadGuard<'_>
pub fn blueprint_engine(&self) -> StorageEngineReadGuard<'_>
The StorageEngine
for the active blueprint.
sourcepub fn recording_id(&self) -> StoreId
pub fn recording_id(&self) -> StoreId
The StoreId
of the active recording.
sourcepub fn selection(&self) -> &ItemCollection
pub fn selection(&self) -> &ItemCollection
Returns the current selection.
sourcepub fn hovered(&self) -> &ItemCollection
pub fn hovered(&self) -> &ItemCollection
Returns the currently hovered objects.
pub fn selection_state(&self) -> &ApplicationSelectionState
sourcepub fn current_query(&self) -> LatestAtQuery
pub fn current_query(&self) -> LatestAtQuery
The current time query, based on the current time control.
sourcepub fn handle_select_hover_drag_interactions(
&self,
response: &Response,
interacted_items: impl Into<ItemCollection>,
draggable: bool,
)
pub fn handle_select_hover_drag_interactions( &self, response: &Response, interacted_items: impl Into<ItemCollection>, draggable: bool, )
Consistently handle the selection, hover, drag start interactions for a given set of items.
The draggable
parameter controls whether a drag can be initiated from this item. When a UI
element represents an crate::Item
, one must make the call whether this element should be
meaningfully draggable by the users. This is ultimately a subjective decision, but some here
are some guidelines:
- Is there a meaningful destination for the dragged payload? For example, dragging stuff out of a modal dialog is by definition meaningless.
- Even if a drag destination exists, would that be obvious to the user?
- Is it expected for that kind of UI element to be draggable? For example, buttons aren’t typically draggable.
Drag vs. selection semantics:
- When dragging an unselected item, that item only is dragged, and the selection is unchanged…
- …unless cmd/ctrl is held, in which case the item is added to the selection and the entire selection is dragged.
- When dragging a selected item, the entire selection is dragged as well.
sourcepub fn placeholder_for(&self, component: ComponentName) -> ArrayRef
pub fn placeholder_for(&self, component: ComponentName) -> ArrayRef
Returns a placeholder value for a given component, solely identified by its name.
A placeholder is an array of the component type with a single element which takes on some default value.
It can be set as part of the reflection information, see re_types_core::reflection::ComponentReflection::custom_placeholder
.
Note that automatically generated placeholders ignore any extension types.
This requires the component name to be known by either datastore or blueprint store and will return a placeholder for a nulltype otherwise, logging an error. The rationale is that to get into this situation, we need to know of a component name for which we don’t have a datatype, meaning that we can’t make any statement about what data this component should represent.
sourcepub fn is_safari_browser(&self) -> bool
pub fn is_safari_browser(&self) -> bool
Are we running inside the Safari browser?
Auto Trait Implementations§
impl<'a> Freeze for ViewerContext<'a>
impl<'a> !RefUnwindSafe for ViewerContext<'a>
impl<'a> Send for ViewerContext<'a>
impl<'a> Sync for ViewerContext<'a>
impl<'a> Unpin for ViewerContext<'a>
impl<'a> !UnwindSafe for ViewerContext<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
source§fn lossless_try_into(self) -> Option<Dst>
fn lossless_try_into(self) -> Option<Dst>
source§impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
source§fn lossy_into(self) -> Dst
fn lossy_into(self) -> Dst
source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.