Archetype: Define the style properties for one or more point series (scatter plot) in a chart. More...

#include <rerun/archetypes/series_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
SeriesPoints	with_names (const char *_name) &&
	Display name of the series.

	SeriesPoints (SeriesPoints &&other)=default

	SeriesPoints (const SeriesPoints &other)=default

SeriesPoints &	operator= (const SeriesPoints &other)=default

SeriesPoints &	operator= (SeriesPoints &&other)=default

SeriesPoints	with_colors (const Collection< rerun::components::Color > &_colors) &&
	Color for the corresponding series.

SeriesPoints	with_markers (const Collection< rerun::components::MarkerShape > &_markers) &&
	What shape to use to represent the point.

SeriesPoints	with_names (const Collection< rerun::components::Name > &_names) &&
	Display name of the series.

SeriesPoints	with_visible_series (const Collection< rerun::components::SeriesVisible > &_visible_series) &&
	Which lines are visible.

SeriesPoints	with_marker_sizes (const Collection< rerun::components::MarkerSize > &_marker_sizes) &&
	Sizes of the markers.

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 SeriesPoints	update_fields ()
	Update only some specific fields of a `SeriesPoints`.

static SeriesPoints	clear_fields ()
	Clear all the fields of a `SeriesPoints`.

Public Attributes
std::optional< ComponentBatch >	colors
	Color for the corresponding series.

std::optional< ComponentBatch >	markers
	What shape to use to represent the point.

std::optional< ComponentBatch >	names
	Display name of the series.

std::optional< ComponentBatch >	visible_series
	Which lines are visible.

std::optional< ComponentBatch >	marker_sizes
	Sizes of the markers.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

static constexpr const char	ArchetypeName [] = "rerun.archetypes.SeriesPoints"
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_colors
	`ComponentDescriptor` for the `colors` field.

static constexpr auto	Descriptor_markers
	`ComponentDescriptor` for the `markers` field.

static constexpr auto	Descriptor_names
	`ComponentDescriptor` for the `names` field.

static constexpr auto	Descriptor_visible_series
	`ComponentDescriptor` for the `visible_series` field.

static constexpr auto	Descriptor_marker_sizes
	`ComponentDescriptor` for the `marker_sizes` field.

Detailed Description

Archetype: Define the style properties for one or more point series (scatter plot) in a chart.

This archetype only provides styling information. Changes over time are supported for most but not all its fields (see respective fields for details), it's generally recommended to log this type as static.

The underlying data needs to be logged to the same entity-path using archetypes::Scalars. Dimensionality of the scalar arrays logged at each time point is assumed to be the same over time.

Example

Point series

#include <rerun.hpp>
 
#include <cmath>
 
constexpr float TAU = 6.28318530717958647692528676655900577f;
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_series_point_style");
    rec.spawn().exit_on_failure();
 
    // Set up plot styling:
    // They are logged static as they don't change over time and apply to all timelines.
    // Log two point series under a shared root so that they show in the same plot by default.
    rec.log_static(
        "trig/sin",
        rerun::SeriesPoints()
            .with_colors(rerun::Rgba32{255, 0, 0})
            .with_names("sin(0.01t)")
            .with_markers(rerun::components::MarkerShape::Circle)
            .with_marker_sizes(4.0f)
    );
    rec.log_static(
        "trig/cos",
        rerun::SeriesPoints()
            .with_colors(rerun::Rgba32{0, 255, 0})
            .with_names("cos(0.01t)")
            .with_markers(rerun::components::MarkerShape::Cross)
            .with_marker_sizes(2.0f)
    );
 
    // Log the data on a timeline called "step".
    for (int t = 0; t <static_cast<int>(TAU * 2.0 * 10.0); ++t) {
        rec.set_time_sequence("step", t);
 
        rec.log("trig/sin", rerun::Scalars(sin(static_cast<double>(t) / 10.0)));
        rec.log("trig/cos", rerun::Scalars(cos(static_cast<double>(t) / 10.0)));
    }
}

Member Function Documentation

◆ with_names() [1/2]

