Struct re_types::blueprint::archetypes::MapBackground

pub struct MapBackground {
    pub provider: Option<SerializedComponentBatch>,
}

Archetype: Configuration for the background map of the map view.

Fields

provider: Option<SerializedComponentBatch>

Map provider and style to use.

Note: Requires a Mapbox API key in the RERUN_MAPBOX_ACCESS_TOKEN environment variable.

Implementations

impl MapBackground

pub fn descriptor_provider() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::provider.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl MapBackground

pub const NUM_COMPONENTS: usize = 2usize

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

impl MapBackground

pub fn new(provider: impl Into<MapProvider>) -> Self

Create a new MapBackground.

pub fn update_fields() -> Self

Update only some specific fields of a MapBackground.

pub fn clear_fields() -> Self

Clear all the fields of a MapBackground.

pub fn with_provider(self, provider: impl Into<MapProvider>) -> Self

Map provider and style to use.

Note: Requires a Mapbox API key in the RERUN_MAPBOX_ACCESS_TOKEN environment variable.

Trait Implementations

impl Archetype for MapBackground

type Indicator = GenericIndicatorComponent<MapBackground>

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 MapBackground

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 MapBackground

fn clone(&self) -> MapBackground

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MapBackground

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

Formats the value using the given formatter.

impl Default for MapBackground

fn default() -> MapBackground

Returns the “default value” for a type.

impl SizeBytes for MapBackground

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 MapBackground