Skip to main content

Crate spatialrust_viewer

Crate spatialrust_viewer 

Source
Expand description

Viewer state, interaction controls, native window shell, and debug overlays.

The default feature set is renderer- and window-system-independent. Native window creation is opt-in through native; geometry uploads remain explicit operations in spatialrust-render-wgpu.

Structs§

AdaptedVisual
One owned visual layer and its exact adapter receipt.
AdapterReceipt
Evidence describing one explicit scene-to-visual adaptation.
AttributeSummary
One attribute exposed by the point attribute inspector.
CalibrationArtifact
Source-bound status for one calibration artifact.
CalibrationEvidenceClock
Explicit clock calibration evidence carried by a registration document.
CalibrationEvidenceFrame
Explicit root-to-sensor frame evidence carried by a registration document.
CalibrationEvidenceState
Portable source-bound calibration registration state.
CalibrationObservatoryState
One portable TF/calibration observatory snapshot.
ClockCalibration
Clock calibration observability and application status.
DatasetHealthCheck
One integrity or readiness check shown by the health dashboard.
DatasetHealthStage
Health status for one previously generated SpatialRust stage.
DatasetHealthState
Portable source-bound Dataset Health dashboard state.
DatasetHealthSummary
Health and gate counters aggregated across checks and artifacts.
DatasetHealthTopic
Health counters for one canonical sensor topic.
DebugOverlay
Owned algorithm-debug overlay with deterministic layer identity.
DigitalTwinAsset
One format-specific asset in a Digital Twin bundle.
DigitalTwinState
Portable, fail-closed state for the Digital Twin export.
DigitalTwinSummary
Aggregate identity and geometry metrics for a Digital Twin bundle.
EdgePartition
One named execution partition shown in the receipt.
EdgePartitionState
Portable source-bound receipt for explicit edge-to-host execution.
EdgePartitionSummary
Aggregate graph, queue, source, and calibration gates for one run.
EdgePartitionTransfer
One bounded packet transfer between two named execution nodes.
FrameTimestamps
RGB, depth, and cloud timestamps associated with one synchronized frame.
FrameTransform
One rigid TF edge observed by the source-bound inventory.
FullBagMappingState
Portable source-bound bounded full-bag mapping state.
InspectorSelection
Current selection exposed by the inspector panel.
LayerPresentation
Owned presentation state for one borrowed scene layer.
LivePublishPacket
One encoded ROS 2 packet and its explicit loopback round-trip receipt.
LivePublishState
Portable source-bound state emitted by the ROS 2 live-publish bridge.
LivePublishSummary
Aggregate counts and admission inputs for one live-publish run.
LivePublishTopic
One source topic mapped to one explicit ROS 2 publish topic.
LivePublishTransport
Explicit CPU/adapter transport counters for a publish run.
MapDiffBounds
Axis-aligned map bounds represented in integer micrometres.
MapDiffCell
One spatial heatmap cell in a map comparison.
MapDiffMap
Receipt-backed description of one map participating in a comparison.
MapDiffState
Portable state for a source-bound map comparison dashboard.
MapDiffSummary
Aggregate vertex, topology, and admission metrics for a map comparison.
MappingGateSummary
Derived admission levels for bounded full-bag mapping.
MappingOdometrySummary
Odometry and pose-graph receipt for the bounded full-bag run.
MappingSourceSummary
Source and bounded-ingest totals for one full-bag mapping run.
MappingTsdfSummary
TSDF and mesh receipt for one mapping run.
MissionCockpitFrame
One packet frame with a bounded, source-indexed point sample.
MissionCockpitLayer
One visual layer exposed by the cockpit.
MissionCockpitLink
Aggregate receipt for one directed execution lane.
MissionCockpitNode
One execution node shown in the transfer graph.
MissionCockpitPoint
One finite XYZ point retained for bounded cockpit interaction.
MissionCockpitState
Portable source-bound state shared by the interactive cockpit surfaces.
MissionCockpitSummary
Aggregate counts and admission inputs shown by the cockpit.
MissionCockpitTimeline
Cursor and bounds for the interactive packet timeline.
NativeViewer
Opt-in native window shell backed by winit.
NativeViewerOptions
Native window creation options.
ReplayArtifact
Checksummed output artifact associated with a replay state.
ReplayDemoState
Portable state emitted by the one-command deterministic replay demo.
ReplaySample
One deterministic sample emitted by an episode replayer.
ReplaySummary
Bounded episode and replay counters shown by the replay dashboard.
ReplayTopic
Bounded inventory for one point-cloud topic in the replay episode.
RgbdFrameView
Borrowed synchronized RGB-D/cloud frame.
RgbdPixelSample
Pixel-level RGB-D projection inspection result.
RgbdTimeline
Ordered, borrowed synchronized sensor timeline.
SemanticOverlayClass
One class represented in the semantic overlay legend.
SemanticOverlayEntity
One source-indexed semantic prediction rendered in the overlay.
SemanticOverlayModel
Model and explicit host/device transfer receipt for one overlay run.
SemanticOverlayState
Portable dashboard state for an AI semantic overlay.
SemanticOverlaySummary
Aggregate quality and source-binding metrics for an overlay.
StudioCalibration
Calibration admission state displayed by the Studio gate panel.
StudioFrameGraph
Source-bound frame inventory and composition status.
StudioLayer
Metadata for one point-cloud or derived layer in the Studio panel.
StudioPerformance
Explicit memory and transfer counters for a Studio pipeline.
StudioSource
Checksummed identity of the source represented by a Studio session.
StudioStageMetric
One measured pipeline stage in the Studio metrics panel.
StudioState
One portable state snapshot for the Spatial Studio surface.
StudioTimeline
Bounded timeline information shown by the Studio scrubber.
ViewerController
Deterministic orbit/pan/zoom and viewer-state input reducer.
ViewerState
Portable state shared by native, Web, Python, and notebook surfaces.
ViewportSize
Positive viewport dimensions in logical pixels.

