re_view_spatial 0.31.3

Views that show entities in a 2D or 3D spatial relationship.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! When logging static data twice, the second write wins and overwrites the first one.
//! This test ensures that overrides and defaults still work in this setting, after
//! we had a bug in this logic in the past: <https://github.com/rerun-io/rerun/pull/7199>

use re_chunk_store::RowId;
use re_log_types::{EntityPath, TimePoint};
use re_sdk_types::archetypes;
use re_sdk_types::blueprint::archetypes::EyeControls3D;
use re_sdk_types::components::Position3D;
use re_test_context::TestContext;
use re_test_context::VisualizerBlueprintContext as _;
use re_test_viewport::TestContextExt as _;
use re_view_spatial::SpatialView3D;
use re_viewer_context::{BlueprintContext as _, ViewClass as _, ViewId};
use re_viewport_blueprint::{ViewBlueprint, ViewProperty};

const SNAPSHOT_SIZE: egui::Vec2 = egui::vec2(300.0, 300.0);

fn log_twice(test_context: &mut TestContext, entity_path: &EntityPath) {
    test_context.log_entity(entity_path.clone(), |builder| {
        builder.with_archetype(
            RowId::new(),
            TimePoint::STATIC,
            &archetypes::Points3D::new([(0.0, 1.0, 0.0), (1.0, 1.0, 1.0)]),
        )
    });

    // Log it again, to ensure that the newest one is visible.
    test_context.log_entity(entity_path.clone(), |builder| {
        builder.with_archetype(
            RowId::new(),
            TimePoint::STATIC,
            &archetypes::Points3D::new([(0.0, 1.0, 0.0), (1.0, 1.0, 1.0), (2.0, 2.0, 2.0)]),
        )
    });
}

fn setup_blueprint(
    test_context: &mut TestContext,
    entity_path: &EntityPath,
    radius_default: Option<&archetypes::Points3D>,
    color_override: Option<&archetypes::Points3D>,
) -> ViewId {
    test_context.setup_viewport_blueprint(|ctx, blueprint| {
        let view = ViewBlueprint::new_with_root_wildcard(SpatialView3D::identifier());

        if let Some(radius_default) = radius_default {
            ctx.save_blueprint_archetype(view.defaults_path.clone(), radius_default);
        }

        if let Some(color_override) = color_override {
            ctx.save_visualizers(entity_path, view.id, [color_override]);
        }

        blueprint.add_view_at_root(view)
    })
}

#[test]
pub fn test_static_overwrite_original() {
    let mut test_context = TestContext::new_with_view_class::<SpatialView3D>();

    let entity_path = EntityPath::from("points");

    log_twice(&mut test_context, &entity_path);

    let view_id = setup_blueprint(&mut test_context, &entity_path, None, None);

    run_view_ui_and_save_snapshot(
        &test_context,
        view_id,
        "static_overwrite_original",
        SNAPSHOT_SIZE,
    );
}

#[test]
pub fn test_static_overwrite_radius_default() {
    let mut test_context = TestContext::new_with_view_class::<SpatialView3D>();

    let entity_path = EntityPath::from("points");

    log_twice(&mut test_context, &entity_path);

    let radius_default = archetypes::Points3D::default().with_radii([0.25]);
    let view_id = setup_blueprint(&mut test_context, &entity_path, Some(&radius_default), None);

    run_view_ui_and_save_snapshot(
        &test_context,
        view_id,
        "static_overwrite_radius_default",
        SNAPSHOT_SIZE,
    );
}

#[test]
pub fn test_static_overwrite_color_override() {
    let mut test_context = TestContext::new_with_view_class::<SpatialView3D>();

    let entity_path = EntityPath::from("points");

    log_twice(&mut test_context, &entity_path);

    let color_override = archetypes::Points3D::default()
        .with_colors([[0, 255, 0]])
        .with_radii([0.25]);
    let view_id = setup_blueprint(&mut test_context, &entity_path, None, Some(&color_override));

    run_view_ui_and_save_snapshot(
        &test_context,
        view_id,
        "static_overwrite_color_override",
        SNAPSHOT_SIZE,
    );
}

fn run_view_ui_and_save_snapshot(
    test_context: &TestContext,
    view_id: ViewId,
    name: &str,
    size: egui::Vec2,
) {
    let mut harness = test_context
        .setup_kittest_for_rendering_3d(size)
        .build_ui(|ui| {
            test_context.run_with_single_view(ui, view_id);
        });

    test_context.with_blueprint_ctx(|ctx, _| {
        ViewProperty::from_archetype::<EyeControls3D>(
            ctx.current_blueprint(),
            ctx.blueprint_query(),
            view_id,
        )
        .save_blueprint_component(
            &ctx,
            &EyeControls3D::descriptor_position(),
            &Position3D::new(0.0, 5.0, 3.0),
        );
    });
    test_context.handle_system_commands(&harness.ctx);
    harness.run();

    harness.snapshot(name);
}