Struct re_viewer_context::test_context::TestContext

pub struct TestContext {

    pub recording_store: EntityDb,
    pub blueprint_store: EntityDb,
    pub view_class_registry: ViewClassRegistry,
    pub selection_state: ApplicationSelectionState,
    pub recording_config: RecordingConfig,
    pub view_states: Mutex<ViewStates>,
    pub query_results: HashMap<ViewId, DataQueryResult>,
    pub blueprint_query: LatestAtQuery,
    pub component_ui_registry: ComponentUiRegistry,
    pub reflection: Reflection,
    command_sender: CommandSender,
    command_receiver: CommandReceiver,
    egui_render_state: Mutex<Option<RenderState>>,
    called_setup_kittest_for_rendering: AtomicBool,
}

Harness to execute code that rely on crate::ViewerContext.

Example:

use re_viewer_context::test_context::TestContext;
use re_viewer_context::ViewerContext;

let mut test_context = TestContext::default();
test_context.run_in_egui_central_panel(|ctx: &ViewerContext, _| {
    /* do something with ctx */
});

Fields

recording_store: EntityDb

blueprint_store: EntityDb

view_class_registry: ViewClassRegistry

selection_state: ApplicationSelectionState

recording_config: RecordingConfig

view_states: Mutex<ViewStates>

query_results: HashMap<ViewId, DataQueryResult>

blueprint_query: LatestAtQuery

component_ui_registry: ComponentUiRegistry

reflection: Reflection

command_sender: CommandSender

command_receiver: CommandReceiver

egui_render_state: Mutex<Option<RenderState>>

called_setup_kittest_for_rendering: AtomicBool

Implementations

impl TestContext

pub fn setup_kittest_for_rendering(&self) -> HarnessBuilder<()>

pub fn active_timeline(&self) -> Timeline

Timeline the recording config is using by default.

pub fn set_active_timeline(&self, timeline: Timeline)

pub fn edit_selection( &mut self, edit_fn: impl FnOnce(&mut ApplicationSelectionState), )

pub fn log_entity( &mut self, entity_path: EntityPath, build_chunk: impl FnOnce(ChunkBuilder) -> ChunkBuilder, )

Log an entity to the recording store.

The provided closure should add content using the ChunkBuilder passed as argument.

pub fn register_view_class<T: ViewClass + Default + 'static>(&mut self)

Register a view class.

pub fn run(&self, egui_ctx: &Context, func: impl FnOnce(&ViewerContext<'_>))

Run the provided closure with a ViewerContext produced by the Self.

IMPORTANT: call Self::handle_system_commands after calling this function if your test relies on system commands.

pub fn run_in_egui_central_panel( &self, func: impl FnMut(&ViewerContext<'_>, &mut Ui), )

Run the given function with a ViewerContext produced by the Self, in the context of an [egui::CentralPanel].

IMPORTANT: call Self::handle_system_commands after calling this function if your test relies on system commands.

Notes:

• Uses [egui::__run_test_ctx].
• There is a possibility that the closure will be called more than once, see [egui::Context::run]. Use Self::run_once_in_egui_central_panel if you want to ensure that the closure is called exactly once.

pub fn run_once_in_egui_central_panel<R>( &self, func: impl FnOnce(&ViewerContext<'_>, &mut Ui) -> R, ) -> R

Run the given function once with a ViewerContext produced by the Self, in the context of an [egui::CentralPanel].

IMPORTANT: call Self::handle_system_commands after calling this function if your test relies on system commands.

Notes:

• Uses [egui::__run_test_ctx].

pub fn handle_system_commands(&mut self)

Best-effort attempt to meaningfully handle some of the system commands.

Trait Implementations

impl Default for TestContext

fn default() -> Self

Returns the “default value” for a type.