re_view 0.38.1

Types & utilities for defining view classes and communicating with the viewport.
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
146
147
148
149
150
151
152
153
154
155
156
157
158

use nohash_hasher::IntMap;
use rayon::prelude::*;
use re_viewer_context::{
    MissingChunkReporter, PerVisualizerTypeInViewClass, SystemExecutionOutput,
    ViewContextCollection, ViewContextSystemOncePerFrameResult, ViewQuery, ViewState,
    ViewSystemExecutionError, ViewSystemIdentifier, ViewSystemState, ViewerContext,
    VisualizerCollection, VisualizerExecutionOutput, VisualizerInstructionsPerType,
};
use re_viewport_blueprint::ViewBlueprint;

use crate::view_highlights::highlights_for_view;

fn run_view_systems(
    ctx: &ViewerContext<'_>,
    view: &ViewBlueprint,
    query: &ViewQuery<'_>,
    view_state: &dyn ViewState,
    context_system_once_per_frame_results: &IntMap<
        ViewSystemIdentifier,
        ViewContextSystemOncePerFrameResult,
    >,
    context_systems: &mut ViewContextCollection,
    view_systems: &VisualizerCollection,
) -> PerVisualizerTypeInViewClass<Result<VisualizerExecutionOutput, ViewSystemExecutionError>> {
    re_tracing::profile_function!(view.class_identifier().as_str());

    let view_ctx = view.bundle_context_with_state(ctx, view_state);

    {
        re_tracing::profile_wait!("ViewContextSystem::execute");
        context_systems
            .systems
            .par_iter_mut()
            .for_each(|(name, (view_ctx_system, state))| {
                re_tracing::profile_scope!("ViewContextSystem::execute", name.as_str());
                let missing_chunk_reporter = MissingChunkReporter::default();
                let once_per_frame_result = context_system_once_per_frame_results
                    .get(name)
                    .expect("Context system execution result didn't occur");
                view_ctx_system.execute(
                    &view_ctx,
                    &missing_chunk_reporter,
                    query,
                    once_per_frame_result,
                );
                *state = ViewSystemState {
                    any_missing_chunks: missing_chunk_reporter.any_missing(),
                };
            });
    };

    re_tracing::profile_wait!("VisualizerSystem::execute");
    let per_visualizer_type_results = view_systems
        .systems
        .par_iter()
        .map(|(name, vis_system)| {
            // Skip execution when no entities in the view have instructions for this
            // visualizer.
            if !query
                .active_visualizer_instructions_per_type
                .contains_key(name)
            {
                let mut output = VisualizerExecutionOutput::default();
                output.affinity = vis_system.affinity();
                return (*name, Ok(output));
            }

            re_tracing::profile_scope!("VisualizerSystem::execute", name.as_str());
            let affinity = vis_system.affinity();
            let result = vis_system
                .execute(&view_ctx, query, context_systems)
                .map(|mut output| {
                    output.affinity = affinity;
                    output
                });
            (*name, result)
        })
        .collect();

    PerVisualizerTypeInViewClass {
        view_class_identifier: view.class_identifier(),
        per_visualizer: per_visualizer_type_results,
    }
}

/// Creates a new [`ViewQuery`] for the given view.
pub fn new_view_query<'a>(ctx: &'a ViewerContext<'a>, view: &'a ViewBlueprint) -> ViewQuery<'a> {
    let highlights = highlights_for_view(ctx, view.id);

    let query_result = ctx.lookup_query_result(view.id);

    let mut active_visualizer_instructions_per_type = VisualizerInstructionsPerType::default();
    {
        re_tracing::profile_scope!("active_visualizer_instructions_per_type");

        for data_result in query_result.tree.iter_data_results() {
            if !data_result.visible {
                continue;
            }

            for instruction in &data_result.visualizer_instructions {
                active_visualizer_instructions_per_type
                    .entry(instruction.visualizer_type)
                    .or_default()
                    .push((data_result, instruction));
            }
        }
    }

    let current_query = ctx.time_ctrl.current_query();
    re_viewer_context::ViewQuery {
        view_id: view.id,
        space_origin: &view.space_origin,
        active_visualizer_instructions_per_type,
        timeline: *ctx.time_ctrl.timeline_name(),
        latest_at: current_query.at(),
        highlights,
    }
}

pub fn execute_systems_for_view<'a>(
    ctx: &'a ViewerContext<'_>,
    view: &'a ViewBlueprint,
    view_state: &dyn ViewState,
    context_system_once_per_frame_results: &IntMap<
        ViewSystemIdentifier,
        ViewContextSystemOncePerFrameResult,
    >,
) -> (ViewQuery<'a>, SystemExecutionOutput) {
    re_tracing::profile_function!(view.class_identifier().as_str());

    let query = new_view_query(ctx, view);

    let mut context_systems = ctx
        .view_class_registry()
        .new_context_collection(view.class_identifier());
    let view_systems = ctx
        .view_class_registry()
        .new_visualizer_collection(view.class_identifier());

    let visualizer_execution_output = run_view_systems(
        ctx,
        view,
        &query,
        view_state,
        context_system_once_per_frame_results,
        &mut context_systems,
        &view_systems,
    );

    (
        query,
        SystemExecutionOutput {
            context_systems,
            visualizer_execution_output,
        },
    )
}