Struct rerun::sdk::prelude::GeoPoints

pub struct GeoPoints {
    pub positions: Option<SerializedComponentBatch>,
    pub radii: Option<SerializedComponentBatch>,
    pub colors: Option<SerializedComponentBatch>,
    pub class_ids: Option<SerializedComponentBatch>,
}

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

Example

Log a geospatial point

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

    rec.log(
        "rerun_hq",
        &rerun::GeoPoints::from_lat_lon([(59.319221, 18.075631)])
            .with_radii([rerun::Radius::new_ui_points(10.0)])
            .with_colors([rerun::Color::from_rgb(255, 0, 0)]),
    )?;

    Ok(())
}

Fields

positions: Option<SerializedComponentBatch>

The EPSG:4326 coordinates for the points (North/East-positive degrees).

radii: Option<SerializedComponentBatch>

Optional radii for the points, effectively turning them into circles.

Note: scene units radiii are interpreted as meters.

colors: Option<SerializedComponentBatch>

Optional colors for the points.

class_ids: Option<SerializedComponentBatch>

Optional class Ids for the points.

The components::ClassId provides colors if not specified explicitly.

Implementations

impl GeoPoints

pub fn descriptor_positions() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::positions.

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_class_ids() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::class_ids.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl GeoPoints

pub const NUM_COMPONENTS: usize = 5usize

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

impl GeoPoints

pub fn update_fields() -> GeoPoints

Update only some specific fields of a GeoPoints.

pub fn clear_fields() -> GeoPoints

Clear all the fields of a GeoPoints.

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

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, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

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_positions( self, positions: impl IntoIterator<Item = impl Into<LatLon>>, ) -> GeoPoints

The EPSG:4326 coordinates for the points (North/East-positive degrees).

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

Optional radii for the points, effectively turning them into circles.

Note: scene units radiii are interpreted as meters.

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

Optional colors for the points.

pub fn with_class_ids( self, class_ids: impl IntoIterator<Item = impl Into<ClassId>>, ) -> GeoPoints

Optional class Ids for the points.

The components::ClassId provides colors if not specified explicitly.

impl GeoPoints

pub fn from_lat_lon( positions: impl IntoIterator<Item = impl Into<LatLon>>, ) -> GeoPoints

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

Trait Implementations

impl Archetype for GeoPoints

type Indicator = GenericIndicatorComponent<GeoPoints>

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, Arc<dyn Array>)>, ) -> Result<GeoPoints, DeserializationError>

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 GeoPoints

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 GeoPoints

fn clone(&self) -> GeoPoints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeoPoints

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

Formats the value using the given formatter.

impl Default for GeoPoints

fn default() -> GeoPoints

Returns the “default value” for a type.

impl PartialEq for GeoPoints

fn eq(&self, other: &GeoPoints) -> 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 GeoPoints

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 GeoPoints

impl StructuralPartialEq for GeoPoints