rerun::blueprint::archetypes::VisibleTimeRanges Struct Reference

Archetype: Configures what range of each timeline is shown on a view. More...

#include <rerun/blueprint/archetypes/visible_time_ranges.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
	VisibleTimeRanges (VisibleTimeRanges &&other)=default
	VisibleTimeRanges (const VisibleTimeRanges &other)=default
VisibleTimeRanges &	operator= (const VisibleTimeRanges &other)=default
VisibleTimeRanges &	operator= (VisibleTimeRanges &&other)=default
	VisibleTimeRanges (Collection< rerun::blueprint::components::VisibleTimeRange > _ranges)
VisibleTimeRanges	with_ranges (const Collection< rerun::blueprint::components::VisibleTimeRange > &_ranges) &&
	The time ranges to show for each timeline unless specified otherwise on a per-entity basis.
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 VisibleTimeRanges	update_fields ()
	Update only some specific fields of a VisibleTimeRanges.
static VisibleTimeRanges	clear_fields ()
	Clear all the fields of a VisibleTimeRanges.

Public Attributes
std::optional< ComponentBatch >	ranges
	The time ranges to show for each timeline unless specified otherwise on a per-entity basis.

Static Public Attributes
static constexpr const char	IndicatorComponentName []
static constexpr const char	ArchetypeName []
	The name of the archetype as used in ComponentDescriptors.
static constexpr auto	Descriptor_ranges
	ComponentDescriptor for the ranges field.

Detailed Description

Archetype: Configures what range of each timeline is shown on a view.

Whenever no visual time range applies, queries are done with "latest-at" semantics. This means that the view will, starting from the time cursor position, query the latest data available for each component type.

The default visual time range depends on the type of view this property applies to:

• For time series views, the default is to show the entire timeline.
• For any other view, the default is to apply latest-at semantics.

⚠ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

Member Function Documentation

with_ranges()

VisibleTimeRanges rerun::blueprint::archetypes::VisibleTimeRanges::with_ranges ( const Collection< rerun::blueprint::components::VisibleTimeRange > &  _ranges ) &&

inline

The time ranges to show for each timeline unless specified otherwise on a per-entity basis.

If a timeline is specified more than once, the first entry will be used.

columns() [1/2]

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

ranges

std::optional<ComponentBatch> rerun::blueprint::archetypes::VisibleTimeRanges::ranges

The time ranges to show for each timeline unless specified otherwise on a per-entity basis.

If a timeline is specified more than once, the first entry will be used.

IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::VisibleTimeRanges::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.VisibleTimeRangesIndicator"

ArchetypeName

constexpr const char rerun::blueprint::archetypes::VisibleTimeRanges::ArchetypeName[]

staticconstexpr

Initial value:

=
            "rerun.blueprint.archetypes.VisibleTimeRanges"

The name of the archetype as used in ComponentDescriptors.

Descriptor_ranges

constexpr auto rerun::blueprint::archetypes::VisibleTimeRanges::Descriptor_ranges

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "ranges",
            Loggable<rerun::blueprint::components::VisibleTimeRange>::Descriptor.component_name
        )

ComponentDescriptor for the ranges field.

---

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

• rerun/blueprint/archetypes/visible_time_ranges.hpp