re_viewer_context 0.24.1

//! Rerun Viewer context
//!
//! This crate contains data structures that are shared with most modules of the viewer.

#![warn(clippy::iter_over_hash_type)] //  TODO(#6198): enable everywhere

mod annotations;
mod async_runtime_handle;
mod blueprint_helpers;
mod cache;
mod collapsed_id;
mod component_fallbacks;
mod component_ui_registry;
mod drag_and_drop;
mod image_info;
mod maybe_mut_ref;
mod query_context;
mod query_range;
mod selection_state;
mod storage_context;
mod store_context;
pub mod store_hub;
mod tables;
mod tensor;
mod time_control;
mod typed_entity_collections;
mod undo;
mod utils;
mod view;
mod viewer_context;

#[cfg(feature = "testing")]
pub mod test_context;

// TODO(andreas): Move to its own crate?
pub mod gpu_bridge;
mod visitor_flow_control;

// if you use a ViewerContext, you probably want to use the inner GlobalContext, so we re-export
// everything
pub use re_global_context::*;

pub use self::{
    annotations::{AnnotationMap, Annotations, ResolvedAnnotationInfo, ResolvedAnnotationInfos},
    async_runtime_handle::{AsyncRuntimeError, AsyncRuntimeHandle, WasmNotSend},
    blueprint_helpers::{blueprint_timeline, blueprint_timepoint_for_writes},
    cache::{
        Cache, Caches, ImageDecodeCache, ImageStatsCache, SharablePlayableVideoStream,
        TensorStatsCache, VideoAssetCache, VideoStreamCache, VideoStreamProcessingError,
    },
    collapsed_id::{CollapseItem, CollapseScope, CollapsedId},
    component_fallbacks::{
        ComponentFallbackError, ComponentFallbackProvider, ComponentFallbackProviderResult,
        TypedComponentFallbackProvider,
    },
    component_ui_registry::{ComponentUiRegistry, ComponentUiTypes, EditTarget, VariantName},
    drag_and_drop::{DragAndDropFeedback, DragAndDropManager, DragAndDropPayload},
    image_info::{ColormapWithRange, ImageInfo, StoredBlobCacheKey},
    maybe_mut_ref::MaybeMutRef,
    query_context::{
        DataQueryResult, DataResultHandle, DataResultNode, DataResultTree, QueryContext,
    },
    query_range::QueryRange,
    selection_state::{
        ApplicationSelectionState, HoverHighlight, InteractionHighlight, ItemCollection,
        ItemContext, SelectionChange, SelectionHighlight,
    },
    storage_context::StorageContext,
    store_context::StoreContext,
    store_hub::StoreHub,
    tables::{TableStore, TableStores},
    tensor::{ImageStats, TensorStats},
    time_control::{Looping, PlayState, TimeControl, TimeControlResponse, TimeView},
    typed_entity_collections::{
        IndicatedEntities, MaybeVisualizableEntities, PerVisualizer, VisualizableEntities,
    },
    undo::BlueprintUndoState,
    utils::{
        auto_color_egui, auto_color_for_entity_path, level_to_rich_text,
        video_stream_time_from_query, video_timestamp_component_to_video_time,
    },
    view::{
        DataBasedVisualizabilityFilter, DataResult, IdentifiedViewSystem,
        OptionalViewEntityHighlight, OverridePath, PerSystemDataResults, PerSystemEntities,
        PropertyOverrides, RecommendedView, SmallVisualizerSet, SystemExecutionOutput, ViewClass,
        ViewClassExt, ViewClassLayoutPriority, ViewClassRegistry, ViewClassRegistryError,
        ViewContext, ViewContextCollection, ViewContextSystem, ViewEntityHighlight, ViewHighlights,
        ViewOutlineMasks, ViewQuery, ViewSpawnHeuristics, ViewState, ViewStateExt, ViewStates,
        ViewSystemExecutionError, ViewSystemIdentifier, ViewSystemRegistrator,
        VisualizableFilterContext, VisualizerCollection, VisualizerQueryInfo, VisualizerSystem,
    },
    viewer_context::{RecordingConfig, ViewerContext},
    visitor_flow_control::VisitorControlFlow,
};

pub use re_ui::UiLayout; // Historical reasons

pub mod external {
    pub use nohash_hasher;
    pub use {re_chunk_store, re_entity_db, re_log_types, re_query, re_ui};

    #[cfg(feature = "testing")]
    pub use egui_kittest;

    #[cfg(not(target_arch = "wasm32"))]
    pub use tokio;
}

// ---------------------------------------------------------------------------

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum NeedsRepaint {
    Yes,
    No,
}

// ---

/// Determines the icon to use for a given container kind.
#[inline]
pub fn icon_for_container_kind(kind: &egui_tiles::ContainerKind) -> &'static re_ui::Icon {
    match kind {
        egui_tiles::ContainerKind::Tabs => &re_ui::icons::CONTAINER_TABS,
        egui_tiles::ContainerKind::Horizontal => &re_ui::icons::CONTAINER_HORIZONTAL,
        egui_tiles::ContainerKind::Vertical => &re_ui::icons::CONTAINER_VERTICAL,
        egui_tiles::ContainerKind::Grid => &re_ui::icons::CONTAINER_GRID,
    }
}

/// The style to use for displaying this view name in the UI.
pub fn contents_name_style(name: &ContentsName) -> re_ui::LabelStyle {
    match name {
        ContentsName::Named(_) => re_ui::LabelStyle::Normal,
        ContentsName::Placeholder(_) => re_ui::LabelStyle::Unnamed,
    }
}

/// Info given to egui when taking a screenshot.
///
/// Specified what we are screenshotting.
#[derive(Clone, Debug, PartialEq)]
pub struct ScreenshotInfo {
    /// What portion of the UI to take a screenshot of (in ui points).
    pub ui_rect: Option<egui::Rect>,
    pub pixels_per_point: f32,

    /// Name of the screenshot (e.g. view name), excluding file extension.
    pub name: String,

    /// Where to put the screenshot.
    pub target: ScreenshotTarget,
}

/// Where to put the screenshot.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ScreenshotTarget {
    /// The screenshot will be copied to the clipboard.
    CopyToClipboard,

    /// The screenshot will be saved to disk.
    SaveToDisk,
}

// ----------------------------------------------------------------------------------------

/// Used to publish info aboutr each view.
///
/// We use this for view screenshotting.
///
/// Accessed with [`egui::Memory::caches`].
pub type ViewRectPublisher = egui::cache::FramePublisher<ViewId, PublishedViewInfo>;

/// Information about a view that is published each frame by [`ViewRectPublisher`].
#[derive(Clone, Debug)]
pub struct PublishedViewInfo {
    /// Human-readable name of the view.
    pub name: String,

    /// Where on screen (in ui coords).
    ///
    /// NOTE: this can include a highlighted border of the view.
    pub rect: egui::Rect,
}