diff --git a/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs b/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs index b5ad354aa54e..14f6441023b4 100644 --- a/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs +++ b/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs @@ -5,13 +5,13 @@ include "rerun/components.fbs"; namespace rerun.archetypes; -/// Specifies that the entity path at which this is logged is disconnected from its parent. +/// Spatially disconnect this entity from its parent. /// +/// Specifies that the entity path at which this is logged is spatially disconnected from its parent, +/// making it impossible to transform the entity path into its parent's space and vice versa. +/// It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. /// This is useful for specifying that a subgraph is independent of the rest of the scene. /// -/// If a transform or pinhole is logged on the same path, this archetype's components -/// will be ignored. -/// /// \example disconnected_space title="Disconnected Space" image="https://static.rerun.io/disconnected_space/b8f95b0e32359de625a765247c84935146c1fba9/1200w.png" table DisconnectedSpace ( "attr.rust.derive": "Copy, PartialEq, Eq" diff --git a/crates/re_types/definitions/rerun/components/disconnected_space.fbs b/crates/re_types/definitions/rerun/components/disconnected_space.fbs index 5bf715faca0e..af256ad1694f 100644 --- a/crates/re_types/definitions/rerun/components/disconnected_space.fbs +++ b/crates/re_types/definitions/rerun/components/disconnected_space.fbs @@ -9,11 +9,12 @@ namespace rerun.components; // --- -/// Specifies that the entity path at which this is logged is disconnected from its parent. +/// Spatially disconnect this entity from its parent. /// +/// Specifies that the entity path at which this is logged is spatially disconnected from its parent, +/// making it impossible to transform the entity path into its parent's space and vice versa. +/// It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. /// This is useful for specifying that a subgraph is independent of the rest of the scene. -/// -/// If a transform or pinhole is logged on the same path, this component will be ignored. struct DisconnectedSpace ( "attr.python.aliases": "bool", "attr.python.array_aliases": "bool, npt.NDArray[np.bool_]", diff --git a/crates/re_types/src/archetypes/disconnected_space.rs b/crates/re_types/src/archetypes/disconnected_space.rs index 3ead48a62d7b..109613957ebc 100644 --- a/crates/re_types/src/archetypes/disconnected_space.rs +++ b/crates/re_types/src/archetypes/disconnected_space.rs @@ -21,13 +21,13 @@ use ::re_types_core::SerializationResult; use ::re_types_core::{ComponentBatch, MaybeOwnedComponentBatch}; use ::re_types_core::{DeserializationError, DeserializationResult}; -/// **Archetype**: Specifies that the entity path at which this is logged is disconnected from its parent. +/// **Archetype**: Spatially disconnect this entity from its parent. /// +/// Specifies that the entity path at which this is logged is spatially disconnected from its parent, +/// making it impossible to transform the entity path into its parent's space and vice versa. +/// It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. /// This is useful for specifying that a subgraph is independent of the rest of the scene. /// -/// If a transform or pinhole is logged on the same path, this archetype's components -/// will be ignored. -/// /// ## Example /// /// ### Disconnected Space diff --git a/crates/re_types/src/components/disconnected_space.rs b/crates/re_types/src/components/disconnected_space.rs index 2dd8f65028b8..14152018ab5c 100644 --- a/crates/re_types/src/components/disconnected_space.rs +++ b/crates/re_types/src/components/disconnected_space.rs @@ -21,11 +21,12 @@ use ::re_types_core::SerializationResult; use ::re_types_core::{ComponentBatch, MaybeOwnedComponentBatch}; use ::re_types_core::{DeserializationError, DeserializationResult}; -/// **Component**: Specifies that the entity path at which this is logged is disconnected from its parent. +/// **Component**: Spatially disconnect this entity from its parent. /// +/// Specifies that the entity path at which this is logged is spatially disconnected from its parent, +/// making it impossible to transform the entity path into its parent's space and vice versa. +/// It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. /// This is useful for specifying that a subgraph is independent of the rest of the scene. -/// -/// If a transform or pinhole is logged on the same path, this component will be ignored. #[derive(Clone, Debug, Copy, PartialEq, Eq)] pub struct DisconnectedSpace( /// Whether the entity path at which this is logged is disconnected from its parent. diff --git a/docs/content/reference/types/archetypes/disconnected_space.md b/docs/content/reference/types/archetypes/disconnected_space.md index 65db52fcf2e2..3e446c0e674b 100644 --- a/docs/content/reference/types/archetypes/disconnected_space.md +++ b/docs/content/reference/types/archetypes/disconnected_space.md @@ -2,13 +2,13 @@ title: "DisconnectedSpace" --- -Specifies that the entity path at which this is logged is disconnected from its parent. +Spatially disconnect this entity from its parent. +Specifies that the entity path at which this is logged is spatially disconnected from its parent, +making it impossible to transform the entity path into its parent's space and vice versa. +It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. This is useful for specifying that a subgraph is independent of the rest of the scene. -If a transform or pinhole is logged on the same path, this archetype's components -will be ignored. - ## Components **Required**: [`DisconnectedSpace`](../components/disconnected_space.md) diff --git a/docs/content/reference/types/components/disconnected_space.md b/docs/content/reference/types/components/disconnected_space.md index 21d302f1eb1a..3491a2893cf1 100644 --- a/docs/content/reference/types/components/disconnected_space.md +++ b/docs/content/reference/types/components/disconnected_space.md @@ -2,12 +2,13 @@ title: "DisconnectedSpace" --- -Specifies that the entity path at which this is logged is disconnected from its parent. +Spatially disconnect this entity from its parent. +Specifies that the entity path at which this is logged is spatially disconnected from its parent, +making it impossible to transform the entity path into its parent's space and vice versa. +It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. This is useful for specifying that a subgraph is independent of the rest of the scene. -If a transform or pinhole is logged on the same path, this component will be ignored. - ## Links * 🌊 [C++ API docs for `DisconnectedSpace`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1components_1_1DisconnectedSpace.html) diff --git a/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp b/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp index ce42a6ccd743..d3ba12bdc95c 100644 --- a/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp +++ b/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp @@ -14,13 +14,13 @@ #include namespace rerun::archetypes { - /// **Archetype**: Specifies that the entity path at which this is logged is disconnected from its parent. + /// **Archetype**: Spatially disconnect this entity from its parent. /// + /// Specifies that the entity path at which this is logged is spatially disconnected from its parent, + /// making it impossible to transform the entity path into its parent's space and vice versa. + /// It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. /// This is useful for specifying that a subgraph is independent of the rest of the scene. /// - /// If a transform or pinhole is logged on the same path, this archetype's components - /// will be ignored. - /// /// ## Example /// /// ### Disconnected Space diff --git a/rerun_cpp/src/rerun/components/disconnected_space.hpp b/rerun_cpp/src/rerun/components/disconnected_space.hpp index db5bd9e15b4c..f2ffb2a87295 100644 --- a/rerun_cpp/src/rerun/components/disconnected_space.hpp +++ b/rerun_cpp/src/rerun/components/disconnected_space.hpp @@ -15,11 +15,12 @@ namespace arrow { } // namespace arrow namespace rerun::components { - /// **Component**: Specifies that the entity path at which this is logged is disconnected from its parent. + /// **Component**: Spatially disconnect this entity from its parent. /// + /// Specifies that the entity path at which this is logged is spatially disconnected from its parent, + /// making it impossible to transform the entity path into its parent's space and vice versa. + /// It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. /// This is useful for specifying that a subgraph is independent of the rest of the scene. - /// - /// If a transform or pinhole is logged on the same path, this component will be ignored. struct DisconnectedSpace { /// Whether the entity path at which this is logged is disconnected from its parent. bool is_disconnected; diff --git a/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py b/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py index 6c5782a48100..8b234da16cc4 100644 --- a/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py +++ b/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py @@ -17,13 +17,13 @@ @define(str=False, repr=False, init=False) class DisconnectedSpace(DisconnectedSpaceExt, Archetype): """ - **Archetype**: Specifies that the entity path at which this is logged is disconnected from its parent. + **Archetype**: Spatially disconnect this entity from its parent. + Specifies that the entity path at which this is logged is spatially disconnected from its parent, + making it impossible to transform the entity path into its parent's space and vice versa. + It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. This is useful for specifying that a subgraph is independent of the rest of the scene. - If a transform or pinhole is logged on the same path, this archetype's components - will be ignored. - Example ------- ### Disconnected Space: diff --git a/rerun_py/rerun_sdk/rerun/components/disconnected_space.py b/rerun_py/rerun_sdk/rerun/components/disconnected_space.py index a2ab1520b1ce..31841b6248d4 100644 --- a/rerun_py/rerun_sdk/rerun/components/disconnected_space.py +++ b/rerun_py/rerun_sdk/rerun/components/disconnected_space.py @@ -27,11 +27,12 @@ @define(init=False) class DisconnectedSpace(DisconnectedSpaceExt): """ - **Component**: Specifies that the entity path at which this is logged is disconnected from its parent. + **Component**: Spatially disconnect this entity from its parent. + Specifies that the entity path at which this is logged is spatially disconnected from its parent, + making it impossible to transform the entity path into its parent's space and vice versa. + It *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views. This is useful for specifying that a subgraph is independent of the rest of the scene. - - If a transform or pinhole is logged on the same path, this component will be ignored. """ # __init__ can be found in disconnected_space_ext.py