Codegen for space view python blueprint classes

crates/re_types/definitions/python/attributes.fbs

@@ -1,8 +1,6 @@
 namespace python.attributes;
 
-/// Defines the type aliases for a component, e.g. the types that make up `ComponentLike`.
-///
-/// Only applies to structs/unions that are components.
+/// Defines the type aliases for a component or view property archetype, e.g. the types that make up `ComponentLike`.
 attribute "attr.python.aliases";
 
 /// Defines the array type aliases for a component, e.g. the types that make up `ComponentArrayLike`.

crates/re_types/definitions/rerun/attributes.fbs

@@ -25,11 +25,16 @@ attribute "attr.rerun.component_optional";
 /// For lists this will apply to the inner element.
 attribute "attr.rerun.override_type";
 
-/// Set the scope of the type
+/// Set the scope of the type.
 ///
 /// This is used for example to scope blueprint types.
 attribute "attr.rerun.scope";
 
+/// Specifies the type identifier for a space view type.
+///
+/// This is mandatory for space view types.
+attribute "attr.rerun.space_view_identifier";
+
 /// Marks something as deprecated followed by a (mandatory!) migration note.
 ///
 /// If specified on an object (struct/enum/union), it becomes deprecated such

crates/re_types/definitions/rerun/blueprint.fbs

@@ -32,3 +32,11 @@ include "./blueprint/archetypes/viewport_blueprint.fbs";
 
 include "./blueprint/archetypes/plot_legend.fbs";
 include "./blueprint/archetypes/scalar_axis.fbs";
+
+include "./blueprint/space_views/bar_chart.fbs";
+include "./blueprint/space_views/spatial2d.fbs";
+include "./blueprint/space_views/spatial3d.fbs";
+include "./blueprint/space_views/tensor.fbs";
+include "./blueprint/space_views/text_document.fbs";
+include "./blueprint/space_views/text_log.fbs";
+include "./blueprint/space_views/time_series.fbs";

crates/re_types/definitions/rerun/blueprint/archetypes/background_3d.fbs

@@ -12,7 +12,8 @@ namespace rerun.blueprint.archetypes;
 
 /// Configuration for the background of the 3D space view.
 table Background3D (
-    "attr.rerun.scope": "blueprint"
+    "attr.rerun.scope": "blueprint",
+    "attr.python.aliases": "datatypes.Rgba32Like, blueprint_components.Background3DKindLike"
 ) {
     // --- Required ---
 

crates/re_types/definitions/rerun/blueprint/space_views/bar_chart.fbs

@@ -0,0 +1,9 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A bar chart view.
+table BarChartView (
+    "attr.rerun.space_view_identifier": "BarChart"
+) {
+}

crates/re_types/definitions/rerun/blueprint/space_views/spatial2d.fbs

@@ -0,0 +1,9 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A Spatial 2D view.
+table Spatial2DView (
+    "attr.rerun.space_view_identifier": "2D"
+) {
+}

crates/re_types/definitions/rerun/blueprint/space_views/spatial3d.fbs

@@ -0,0 +1,11 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A Spatial 3D view.
+table Spatial3DView (
+    "attr.rerun.space_view_identifier": "3D"
+) {
+    /// Configuration for the background of the 3D space view.
+    background: rerun.blueprint.archetypes.Background3D (order: 1000);
+}

crates/re_types/definitions/rerun/blueprint/space_views/tensor.fbs

@@ -0,0 +1,9 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A tensor view.
+table TensorView (
+    "attr.rerun.space_view_identifier": "Tensor"
+) {
+}

crates/re_types/definitions/rerun/blueprint/space_views/text_document.fbs

@@ -0,0 +1,9 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A text document view.
+table TextDocumentView (
+    "attr.rerun.space_view_identifier": "TextDocument"
+) {
+}

crates/re_types/definitions/rerun/blueprint/space_views/text_log.fbs

@@ -0,0 +1,9 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A text log view.
+table TextLogView (
+    "attr.rerun.space_view_identifier": "TextLog"
+) {
+}

crates/re_types/definitions/rerun/blueprint/space_views/time_series.fbs

@@ -0,0 +1,9 @@
+include "rerun/attributes.fbs";
+
+namespace rerun.blueprint.space_views;
+
+/// A time series view.
+table TimeSeriesView (
+    "attr.rerun.space_view_identifier": "TimeSeries"
+) {
+}

crates/re_types/src/lib.rs

@@ -3,8 +3,8 @@
 //! This crate contains both the IDL definitions for Rerun types (flatbuffers) as well as the code
 //! generated from those using `re_types_builder`.
 //!
-//! All builtin archetypes, components and datatypes can be found in their respective top-level
-//! modules.
+//! All builtin archetypes, components, datatypes and space view definitions can be found in their
+//! respective top-level modules.
 //!
 //! ## Contributing
 //!

crates/re_types_builder/src/codegen/cpp/mod.rs

@@ -136,6 +136,10 @@ impl crate::CodeGenerator for CppCodeGenerator {
 
         ObjectKind::ALL
             .par_iter()
+            .filter(|&&object_kind| {
+                // TODO(#5521): Implement SpaceView codegen for Rust.
+                object_kind != ObjectKind::SpaceView
+            })
             .flat_map(|object_kind| {
                 scopes
                     .par_iter()
@@ -405,6 +409,9 @@ impl QuotedObject {
                 ObjectKind::Archetype => {
                     Ok(Self::from_archetype(obj, hpp_includes, hpp_type_extensions))
                 }
+                ObjectKind::SpaceView => {
+                    unimplemented!();
+                }
             },
             ObjectClass::Enum => Ok(Self::from_enum(objects, obj, hpp_includes)),
             ObjectClass::Union => Ok(Self::from_union(

crates/re_types_builder/src/codegen/docs/mod.rs

@@ -56,6 +56,10 @@ impl CodeGenerator for DocsCodeGenerator {
                 ObjectKind::Datatype => datatypes.push(object),
                 ObjectKind::Component => components.push(object),
                 ObjectKind::Archetype => archetypes.push(object),
+                ObjectKind::SpaceView => {
+                    // TODO(#6082): Implement space view docs generation.
+                    continue;
+                }
             }
 
             let page = object_page(reporter, object, object_map);
@@ -211,6 +215,9 @@ fn object_page(reporter: &Reporter, object: &Object, object_map: &ObjectMap) ->
             write_fields(&mut page, object, object_map);
         }
         ObjectKind::Archetype => write_archetype_fields(&mut page, object, object_map),
+        ObjectKind::SpaceView => {
+            // TODO(#6082): Implement space view docs generation.
+        }
     }
 
     {
@@ -284,6 +291,9 @@ fn object_page(reporter: &Reporter, object: &Object, object_map: &ObjectMap) ->
                 }
             }
         }
+        ObjectKind::SpaceView => {
+            // TODO(#6082): Implement space view docs generation.
+        }
     }
 
     page

crates/re_types_builder/src/codegen/python/mod.rs

@@ -1,5 +1,7 @@
 //! Implements the Python codegen pass.
 
+mod space_views;
+
 use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
 
 use anyhow::Context as _;
@@ -19,6 +21,8 @@ use crate::{
     ObjectKind, Objects, Reporter, Type, ATTR_PYTHON_ALIASES, ATTR_PYTHON_ARRAY_ALIASES,
 };
 
+use self::space_views::code_for_space_view;
+
 use super::common::ExampleInfo;
 
 /// The standard python init method.
@@ -322,7 +326,7 @@ impl PythonCodeGenerator {
                         ]
                     }
                 }
-                ObjectKind::Archetype => vec![obj.name.clone()],
+                ObjectKind::SpaceView | ObjectKind::Archetype => vec![obj.name.clone()],
             };
 
             // NOTE: Isolating the file stem only works because we're handling datatypes, components
