Archetype: Time panel specific state. More...

#include <rerun/blueprint/archetypes/time_panel_blueprint.hpp>

Public Member Functions
	TimePanelBlueprint (TimePanelBlueprint &&other)=default

	TimePanelBlueprint (const TimePanelBlueprint &other)=default

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

TimePanelBlueprint &	operator= (TimePanelBlueprint &&other)=default

TimePanelBlueprint	with_state (const rerun::blueprint::components::PanelState &_state) &&
	Current state of the panel.

TimePanelBlueprint	with_timeline (const rerun::blueprint::components::TimelineName &_timeline) &&
	What timeline the panel is on.

TimePanelBlueprint	with_playback_speed (const rerun::blueprint::components::PlaybackSpeed &_playback_speed) &&
	A time playback speed multiplier.

TimePanelBlueprint	with_fps (const rerun::blueprint::components::Fps &_fps) &&
	Frames per second. Only applicable for sequence timelines.

TimePanelBlueprint	with_play_state (const rerun::blueprint::components::PlayState &_play_state) &&
	If the time is currently paused, playing, or following.

TimePanelBlueprint	with_loop_mode (const rerun::blueprint::components::LoopMode &_loop_mode) &&
	How the time should loop.

TimePanelBlueprint	with_time_selection (const rerun::blueprint::components::AbsoluteTimeRange &_time_selection) &&
	Selects a range of time on the time panel.

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

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

Public Attributes
std::optional< ComponentBatch >	state
	Current state of the panel.

std::optional< ComponentBatch >	timeline
	What timeline the panel is on.

std::optional< ComponentBatch >	playback_speed
	A time playback speed multiplier.

std::optional< ComponentBatch >	fps
	Frames per second. Only applicable for sequence timelines.

std::optional< ComponentBatch >	play_state
	If the time is currently paused, playing, or following.

std::optional< ComponentBatch >	loop_mode
	How the time should loop.

std::optional< ComponentBatch >	time_selection
	Selects a range of time on the time panel.

Static Public Attributes
static constexpr const char	ArchetypeName []
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_state
	`ComponentDescriptor` for the `state` field.

static constexpr auto	Descriptor_timeline
	`ComponentDescriptor` for the `timeline` field.

static constexpr auto	Descriptor_playback_speed
	`ComponentDescriptor` for the `playback_speed` field.

static constexpr auto	Descriptor_fps
	`ComponentDescriptor` for the `fps` field.

static constexpr auto	Descriptor_play_state
	`ComponentDescriptor` for the `play_state` field.

static constexpr auto	Descriptor_loop_mode
	`ComponentDescriptor` for the `loop_mode` field.

static constexpr auto	Descriptor_time_selection
	`ComponentDescriptor` for the `time_selection` field.

Detailed Description

Archetype: Time panel specific state.

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

Member Function Documentation

◆ with_play_state()

TimePanelBlueprint rerun::blueprint::archetypes::TimePanelBlueprint::with_play_state ( const rerun::blueprint::components::PlayState & _play_state ) &&

inline

If the time is currently paused, playing, or following.

Defaults to either playing or following, depending on the data source.

◆ with_loop_mode()

TimePanelBlueprint rerun::blueprint::archetypes::TimePanelBlueprint::with_loop_mode ( const rerun::blueprint::components::LoopMode & _loop_mode ) &&

inline

How the time should loop.

A selection loop only works if there is also a time_selection passed.

Defaults to off.

◆ columns() [1/2]

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

◆ play_state

std::optional<ComponentBatch> rerun::blueprint::archetypes::TimePanelBlueprint::play_state

If the time is currently paused, playing, or following.

Defaults to either playing or following, depending on the data source.

◆ loop_mode

std::optional<ComponentBatch> rerun::blueprint::archetypes::TimePanelBlueprint::loop_mode

How the time should loop.

A selection loop only works if there is also a time_selection passed.

Defaults to off.

◆ ArchetypeName

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

staticconstexpr

Initial value:

=

"rerun.blueprint.archetypes.TimePanelBlueprint"

The name of the archetype as used in ComponentDescriptors.

◆ Descriptor_state

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_state

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:state",
            Loggable<rerun::blueprint::components::PanelState>::ComponentType
        )

ComponentDescriptor for the state field.

◆ Descriptor_timeline

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_timeline

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:timeline",
            Loggable<rerun::blueprint::components::TimelineName>::ComponentType
        )

ComponentDescriptor for the timeline field.

◆ Descriptor_playback_speed

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_playback_speed

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:playback_speed",
            Loggable<rerun::blueprint::components::PlaybackSpeed>::ComponentType
        )

ComponentDescriptor for the playback_speed field.

◆ Descriptor_fps

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_fps

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:fps",
            Loggable<rerun::blueprint::components::Fps>::ComponentType
        )

ComponentDescriptor for the fps field.

◆ Descriptor_play_state

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_play_state

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:play_state",
            Loggable<rerun::blueprint::components::PlayState>::ComponentType
        )

ComponentDescriptor for the play_state field.

◆ Descriptor_loop_mode

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_loop_mode

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:loop_mode",
            Loggable<rerun::blueprint::components::LoopMode>::ComponentType
        )

ComponentDescriptor for the loop_mode field.

◆ Descriptor_time_selection

constexpr auto rerun::blueprint::archetypes::TimePanelBlueprint::Descriptor_time_selection

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "TimePanelBlueprint:time_selection",
            Loggable<rerun::blueprint::components::AbsoluteTimeRange>::ComponentType
        )

ComponentDescriptor for the time_selection field.

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

rerun/blueprint/archetypes/time_panel_blueprint.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_play_state()

◆ with_loop_mode()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ play_state

◆ loop_mode

◆ ArchetypeName

◆ Descriptor_state

◆ Descriptor_timeline

◆ Descriptor_playback_speed

◆ Descriptor_fps

◆ Descriptor_play_state

◆ Descriptor_loop_mode

◆ Descriptor_time_selection