Enums§

AdaptedGeometry
Owned geometry created by an explicit scene adapter.
InputAction
Backend-neutral input action consumed by ViewerController.
OverlayGeometry
Owned geometry retained by a debug overlay.
OverlayKind
Stable category for an algorithm-debug overlay.
ViewerError
Viewer validation or native-shell failure.

Constants§

CALIBRATION_EVIDENCE_STATE_VERSION
Current serialized calibration-evidence state schema version.
CALIBRATION_OBSERVATORY_STATE_VERSION
Current serialized TF/calibration observatory schema version.
DATASET_HEALTH_STATE_VERSION
Current serialized Dataset Health state schema version.
DIGITAL_TWIN_STATE_VERSION
Current serialized Digital Twin state schema version.
EDGE_PARTITION_STATE_VERSION
Current serialized edge-partition state schema version.
FULL_BAG_MAPPING_STATE_VERSION
Current serialized bounded full-bag mapping state schema version.
LIVE_PUBLISH_STATE_VERSION
Current serialized live-publish state schema version.
MAP_DIFF_STATE_VERSION
Current serialized Map Diff state schema version.
MISSION_COCKPIT_MAX_SAMPLED_POINTS
Maximum number of sampled points retained in one interactive frame.
MISSION_COCKPIT_STATE_VERSION
Current serialized mission-cockpit state schema version.
REPLAY_DEMO_STATE_VERSION
Current serialized one-command replay demo state schema version.
SEMANTIC_CONFIDENCE_SCALE
Confidence quantization scale used by semantic overlay receipts.
SEMANTIC_OVERLAY_STATE_VERSION
Current serialized AI semantic overlay state schema version.
STUDIO_STATE_VERSION
Current serialized Spatial Studio state schema version.
VIEWER_STATE_VERSION
Current serialized viewer-state schema version.

Functions§

camera_frustum_visual
Creates camera-frustum wire geometry at the camera origin.
gaussian_visual
Converts Gaussian means, colors, and opacity to point geometry.
mesh_visual
Borrows a reconstructed mesh directly, preserving source pointer identity.
pose_graph_visual
Converts pose-graph edges to deterministic line segments.
semantic_overlay_visual
Converts a validated AI semantic overlay into RGB-colored confidence points.
semantic_visual
Converts semantic entity centroids and best-label confidence to points.
spatial_record_entity_visual
Converts lineage-preserving record entities to semantic centroid points.
surfel_visual
Converts surfel centers/radii to point geometry.
trajectory_visual
Converts a stamped trajectory to line segments.

Type Aliases§

ViewerResult
Result returned by viewer operations.