Struct re_types::archetypes::GeoLineStrings

pub struct GeoLineStrings {
    pub line_strings: Option<SerializedComponentBatch>,
    pub radii: Option<SerializedComponentBatch>,
    pub colors: Option<SerializedComponentBatch>,
}

Archetype: Geospatial line strings with positions expressed in EPSG:4326 altitude and longitude (North/East-positive degrees), and optional colors and radii.

Also known as “line strips” or “polylines”.

Example

Log a geospatial line string

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_geo_line_strings").spawn()?;

    rec.log(
        "colorado",
        &rerun::GeoLineStrings::from_lat_lon([[
            [41.0000, -109.0452],
            [41.0000, -102.0415],
            [36.9931, -102.0415],
            [36.9931, -109.0452],
            [41.0000, -109.0452],
        ]])
        .with_radii([rerun::Radius::new_ui_points(2.0)])
        .with_colors([rerun::Color::from_rgb(0, 0, 255)]),
    )?;

    Ok(())
}

Fields

line_strings: Option<SerializedComponentBatch>

The line strings, expressed in EPSG:4326 coordinates (North/East-positive degrees).

radii: Option<SerializedComponentBatch>

Optional radii for the line strings.

Note: scene units radiii are interpreted as meters. Currently, the display scale only considers the latitude of the first vertex of each line string (see this issue).

colors: Option<SerializedComponentBatch>

Optional colors for the line strings.

Implementations

impl GeoLineStrings

pub fn descriptor_line_strings() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::line_strings.

pub fn descriptor_radii() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::radii.

pub fn descriptor_colors() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::colors.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl GeoLineStrings

pub const NUM_COMPONENTS: usize = 4usize

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

impl GeoLineStrings

pub(crate) fn new( line_strings: impl IntoIterator<Item = impl Into<GeoLineString>>, ) -> Self

Create a new GeoLineStrings.

pub fn update_fields() -> Self

Update only some specific fields of a GeoLineStrings.

pub fn clear_fields() -> Self

Clear all the fields of a GeoLineStrings.

pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_line_strings( self, line_strings: impl IntoIterator<Item = impl Into<GeoLineString>>, ) -> Self

The line strings, expressed in EPSG:4326 coordinates (North/East-positive degrees).

pub fn with_radii( self, radii: impl IntoIterator<Item = impl Into<Radius>>, ) -> Self

Optional radii for the line strings.

Note: scene units radiii are interpreted as meters. Currently, the display scale only considers the latitude of the first vertex of each line string (see this issue).

pub fn with_colors( self, colors: impl IntoIterator<Item = impl Into<Color>>, ) -> Self

Optional colors for the line strings.

impl GeoLineStrings

pub fn from_lat_lon( line_strings: impl IntoIterator<Item = impl Into<GeoLineString>>, ) -> Self

Create a new GeoLineStrings from EPSG:4326 latitude and longitude (North/East-positive degrees).

Trait Implementations

impl Archetype for GeoLineStrings

type Indicator = GenericIndicatorComponent<GeoLineStrings>

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 GeoLineStrings

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 GeoLineStrings

fn clone(&self) -> GeoLineStrings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeoLineStrings

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

Formats the value using the given formatter.

impl Default for GeoLineStrings

fn default() -> GeoLineStrings

Returns the “default value” for a type.

impl PartialEq for GeoLineStrings

fn eq(&self, other: &GeoLineStrings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for GeoLineStrings

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 GeoLineStrings

impl StructuralPartialEq for GeoLineStrings