rerun::archetypes::GeoLineStrings Struct Reference

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

#include <rerun/archetypes/geo_line_strings.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	GeoLineStrings (GeoLineStrings &&other)=default
	GeoLineStrings (const GeoLineStrings &other)=default
GeoLineStrings &	operator= (const GeoLineStrings &other)=default
GeoLineStrings &	operator= (GeoLineStrings &&other)=default
	GeoLineStrings (Collection< rerun::components::GeoLineString > _line_strings)
GeoLineStrings	with_line_strings (const Collection< rerun::components::GeoLineString > &_line_strings) &&
	The line strings, expressed in EPSG:4326 coordinates (North/East-positive degrees).
GeoLineStrings	with_radii (const Collection< rerun::components::Radius > &_radii) &&
	Optional radii for the line strings.
GeoLineStrings	with_colors (const Collection< rerun::components::Color > &_colors) &&
	Optional colors for the line strings.
Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.
Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static GeoLineStrings	update_fields ()
	Update only some specific fields of a GeoLineStrings.
static GeoLineStrings	clear_fields ()
	Clear all the fields of a GeoLineStrings.

Public Attributes
std::optional< ComponentBatch >	line_strings
	The line strings, expressed in EPSG:4326 coordinates (North/East-positive degrees).
std::optional< ComponentBatch >	radii
	Optional radii for the line strings.
std::optional< ComponentBatch >	colors
	Optional colors for the line strings.

Static Public Attributes
static constexpr const char	IndicatorComponentName []
static constexpr const char	ArchetypeName [] = "rerun.archetypes.GeoLineStrings"
	The name of the archetype as used in ComponentDescriptors.
static constexpr auto	Descriptor_line_strings
	ComponentDescriptor for the line_strings field.
static constexpr auto	Descriptor_radii
	ComponentDescriptor for the radii field.
static constexpr auto	Descriptor_colors
	ComponentDescriptor for the colors field.

Detailed Description

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

#include <rerun.hpp>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_geo_line_strings");
    rec.spawn().exit_on_failure();
 
    auto line_string = rerun::components::GeoLineString::from_lat_lon(
        {{41.0000, -109.0452},
         {41.0000, -102.0415},
         {36.9931, -102.0415},
         {36.9931, -109.0452},
         {41.0000, -109.0452}}
    );
 
    rec.log(
        "colorado",
        rerun::GeoLineStrings(line_string)
            .with_radii(rerun::Radius::ui_points(2.0f))
            .with_colors(rerun::Color(0, 0, 255))
    );
}

Member Function Documentation

with_radii()

GeoLineStrings rerun::archetypes::GeoLineStrings::with_radii ( const Collection< rerun::components::Radius > &  _radii ) &&

inline

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).

columns() [1/2]

Collection< ComponentColumn > rerun::archetypes::GeoLineStrings::columns

(

const Collection< uint32_t > &

lengths_

)

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::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.

columns() [2/2]

Collection< ComponentColumn > rerun::archetypes::GeoLineStrings::columns

(

)

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

radii

std::optional<ComponentBatch> rerun::archetypes::GeoLineStrings::radii

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).

IndicatorComponentName

constexpr const char rerun::archetypes::GeoLineStrings::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.components.GeoLineStringsIndicator"

Descriptor_line_strings

constexpr auto rerun::archetypes::GeoLineStrings::Descriptor_line_strings

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "line_strings",
            Loggable<rerun::components::GeoLineString>::Descriptor.component_name
        )

ComponentDescriptor for the line_strings field.

Descriptor_radii

constexpr auto rerun::archetypes::GeoLineStrings::Descriptor_radii

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "radii", Loggable<rerun::components::Radius>::Descriptor.component_name
        )

ComponentDescriptor for the radii field.

Descriptor_colors

constexpr auto rerun::archetypes::GeoLineStrings::Descriptor_colors

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "colors", Loggable<rerun::components::Color>::Descriptor.component_name
        )

ComponentDescriptor for the colors field.

---

The documentation for this struct was generated from the following file:

• rerun/archetypes/geo_line_strings.hpp