@@ -342,14 +346,18 @@ impl PythonCodeGenerator {
             code.push_indented(0, &format!("# {}", autogen_warning!()), 1);
             if let Some(source_path) = obj.relative_filepath() {
                 code.push_indented(0, &format!("# Based on {:?}.", format_path(source_path)), 2);
-                code.push_indented(
-                    0,
-                    &format!(
-                        "# You can extend this class by creating a {:?} class in {:?}.",
-                        ext_class.name, ext_class.file_name
-                    ),
-                    2,
-                );
+
+                if obj.kind != ObjectKind::SpaceView {
+                    // Space view type extension isn't implemented yet (shouldn't be hard though to add if).
+                    code.push_indented(
+                        0,
+                        &format!(
+                            "# You can extend this class by creating a {:?} class in {:?}.",
+                            ext_class.name, ext_class.file_name
+                        ),
+                        2,
+                    );
+                }
             }
 
             let manifest = quote_manifest(names);
@@ -436,13 +444,17 @@ impl PythonCodeGenerator {
 
             let obj_code = match obj.class {
                 crate::objects::ObjectClass::Struct => {
-                    code_for_struct(reporter, arrow_registry, &ext_class, objects, obj)
+                    if obj.kind == ObjectKind::SpaceView {
+                        code_for_space_view(reporter, objects, obj)
+                    } else {
+                        code_for_struct(reporter, arrow_registry, &ext_class, objects, obj)
+                    }
                 }
                 crate::objects::ObjectClass::Enum => {
                     code_for_enum(reporter, arrow_registry, &ext_class, objects, obj)
                 }
                 crate::objects::ObjectClass::Union => {
-                    code_for_union(arrow_registry, &ext_class, objects, obj)
+                    code_for_union(reporter, arrow_registry, &ext_class, objects, obj)
                 }
             };
 
@@ -458,7 +470,7 @@ impl PythonCodeGenerator {
             files_to_write.insert(filepath.clone(), code);
         }
 
-        // rerun/[{scope}]/{datatypes|components|archetypes}/__init__.py
+        // rerun/[{scope}]/{datatypes|components|archetypes|space_views}/__init__.py
         write_init_file(&kind_path, &mods, files_to_write);
         write_init_file(&test_kind_path, &test_mods, files_to_write);
         for (scope, mods) in scoped_mods {
@@ -476,6 +488,10 @@ fn write_init_file(
     mods: &BTreeMap<String, Vec<String>>,
     files_to_write: &mut BTreeMap<Utf8PathBuf, String>,
 ) {
+    if mods.is_empty() {
+        return;
+    }
+
     let path = kind_path.join("__init__.py");
     let mut code = String::new();
     let manifest = quote_manifest(mods.iter().flat_map(|(_, names)| names.iter()));
@@ -766,6 +782,9 @@ fn code_for_struct(
                 1,
             );
         }
+        ObjectKind::SpaceView => {
+            unreachable!("Space views processing shouldn't reach struct generation code.");
+        }
     }
 
     code
@@ -915,12 +934,20 @@ return pa.UnionArray.from_buffers(
                 1,
             );
         }
+        ObjectKind::SpaceView => {
+            reporter.error(
+                &obj.virtpath,
+                &obj.fqname,
+                "An space view cannot be an enum",
+            );
+        }
     }
 
     code
 }
 
 fn code_for_union(
+    reporter: &Reporter,
     arrow_registry: &ArrowRegistry,
     ext_class: &ExtensionClass,
     objects: &Objects,
@@ -1062,7 +1089,7 @@ fn code_for_union(
     match kind {
         ObjectKind::Archetype => (),
         ObjectKind::Component => {
-            unreachable!("component may not be a union")
+            reporter.error(&obj.virtpath, &obj.fqname, "An component cannot be an enum");
         }
         ObjectKind::Datatype => {
             code.push_indented(
@@ -1071,6 +1098,13 @@ fn code_for_union(
                 1,
             );
         }
+        ObjectKind::SpaceView => {
+            reporter.error(
+                &obj.virtpath,
+                &obj.fqname,
+                "An space view cannot be an enum",
+            );
+        }
     }
 
     code
@@ -1970,15 +2004,10 @@ fn quote_init_method(
             })
             .collect::<Vec<_>>()
     };
-    let doc_typedesc = match obj.kind {
-        ObjectKind::Datatype => "datatype",
-        ObjectKind::Component => "component",
-        ObjectKind::Archetype => "archetype",
-    };
-
     let mut doc_string_lines = vec![format!(
-        "Create a new instance of the {} {doc_typedesc}.",
-        obj.name
+        "Create a new instance of the {} {}.",
+        obj.name,
+        obj.kind.singular_name().to_lowercase()
     )];
     if !parameter_docs.is_empty() {
         doc_string_lines.push("\n".to_owned());