From c1f0e7ac4ef5eea64606dfedc9379fd58add98d2 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Mon, 29 Jan 2024 11:42:28 +0100 Subject: [PATCH 1/3] clarify docs on disconnected space --- .../definitions/rerun/archetypes/disconnected_space.fbs | 6 ++---- .../definitions/rerun/components/disconnected_space.fbs | 5 ++--- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs b/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs index b5ad354aa54e..7eb333d61692 100644 --- a/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs +++ b/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs @@ -5,13 +5,11 @@ include "rerun/components.fbs"; namespace rerun.archetypes; -/// Specifies that the entity path at which this is logged is disconnected 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..d68482efd135 100644 --- a/crates/re_types/definitions/rerun/components/disconnected_space.fbs +++ b/crates/re_types/definitions/rerun/components/disconnected_space.fbs @@ -9,11 +9,10 @@ namespace rerun.components; // --- -/// Specifies that the entity path at which this is logged is disconnected 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_]", From 17650e487635940c6ab3a7578fc41b4ea592b695 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Mon, 29 Jan 2024 11:45:03 +0100 Subject: [PATCH 2/3] codegen --- crates/re_types/src/archetypes/disconnected_space.rs | 6 ++---- crates/re_types/src/components/disconnected_space.rs | 5 ++--- .../reference/types/archetypes/disconnected_space.md | 6 ++---- .../reference/types/components/disconnected_space.md | 5 ++--- rerun_cpp/src/rerun/archetypes/disconnected_space.hpp | 6 ++---- rerun_cpp/src/rerun/components/disconnected_space.hpp | 5 ++--- rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py | 6 ++---- rerun_py/rerun_sdk/rerun/components/disconnected_space.py | 5 ++--- 8 files changed, 16 insertions(+), 28 deletions(-) diff --git a/crates/re_types/src/archetypes/disconnected_space.rs b/crates/re_types/src/archetypes/disconnected_space.rs index 3ead48a62d7b..73d90c1e6e90 100644 --- a/crates/re_types/src/archetypes/disconnected_space.rs +++ b/crates/re_types/src/archetypes/disconnected_space.rs @@ -21,13 +21,11 @@ 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**: 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..2bd57bc1e016 100644 --- a/crates/re_types/src/components/disconnected_space.rs +++ b/crates/re_types/src/components/disconnected_space.rs @@ -21,11 +21,10 @@ 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**: 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..9a849cace69e 100644 --- a/docs/content/reference/types/archetypes/disconnected_space.md +++ b/docs/content/reference/types/archetypes/disconnected_space.md @@ -2,13 +2,11 @@ title: "DisconnectedSpace" --- -Specifies that the entity path at which this is logged is disconnected 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..1280bbb472e3 100644 --- a/docs/content/reference/types/components/disconnected_space.md +++ b/docs/content/reference/types/components/disconnected_space.md @@ -2,12 +2,11 @@ title: "DisconnectedSpace" --- -Specifies that the entity path at which this is logged is disconnected 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..9e4a172d8299 100644 --- a/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp +++ b/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp @@ -14,13 +14,11 @@ #include namespace rerun::archetypes { - /// **Archetype**: Specifies that the entity path at which this is logged is disconnected from its parent. + /// **Archetype**: 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..d11a5363e740 100644 --- a/rerun_cpp/src/rerun/components/disconnected_space.hpp +++ b/rerun_cpp/src/rerun/components/disconnected_space.hpp @@ -15,11 +15,10 @@ namespace arrow { } // namespace arrow namespace rerun::components { - /// **Component**: Specifies that the entity path at which this is logged is disconnected from its parent. + /// **Component**: 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..2e08f0492f3a 100644 --- a/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py +++ b/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py @@ -17,13 +17,11 @@ @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**: 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..b42821fa8e89 100644 --- a/rerun_py/rerun_sdk/rerun/components/disconnected_space.py +++ b/rerun_py/rerun_sdk/rerun/components/disconnected_space.py @@ -27,11 +27,10 @@ @define(init=False) class DisconnectedSpace(DisconnectedSpaceExt): """ - **Component**: Specifies that the entity path at which this is logged is disconnected from its parent. + **Component**: 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 From 4eec4acd74c6d5a8f132bd8490895ae45e90aac7 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Tue, 30 Jan 2024 11:23:27 +0100 Subject: [PATCH 3/3] better short doc string --- .../definitions/rerun/archetypes/disconnected_space.fbs | 4 +++- .../definitions/rerun/components/disconnected_space.fbs | 4 +++- crates/re_types/src/archetypes/disconnected_space.rs | 4 +++- crates/re_types/src/components/disconnected_space.rs | 4 +++- docs/content/reference/types/archetypes/disconnected_space.md | 4 +++- docs/content/reference/types/components/disconnected_space.md | 4 +++- rerun_cpp/src/rerun/archetypes/disconnected_space.hpp | 4 +++- rerun_cpp/src/rerun/components/disconnected_space.hpp | 4 +++- rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py | 4 +++- rerun_py/rerun_sdk/rerun/components/disconnected_space.py | 4 +++- 10 files changed, 30 insertions(+), 10 deletions(-) diff --git a/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs b/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs index 7eb333d61692..14f6441023b4 100644 --- a/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs +++ b/crates/re_types/definitions/rerun/archetypes/disconnected_space.fbs @@ -5,8 +5,10 @@ include "rerun/components.fbs"; namespace rerun.archetypes; -/// 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. +/// 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. /// diff --git a/crates/re_types/definitions/rerun/components/disconnected_space.fbs b/crates/re_types/definitions/rerun/components/disconnected_space.fbs index d68482efd135..af256ad1694f 100644 --- a/crates/re_types/definitions/rerun/components/disconnected_space.fbs +++ b/crates/re_types/definitions/rerun/components/disconnected_space.fbs @@ -9,8 +9,10 @@ namespace rerun.components; // --- -/// 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. +/// 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. struct DisconnectedSpace ( diff --git a/crates/re_types/src/archetypes/disconnected_space.rs b/crates/re_types/src/archetypes/disconnected_space.rs index 73d90c1e6e90..109613957ebc 100644 --- a/crates/re_types/src/archetypes/disconnected_space.rs +++ b/crates/re_types/src/archetypes/disconnected_space.rs @@ -21,8 +21,10 @@ 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 spatially disconnected from its parent, making it impossible to transform the entity path into its parent's space and vice versa. +/// **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. /// diff --git a/crates/re_types/src/components/disconnected_space.rs b/crates/re_types/src/components/disconnected_space.rs index 2bd57bc1e016..14152018ab5c 100644 --- a/crates/re_types/src/components/disconnected_space.rs +++ b/crates/re_types/src/components/disconnected_space.rs @@ -21,8 +21,10 @@ 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 spatially disconnected from its parent, making it impossible to transform the entity path into its parent's space and vice versa. +/// **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. #[derive(Clone, Debug, Copy, PartialEq, Eq)] diff --git a/docs/content/reference/types/archetypes/disconnected_space.md b/docs/content/reference/types/archetypes/disconnected_space.md index 9a849cace69e..3e446c0e674b 100644 --- a/docs/content/reference/types/archetypes/disconnected_space.md +++ b/docs/content/reference/types/archetypes/disconnected_space.md @@ -2,8 +2,10 @@ title: "DisconnectedSpace" --- -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. +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. diff --git a/docs/content/reference/types/components/disconnected_space.md b/docs/content/reference/types/components/disconnected_space.md index 1280bbb472e3..3491a2893cf1 100644 --- a/docs/content/reference/types/components/disconnected_space.md +++ b/docs/content/reference/types/components/disconnected_space.md @@ -2,8 +2,10 @@ title: "DisconnectedSpace" --- -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. +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. diff --git a/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp b/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp index 9e4a172d8299..d3ba12bdc95c 100644 --- a/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp +++ b/rerun_cpp/src/rerun/archetypes/disconnected_space.hpp @@ -14,8 +14,10 @@ #include namespace rerun::archetypes { - /// **Archetype**: 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. + /// **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. /// diff --git a/rerun_cpp/src/rerun/components/disconnected_space.hpp b/rerun_cpp/src/rerun/components/disconnected_space.hpp index d11a5363e740..f2ffb2a87295 100644 --- a/rerun_cpp/src/rerun/components/disconnected_space.hpp +++ b/rerun_cpp/src/rerun/components/disconnected_space.hpp @@ -15,8 +15,10 @@ namespace arrow { } // namespace arrow namespace rerun::components { - /// **Component**: 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. + /// **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. struct DisconnectedSpace { diff --git a/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py b/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py index 2e08f0492f3a..8b234da16cc4 100644 --- a/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py +++ b/rerun_py/rerun_sdk/rerun/archetypes/disconnected_space.py @@ -17,8 +17,10 @@ @define(str=False, repr=False, init=False) class DisconnectedSpace(DisconnectedSpaceExt, Archetype): """ - **Archetype**: 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. + **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. diff --git a/rerun_py/rerun_sdk/rerun/components/disconnected_space.py b/rerun_py/rerun_sdk/rerun/components/disconnected_space.py index b42821fa8e89..31841b6248d4 100644 --- a/rerun_py/rerun_sdk/rerun/components/disconnected_space.py +++ b/rerun_py/rerun_sdk/rerun/components/disconnected_space.py @@ -27,8 +27,10 @@ @define(init=False) class DisconnectedSpace(DisconnectedSpaceExt): """ - **Component**: 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. + **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. """