diff --git a/crates/re_types/definitions/rerun/archetypes/clear.fbs b/crates/re_types/definitions/rerun/archetypes/clear.fbs index c15c7af00058..eb2ee3325fac 100644 --- a/crates/re_types/definitions/rerun/archetypes/clear.fbs +++ b/crates/re_types/definitions/rerun/archetypes/clear.fbs @@ -9,6 +9,14 @@ namespace rerun.archetypes; /// Empties all the components of an entity. /// +/// The presence of a clear means that a latest-at query of components at a given path(s) +/// will not return any components that were logged at those paths before the clear. +/// Any logged components after the clear are unaffected by the clear. +/// +/// This implies that a range query that includes time points that are before the clear, +/// still returns all components at the given path(s), except those logged directly before the clear. +/// Meaning that in practice clears are ineffective for time series plots and other usages of visible time ranges. +/// /// \example clear_simple title="Flat" image="https://static.rerun.io/clear_simple/2f5df95fcc53e9f0552f65670aef7f94830c5c1a/1200w.png" /// \example clear_recursive !api "Recursive" table Clear ( diff --git a/crates/re_types_core/src/archetypes/clear.rs b/crates/re_types_core/src/archetypes/clear.rs index bc223edd1449..a3517eacafbf 100644 --- a/crates/re_types_core/src/archetypes/clear.rs +++ b/crates/re_types_core/src/archetypes/clear.rs @@ -23,6 +23,14 @@ use crate::{DeserializationError, DeserializationResult}; /// **Archetype**: Empties all the components of an entity. /// +/// The presence of a clear means that a latest-at query of components at a given path(s) +/// will not return any components that were logged at those paths before the clear. +/// Any logged components after the clear are unaffected by the clear. +/// +/// This implies that a range query that includes time points that are before the clear, +/// still returns all components at the given path(s), except those logged directly before the clear. +/// Meaning that in practice clears are ineffective for time series plots and other usages of visible time ranges. +/// /// ## Example /// /// ### Flat diff --git a/docs/content/reference/types/archetypes/clear.md b/docs/content/reference/types/archetypes/clear.md index f7daf11ea029..baff2c828dd7 100644 --- a/docs/content/reference/types/archetypes/clear.md +++ b/docs/content/reference/types/archetypes/clear.md @@ -4,6 +4,14 @@ title: "Clear" Empties all the components of an entity. +The presence of a clear means that a latest-at query of components at a given path(s) +will not return any components that were logged at those paths before the clear. +Any logged components after the clear are unaffected by the clear. + +This implies that a range query that includes time points that are before the clear, +still returns all components at the given path(s), except those logged directly before the clear. +Meaning that in practice clears are ineffective for time series plots and other usages of visible time ranges. + ## Components **Required**: [`ClearIsRecursive`](../components/clear_is_recursive.md) diff --git a/rerun_cpp/src/rerun/archetypes/clear.hpp b/rerun_cpp/src/rerun/archetypes/clear.hpp index 812674703993..11a9f0d4abfe 100644 --- a/rerun_cpp/src/rerun/archetypes/clear.hpp +++ b/rerun_cpp/src/rerun/archetypes/clear.hpp @@ -16,6 +16,14 @@ namespace rerun::archetypes { /// **Archetype**: Empties all the components of an entity. /// + /// The presence of a clear means that a latest-at query of components at a given path(s) + /// will not return any components that were logged at those paths before the clear. + /// Any logged components after the clear are unaffected by the clear. + /// + /// This implies that a range query that includes time points that are before the clear, + /// still returns all components at the given path(s), except those logged directly before the clear. + /// Meaning that in practice clears are ineffective for time series plots and other usages of visible time ranges. + /// /// ## Example /// /// ### Flat diff --git a/rerun_py/rerun_sdk/rerun/archetypes/clear.py b/rerun_py/rerun_sdk/rerun/archetypes/clear.py index 80101376e8d5..8f8660b1055c 100644 --- a/rerun_py/rerun_sdk/rerun/archetypes/clear.py +++ b/rerun_py/rerun_sdk/rerun/archetypes/clear.py @@ -19,6 +19,14 @@ class Clear(ClearExt, Archetype): """ **Archetype**: Empties all the components of an entity. + The presence of a clear means that a latest-at query of components at a given path(s) + will not return any components that were logged at those paths before the clear. + Any logged components after the clear are unaffected by the clear. + + This implies that a range query that includes time points that are before the clear, + still returns all components at the given path(s), except those logged directly before the clear. + Meaning that in practice clears are ineffective for time series plots and other usages of visible time ranges. + Example ------- ### Flat: