Struct re_types::blueprint::archetypes::VisibleTimeRanges

pub struct VisibleTimeRanges {
    pub ranges: Vec<VisibleTimeRange>,
}

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.

Fields

ranges: Vec<VisibleTimeRange>

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.

Implementations

impl VisibleTimeRanges

pub const NUM_COMPONENTS: usize = 2usize

The total number of components in the archetype: 1 required, 1 recommended, 0 optional

impl VisibleTimeRanges

pub fn new( ranges: impl IntoIterator<Item = impl Into<VisibleTimeRange>> ) -> Self

Create a new VisibleTimeRanges.

impl VisibleTimeRanges

pub fn range_for_timeline(&self, timeline_name: &str) -> Option<&TimeRange>

Retrieves the time range for a given timeline.

pub fn set_range_for_timeline( &mut self, timeline_name: &str, range: Option<TimeRange> )

Sets the time range for a given timeline.

If the range is None, the timeline will be removed from the list of visible time ranges.

Trait Implementations

impl Archetype for VisibleTimeRanges

type Indicator = GenericIndicatorComponent<VisibleTimeRanges>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in ui.

fn indicator() -> MaybeOwnedComponentBatch<'static>

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for VisibleTimeRanges

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

Exposes the object’s contents as a set of ComponentBatchs.

fn to_arrow(&self) -> Result<Vec<(Field, Box<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for VisibleTimeRanges

fn clone(&self) -> VisibleTimeRanges

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VisibleTimeRanges

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VisibleTimeRanges

fn default() -> VisibleTimeRanges

Returns the “default value” for a type.

impl SizeBytes for VisibleTimeRanges

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl ArchetypeReflectionMarker for VisibleTimeRanges