Struct VisualizerExecutionOutput 

pub struct VisualizerExecutionOutput {
    pub draw_data: Vec<QueueableDrawData>,
    pub affinity: Option<ViewClassIdentifier>,
    pub reports_per_instruction: Mutex<BTreeMap<VisualizerInstructionId, Vec1<VisualizerInstructionReport>>>,
    /* private fields */
}

Result of running VisualizerSystem::execute.

Contains two kinds of output:

• Self::draw_data: GPU render commands, queued by the view for rendering.
• Typed visualizer data: CPU-side typed data read back by the view’s own code (picking, labels, bounding boxes, camera info, plot series, etc.); see Self::with_visualizer_data.

Fields

draw_data: Vec<QueueableDrawData>

GPU render commands produced by the visualizer.

It’s the view’s responsibility to queue this data for rendering.

affinity: Option<ViewClassIdentifier>

The view class this visualizer has affinity to, i.e. the value returned by VisualizerSystem::affinity.

Populated automatically by the execution framework after calling VisualizerSystem::execute.

reports_per_instruction: Mutex<BTreeMap<VisualizerInstructionId, Vec1<VisualizerInstructionReport>>>

Per-instruction diagnostics (errors and warnings) encountered during execution.

Shown in the UI for the respective visualizer instruction. For errors that prevent any visualization at all, return a ViewSystemExecutionError instead.

Mutex-protected to allow parallel appending across instructions.

Implementations

impl VisualizerExecutionOutput

pub fn set_missing_chunks(&self)

Indicate that the view should show a loading indicator because data is missing.

pub fn any_missing_chunks(&self) -> bool

Were any required chunks missing?

pub fn missing_chunk_reporter(&self) -> &MissingChunkReporter

Can be used to report missing chunks.

pub fn report_unspecified_source( &self, instruction_id: VisualizerInstructionId, severity: ViewerReportSeverity, summary: impl Into<String>, )

Report a message for a visualizer instruction with the given severity but no component context.

Use Self::report instead when component-specific context is available.

pub fn report( &self, instruction_id: VisualizerInstructionId, report: VisualizerInstructionReport, )

Report a detailed diagnostic for a visualizer instruction.

pub fn with_draw_data( self, draw_data: impl IntoIterator<Item = QueueableDrawData>, ) -> Self

pub fn with_visualizer_data<T: Any + Send + Sync>(self, data: T) -> Self

Add a typed output payload for this visualizer.

Each type can be stored at most once. Calling this multiple times with the same type overwrites the previous value.

pub fn get_visualizer_data<T: Any>(&self) -> Option<&T>

Retrieve a typed output payload previously stored with Self::with_visualizer_data.

Trait Implementations

impl Default for VisualizerExecutionOutput

fn default() -> VisualizerExecutionOutput

Returns the “default value” for a type.