SeriesPoints rerun::archetypes::SeriesPoints::with_names ( const char * _name ) &&

inline

Display name of the series.

Used in the legend. Expected to be unchanging over time.

◆ with_colors()

SeriesPoints rerun::archetypes::SeriesPoints::with_colors ( const Collection< rerun::components::Color > & _colors ) &&

inline

Color for the corresponding series.

May change over time, but can cause discontinuities in the line.

◆ with_markers()

SeriesPoints rerun::archetypes::SeriesPoints::with_markers ( const Collection< rerun::components::MarkerShape > & _markers ) &&

inline

What shape to use to represent the point.

May change over time.

◆ with_names() [2/2]

SeriesPoints rerun::archetypes::SeriesPoints::with_names ( const Collection< rerun::components::Name > & _names ) &&

inline

Display name of the series.

Used in the legend. Expected to be unchanging over time.

◆ with_visible_series()

SeriesPoints rerun::archetypes::SeriesPoints::with_visible_series ( const Collection< rerun::components::SeriesVisible > & _visible_series ) &&

inline

Which lines are visible.

If not set, all line series on this entity are visible. Unlike with the regular visibility property of the entire entity, any series that is hidden via this property will still be visible in the legend.

May change over time.

◆ with_marker_sizes()

SeriesPoints rerun::archetypes::SeriesPoints::with_marker_sizes ( const Collection< rerun::components::MarkerSize > & _marker_sizes ) &&

inline

Sizes of the markers.

May change over time.

◆ columns() [1/2]

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

◆ colors

std::optional<ComponentBatch> rerun::archetypes::SeriesPoints::colors

Color for the corresponding series.

May change over time, but can cause discontinuities in the line.

◆ markers

std::optional<ComponentBatch> rerun::archetypes::SeriesPoints::markers

What shape to use to represent the point.

May change over time.

◆ names

std::optional<ComponentBatch> rerun::archetypes::SeriesPoints::names

Display name of the series.

Used in the legend. Expected to be unchanging over time.

◆ visible_series

std::optional<ComponentBatch> rerun::archetypes::SeriesPoints::visible_series

Which lines are visible.

If not set, all line series on this entity are visible. Unlike with the regular visibility property of the entire entity, any series that is hidden via this property will still be visible in the legend.

May change over time.

◆ marker_sizes

std::optional<ComponentBatch> rerun::archetypes::SeriesPoints::marker_sizes

Sizes of the markers.

May change over time.

◆ IndicatorComponentName

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

staticconstexpr

Initial value:

=

"rerun.components.SeriesPointsIndicator"

◆ Descriptor_colors

constexpr auto rerun::archetypes::SeriesPoints::Descriptor_colors

staticconstexpr

Initial value:

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

ComponentDescriptor for the colors field.

◆ Descriptor_markers

constexpr auto rerun::archetypes::SeriesPoints::Descriptor_markers

staticconstexpr

Initial value:

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

ComponentDescriptor for the markers field.

◆ Descriptor_names

constexpr auto rerun::archetypes::SeriesPoints::Descriptor_names

staticconstexpr

Initial value:

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

ComponentDescriptor for the names field.

◆ Descriptor_visible_series

constexpr auto rerun::archetypes::SeriesPoints::Descriptor_visible_series

staticconstexpr

Initial value:

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

ComponentDescriptor for the visible_series field.

◆ Descriptor_marker_sizes

constexpr auto rerun::archetypes::SeriesPoints::Descriptor_marker_sizes

staticconstexpr

Initial value:

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

ComponentDescriptor for the marker_sizes field.

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

rerun/archetypes/series_points.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Example

Point series

Member Function Documentation

◆ with_names() [1/2]

◆ with_colors()

◆ with_markers()

◆ with_names() [2/2]

◆ with_visible_series()

◆ with_marker_sizes()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ colors

◆ markers

◆ names

◆ visible_series

◆ marker_sizes

◆ IndicatorComponentName

◆ Descriptor_colors

◆ Descriptor_markers

◆ Descriptor_names

◆ Descriptor_visible_series

◆ Descriptor_marker_sizes