Crate re_viewer_context

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;
• pub use self::store_hub::StoreHubEntry;

Modules

• annotations 🔒
• async_runtime_handle 🔒
• blueprint_helpers 🔒
• blueprint_id 🔒
• cache 🔒
  Viewer caches
• collapsed_id 🔒
  Helper types for producing stable [egui::Id] for the purpose of handling collapsed state of various UI elements.
• component_fallbacks 🔒
• contents 🔒
• drag_and_drop 🔒
  Support for viewer-wide drag-and-drop of crate::Items.
• external
• file_dialog 🔒
• global_context 🔒
  Ultimately the goal is to have hierarchy of contexts from general to increasingly specific. Each part of the viewer should only have access a narrow context. Unfortunately, right now everything is still very intertwined with ViewerContext so we can’t pull the GlobalContext out of this crate yet.
• gpu_bridge
  Bridge to re_renderer
• image_info 🔒
• maybe_mut_ref 🔒
• query_context 🔒
• query_range 🔒
• selection_state 🔒
• storage_context 🔒
• store_bundle 🔒
• store_context 🔒
• store_hub
• table_context 🔒
• tables 🔒
• tensor 🔒
• test_context
• time_control 🔒
• typed_entity_collections 🔒
  Various strongly typed sets of entities to express intent and avoid mistakes.
• undo 🔒
• utils 🔒
• view 🔒
  Rerun View class definition
• viewer_context 🔒
• visitor_flow_control 🔒
  Companion to std::ops::ControlFlow useful to implement visitor patterns.

Macros

• impl_component_fallback_provider
  Implements the ComponentFallbackProvider trait for a given type, using a number of TypedComponentFallbackProvider.

Structs

• AnnotationMap
• Annotations
• AppOptions
  Global options for the viewer.
• ApplicationSelectionState
  Selection and hover state.
• AsyncRuntimeHandle
  Thin abstraction over the async runtime.
• BlueprintId
  A unique id for a type of Blueprint contents.
• BlueprintUndoState
  We store the entire edit history of a blueprint in its store.
• Caches
  Does memoization of different objects for the immediate mode UI.
• CollapsedId
  A collapsed identifier.
• ColormapWithRange
  Colormap together with the range of image values that is mapped to the colormap’s range.
• CommandReceiver
  Receiver for the CommandSender
• CommandSender
  Sender that queues up the execution of commands.
• ComponentUiRegistry
  How to display components in a Ui.
• ComponentUiTypes
  Specifies which UI callbacks are available for a component.
• DataQueryResult
  The result of executing a single data query for a specific view.
• DataResult
  This is the primary mechanism through which data is passed to a View.
• DataResultHandle
  Identifier for a DataResultNode
• DataResultNode
  A single node in the DataResultTree
• DataResultTree
  A hierarchical tree of DataResults
• DragAndDropManager
  Helper to handle drag-and-drop operations.
• GlobalContext
  Application context that is shared across all parts of the viewer.
• ImageDecodeCache
  Caches the results of decoding re_types::archetypes::EncodedImage.
• ImageInfo
  Represents the contents of an Image, SegmentationImage or DepthImage.
• ImageStats
  Stats about an image.
• ImageStatsCache
• IndicatedEntities
  List of entities that match the indicator components of a visualizer.
• InteractionHighlight
  Combination of selection & hover highlight which can occur independently.
• ItemCollection
  An ordered collection of Item and optional associated context objects.
• MaybeVisualizableEntities
  List of entities that are maybe visualizable with a given visualizer.
• OptionalViewEntityHighlight
• OverridePath
  Path to a specific entity in a specific store used for overrides.
• PerVisualizer
• PropertyOverrides
• PublishedViewInfo
  Information about a view that is published each frame by ViewRectPublisher.
• QueryContext
  Context for a latest-at query in a specific view.
• RecommendedView
  Properties of a view that as recommended to be spawned by default via view spawn heuristics.
• RecordingConfig
  UI config for the current recording (found in EntityDb).
• ResolvedAnnotationInfo
• ScreenshotInfo
  Info given to egui when taking a screenshot.
• StorageContext
  Provides read-only references over the different kinds of storage used throughout the viewer.
• StoreBundle
  Stores many EntityDbs of recordings and blueprints.
