Archetype: Override the visualizers for an entity. More...

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

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

	VisualizerOverrides (const VisualizerOverrides &other)=default

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

VisualizerOverrides &	operator= (VisualizerOverrides &&other)=default

	VisualizerOverrides (Collection< rerun::blueprint::components::VisualizerOverride > _ranges)

VisualizerOverrides	with_ranges (const Collection< rerun::blueprint::components::VisualizerOverride > &_ranges) &&
	Names of the visualizers that should be active.

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

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

Public Attributes
std::optional< ComponentBatch >	ranges
	Names of the visualizers that should be active.

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

static constexpr auto	Descriptor_ranges
	`ComponentDescriptor` for the `ranges` field.

Detailed Description

Archetype: Override the visualizers for an entity.

This archetype is a stop-gap mechanism based on the current implementation details of the visualizer system. It is not intended to be a long-term solution, but provides enough utility to be useful in the short term.

NOTE: Rerun v0.24 changed the behavior of archetypes::VisualizerOverrides, so that currently they only work with time series views. We plan to bring this feature for all views in future versions.

This can only be used as part of blueprints. It will have no effect if used in a regular entity.

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

Member Function Documentation

◆ columns() [1/2]

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

◆ ArchetypeName

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

staticconstexpr

Initial value:

=

"rerun.blueprint.archetypes.VisualizerOverrides"

The name of the archetype as used in ComponentDescriptors.

◆ Descriptor_ranges

constexpr auto rerun::blueprint::archetypes::VisualizerOverrides::Descriptor_ranges

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "VisualizerOverrides:ranges",
            Loggable<rerun::blueprint::components::VisualizerOverride>::ComponentType
        )

ComponentDescriptor for the ranges field.

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

rerun/blueprint/archetypes/visualizer_overrides.hpp

Public Member Functions

Static Public Member Functions

Public Attributes