Struct VisualizerOverrides

pub struct VisualizerOverrides {
    pub ranges: Option<SerializedComponentBatch>,
}

Archetype: Override the visualizers for an entity.

This archetype is a stop-gap mechanism based on the current implementation details of the visualizer system. It is not intended to be a long-term solution, but provides enough utility to be useful in the short term.

The long-term solution is likely to be based off: https://github.com/rerun-io/rerun/issues/6626

This can only be used as part of blueprints. It will have no effect if used in a regular entity.

⚠️ This type is unstable and may change significantly in a way that the data won’t be backwards compatible.

Fields

ranges: Option<SerializedComponentBatch>

Names of the visualizers that should be active.

Implementations

impl VisualizerOverrides

pub fn descriptor_ranges() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::ranges.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl VisualizerOverrides

pub const NUM_COMPONENTS: usize = 2usize

The total number of components in the archetype: 1 required, 1 recommended, 0 optional

impl VisualizerOverrides

pub fn new( ranges: impl IntoIterator<Item = impl Into<VisualizerOverride>>, ) -> Self

Create a new VisualizerOverrides.

pub fn update_fields() -> Self

Update only some specific fields of a VisualizerOverrides.

pub fn clear_fields() -> Self

Clear all the fields of a VisualizerOverrides.

pub fn with_ranges( self, ranges: impl IntoIterator<Item = impl Into<VisualizerOverride>>, ) -> Self

Names of the visualizers that should be active.

Trait Implementations

impl Archetype for VisualizerOverrides

type Indicator = GenericIndicatorComponent<VisualizerOverrides>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for VisualizerOverrides

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for VisualizerOverrides

fn clone(&self) -> VisualizerOverrides

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VisualizerOverrides

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VisualizerOverrides

fn default() -> VisualizerOverrides

Returns the “default value” for a type.

impl SizeBytes for VisualizerOverrides

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for VisualizerOverrides