Expand description
Rerun Viewer context
This crate contains data structures that are shared with most modules of the viewer.
Re-exports§
pub use self::store_hub::StoreHub;
Modules§
- external
- gpu_
bridge - Bridge to
re_renderer - store_
hub - test_
context
Macros§
- impl_
component_ fallback_ provider - Implements the
ComponentFallbackProvidertrait for a given type, using a number ofTypedComponentFallbackProvider.
Structs§
- Annotation
Map - Annotations
- AppOptions
- Global options for the viewer.
- Application
Selection State - Selection and hover state.
- Async
Runtime Handle - Thin abstraction over the async runtime.
- Blueprint
Id - A unique id for a type of Blueprint contents.
- Blueprint
Undo State - We store the entire edit history of a blueprint in its store.
- Caches
- Does memoization of different objects for the immediate mode UI.
- Collapsed
Id - A collapsed identifier.
- Colormap
With Range - Colormap together with the range of image values that is mapped to the colormap’s range.
- Command
Receiver - Receiver for the
CommandSender - Command
Sender - Sender that queues up the execution of commands.
- Component
UiRegistry - How to display components in a Ui.
- Component
UiTypes - Specifies which UI callbacks are available for a component.
- Data
Query Result - The result of executing a single data query for a specific view.
- Data
Result - This is the primary mechanism through which data is passed to a
View. - Data
Result Handle - Identifier for a
DataResultNode - Data
Result Node - A single node in the
DataResultTree - Data
Result Tree - A hierarchical tree of
DataResults - Drag
AndDrop Manager - Helper to handle drag-and-drop operations.
- Edit
Target - Describes where an edit should be written to if any
- Global
Context - Application context that is shared across all parts of the viewer.
- Image
Decode Cache - Caches the results of decoding
re_types::archetypes::EncodedImage. - Image
Info - Represents the contents of an
Image,SegmentationImageorDepthImage. - Image
Stats - Stats about an image.
- Image
Stats Cache - Indicated
Entities - List of entities that contain archetypes that are relevant for a visualizer.
- Interaction
Highlight - Combination of selection & hover highlight which can occur independently.
- Item
Collection - An ordered collection of
Itemand optional associated context objects. - Maybe
Visualizable Entities - List of entities that are maybe visualizable with a given visualizer.
- Optional
View Entity Highlight - Override
Path - Path to a specific entity in a specific store used for overrides.
- PerVisualizer
- Property
Overrides - Published
View Info - Information about a view that is published each frame by
ViewRectPublisher. - Query
Context - Context for a latest-at query in a specific view.
- Recommended
View - Properties of a view that as recommended to be spawned by default via view spawn heuristics.
- Recording
Config - UI config for the current recording (found in
EntityDb). - Resolved
Annotation Info - Screenshot
Info - Info given to egui when taking a screenshot.
- Storage
Context - Provides read-only references over the different kinds of storage used throughout the viewer.
- Store
Context - The current Blueprint and Recording being displayed by the viewer
- Stored
Blob Cache Key - Hash used for identifying blobs stored in a store.
- System
Execution Output - Output of view system execution.
- Table
Store - Tensor
Stats - Stats about a tensor or image.
- Tensor
Stats Cache - Caches tensor stats.
- Time
Control - Controls the global view and progress of the time.
- Time
Control Response - Time
View - The time range we are currently zoomed in on.
- Variant
Name - The name of a UI variant (see [
ComponentUiIdentifier::Variant]). - Video
Asset Cache - Caches videos assets and their players based on media type & row id.
- Video
Stream Cache - Caches metadata and active players for video streams.
- View
Class Registry - Registry of all known view types.
- View
Context - The context associated with a view.
- View
Context Collection - View
Entity Highlight - Highlights of a specific entity path in a specific view.
- View
Highlights - Highlights in a specific view.
- View
Outline Masks - View
Query - View
Spawn Heuristics - Heuristics for spawning views of a given class.
- View
States - State for the
Views that persists across frames but otherwise is not saved. - View
System Identifier - Unique name for a system within a given
crate::ViewClass. - View
System Registrator - Utility for registering view systems, passed on to
crate::ViewClass::on_register. - Viewer
Context - Common things needed by many parts of the viewer.
- Visualizable
Entities - List of entities that can be visualized at some point in time on any timeline by a concrete visualizer in the context of a specific instantiated view.
- Visualizer
Collection - Visualizer
Query Info
Enums§
- Async
Runtime Error - Collapse
Item - The various kinds of items that may be represented and for which we want to track the collapsed state.
- Collapse
Scope - The various scopes for which we want to track collapsed state.
- Component
Fallback Error - Error type for a fallback request.
- Component
Fallback Provider Result - Result for a fallback request to a provider.
- Contents
- Contents
Name - The name of a
Contents. - Display
Mode - Which display mode are we currently in?
- Drag
AndDrop Feedback - Drag
AndDrop Payload - Hover
Highlight - Hover highlight, sorted from weakest to strongest.
- Item
- One “thing” in the UI.
- Item
Context - Context information that a view might attach to an item from
ItemCollectionand useful for how a selection might be displayed and interacted with. - Looping
- Maybe
MutRef - A reference to a value that is maybe mutable.
- Needs
Repaint - Play
State - Query
Range - Range & type of chunk store query.
- Recording
OrTable - Resolved
Annotation Infos - Many
ResolvedAnnotationInfo, with optimization for a common case where they are all the same. - Screenshot
Target - Where to put the screenshot.
- Selection
Change - Selection
Highlight - Selection highlight, sorted from weakest to strongest.
- System
Command - Commands used by internal system components
- UiLayout
- Specifies the context in which the UI is used and the constraints it should follow.
- Video
Stream Processing Error - View
Class Layout Priority - View
Class Registry Error - View
System Execution Error - Visitor
Control Flow - Type to be returned by visitor closure to control the tree traversal flow.
Traits§
- Blueprint
IdRegistry - Cache
- A cache for memoizing things in order to speed up immediate mode UI & other immediate mode style things.
- Component
Fallback Provider - Provides fallback values for components, implemented typically by
crate::ViewClassandcrate::VisualizerSystem. - Data
Based Visualizability Filter - Additional filter for visualizability on top of the default check for required components.
- Identified
View System - Trait for naming/identifying
crate::VisualizerSystems &crate::ViewContextSystems. - System
Command Sender - Interface for sending
SystemCommandmessages. - Typed
Component Fallback Provider - Provides a fallback value for a given component with known type.
- View
Class - Defines a class of view without any concrete types making it suitable for storage and interfacing.
- View
Class Ext - View
Context System - View context that can be used by view parts and ui methods to retrieve information about the scene as a whole.
- View
State - Unserialized frame to frame state of a view.
- View
State Ext - Visualizable
Filter Context - Context object returned by
crate::ViewClass::visualizable_filter_context. - Visualizer
System - Element of a scene derived from a single archetype query.
- Wasm
NotSend
Functions§
- auto_
color_ egui - auto_
color_ for_ entity_ path - blueprint_
id_ to_ tile_ id - blueprint_
timeline - blueprint_
timepoint_ for_ writes - The timepoint to use when writing an update to the blueprint.
- command_
channel - Creates a new command channel.
- contents_
name_ style - The style to use for displaying this view name in the UI.
- icon_
for_ container_ kind - Determines the icon to use for a given container kind.
- level_
to_ rich_ text - resolve_
mono_ instance_ path - If the given path refers to the first element of an instance with a single element, resolve to a unindexed entity path.
- resolve_
mono_ instance_ path_ item - If the given item refers to the first element of an instance with a single element, resolve to a unindexed entity path.
- santitize_
file_ name - Replace “dangerous” characters by a safe one.
- video_
stream_ time_ from_ query - Extract video stream time from query time.
- video_
timestamp_ component_ to_ video_ time - Convert a video timestamp from component to a video time.
Type Aliases§
- Container
Id - PerSystem
Data Results - PerSystem
Entities - Sharable
Playable Video Stream - Small
Visualizer Set - Table
Stores - ViewId
- View
Rect Publisher - Used to publish info aboutr each view.