rerun::archetypes::GeoPoints Struct Reference

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

#include <rerun/archetypes/geo_points.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
	GeoPoints (GeoPoints &&other)=default
	GeoPoints (const GeoPoints &other)=default
GeoPoints &	operator= (const GeoPoints &other)=default
GeoPoints &	operator= (GeoPoints &&other)=default
	GeoPoints (Collection< rerun::components::LatLon > _positions)
GeoPoints	with_positions (const Collection< rerun::components::LatLon > &_positions) &&
	The EPSG:4326 coordinates for the points (North/East-positive degrees).
GeoPoints	with_radii (const Collection< rerun::components::Radius > &_radii) &&
	Optional radii for the points, effectively turning them into circles.
GeoPoints	with_colors (const Collection< rerun::components::Color > &_colors) &&
	Optional colors for the points.
GeoPoints	with_class_ids (const Collection< rerun::components::ClassId > &_class_ids) &&
	Optional class Ids for the points.
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 GeoPoints	from_lat_lon (Collection< components::LatLon > positions_)
	Creates a new GeoPoints object based on EPSG:4326 latitude and longitude (North/East-positive degrees).
static GeoPoints	update_fields ()
	Update only some specific fields of a GeoPoints.
static GeoPoints	clear_fields ()
	Clear all the fields of a GeoPoints.

Public Attributes
std::optional< ComponentBatch >	positions
	The EPSG:4326 coordinates for the points (North/East-positive degrees).
std::optional< ComponentBatch >	radii
	Optional radii for the points, effectively turning them into circles.
std::optional< ComponentBatch >	colors
	Optional colors for the points.
std::optional< ComponentBatch >	class_ids
	Optional class Ids for the points.

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

Detailed Description

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

#include <rerun.hpp>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_geo_points");
    rec.spawn().exit_on_failure();
 
    rec.log(
        "rerun_hq",
        rerun::GeoPoints::from_lat_lon({{59.319221, 18.075631}})
            .with_radii(rerun::Radius::ui_points(10.0f))
            .with_colors(rerun::Color(255, 0, 0))
    );
}

Member Function Documentation

with_radii()

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

inline

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

Note: scene units radiii are interpreted as meters.

with_class_ids()

GeoPoints rerun::archetypes::GeoPoints::with_class_ids ( const Collection< rerun::components::ClassId > &  _class_ids ) &&

inline

Optional class Ids for the points.

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

columns() [1/2]

Collection< ComponentColumn > rerun::archetypes::GeoPoints::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::GeoPoints::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::GeoPoints::radii

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

Note: scene units radiii are interpreted as meters.

class_ids

std::optional<ComponentBatch> rerun::archetypes::GeoPoints::class_ids

Optional class Ids for the points.

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

IndicatorComponentName

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

staticconstexpr

Initial value:

=
            "rerun.components.GeoPointsIndicator"

Descriptor_positions

constexpr auto rerun::archetypes::GeoPoints::Descriptor_positions

staticconstexpr

Initial value:

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

ComponentDescriptor for the positions field.

Descriptor_radii

constexpr auto rerun::archetypes::GeoPoints::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::GeoPoints::Descriptor_colors

staticconstexpr

Initial value:

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

ComponentDescriptor for the colors field.

Descriptor_class_ids

constexpr auto rerun::archetypes::GeoPoints::Descriptor_class_ids

staticconstexpr

Initial value:

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

ComponentDescriptor for the class_ids field.

---

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

• rerun/archetypes/geo_points.hpp