• StoreContext
  The current Blueprint and Recording being displayed by the viewer
• SystemExecutionOutput
  Output of view system execution.
• TableContext
  Everything that is required to display a table entry in the UI.
• TableStore
• TensorStats
  Stats about a tensor or image.
• TensorStatsCache
  Caches tensor stats.
• TimeControl
  Controls the global view and progress of the time.
• TimeControlResponse
• TimeView
  The time range we are currently zoomed in on.
• VideoCache
  Caches meshes based on media type & row id.
• ViewClassRegistry
  Registry of all known view types.
• ViewContext
  The context associated with a view.
• ViewContextCollection
• ViewEntityHighlight
  Highlights of a specific entity path in a specific view.
• ViewHighlights
  Highlights in a specific view.
• ViewOutlineMasks
• ViewQuery
• ViewSpawnHeuristics
  Heuristics for spawning views of a given class.
• ViewStates
  State for the Views that persists across frames but otherwise is not saved.
• ViewSystemIdentifier
  Unique name for a system within a given crate::ViewClass.
• ViewSystemRegistrator
  Utility for registering view systems, passed on to crate::ViewClass::on_register.
• ViewerContext
  Common things needed by many parts of the viewer.
• VisualizableEntities
  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.
• VisualizerCollection
• VisualizerQueryInfo

Enums

• AsyncRuntimeError
• CollapseItem
  The various kinds of items that may be represented and for which we want to track the collapsed state.
• CollapseScope
  The various scopes for which we want to track collapsed state.
• ComponentFallbackError
  Error type for a fallback request.
• ComponentFallbackProviderResult
  Result for a fallback request to a provider.
• Contents
• ContentsName
  The name of a Contents.
• DisplayMode
  Which display mode are we currently in?
• DragAndDropFeedback
• DragAndDropPayload
• HoverHighlight
  Hover highlight, sorted from weakest to strongest.
• Item
  One “thing” in the UI.
• ItemContext
  Context information that a view might attach to an item from ItemCollection and useful for how a selection might be displayed and interacted with.
• Looping
• MaybeMutRef
  A reference to a value that is maybe mutable.
• NeedsRepaint
• PlayState
• QueryRange
  Range & type of chunk store query.
• ResolvedAnnotationInfos
  Many ResolvedAnnotationInfo, with optimization for a common case where they are all the same.
• ScreenshotTarget
  Where to put the screenshot.
• SelectionChange
• SelectionHighlight
  Selection highlight, sorted from weakest to strongest.
• StoreLoadError
• SystemCommand
  Commands used by internal system components
• UiLayout
  Specifies the context in which the UI is used and the constraints it should follow.
• ViewClassLayoutPriority
• ViewClassRegistryError
• ViewSystemExecutionError
• VisitorControlFlow
  Type to be returned by visitor closure to control the tree traversal flow.

Traits

• BlueprintIdRegistry
• Cache
  A cache for memoizing things in order to speed up immediate mode UI & other immediate mode style things.
• ComponentFallbackProvider
  Provides fallback values for components, implemented typically by crate::ViewClass and crate::VisualizerSystem.
• DataBasedVisualizabilityFilter
  Additional filter for visualizability on top of the default check for required components.
• IdentifiedViewSystem
  Trait for naming/identifying crate::VisualizerSystems & crate::ViewContextSystems.
• SystemCommandSender
  Interface for sending SystemCommand messages.
• TypedComponentFallbackProvider
  Provides a fallback value for a given component with known type.
• ViewClass
  Defines a class of view without any concrete types making it suitable for storage and interfacing.
• ViewClassExt
• ViewContextSystem
  View context that can be used by view parts and ui methods to retrieve information about the scene as a whole.
• ViewState
  Unserialized frame to frame state of a view.
• ViewStateExt
• VisualizableFilterContext
  Context object returned by crate::ViewClass::visualizable_filter_context.
• VisualizerSystem
  Element of a scene derived from a single archetype query.
• WasmNotSend

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
• santitize_file_name
  Replace “dangerous” characters by a safe one.

Type Aliases

• ContainerId
• PerSystemDataResults
• PerSystemEntities
• SmallVisualizerSet
• TableStores
• ViewId
• ViewRectPublisher
  Used to publish info aboutr each view.