Update blender_commit_object_builder.py

Fixed issue with uint32 vertex colours not parsing

bpy_speckle/blender_commit_object_builder.py

@@ -1,4 +1,4 @@
-from typing import Deque, Dict, List, Optional, Set, Tuple, Union
+from typing import Dict, Optional, Tuple, Union
 import bpy
 from bpy.types import Object, Collection, ID
 from specklepy.objects.base import Base
@@ -20,6 +20,11 @@ def _try_id(natvive_object: Optional[Union[Collection, Object]]) -> Optional[str
 def convert_collection_to_speckle(col: Collection) -> SCollection:
     convered_collection = SCollection(name = col.name_full, collectionType = "Blender Collection", elements = [])
     convered_collection.applicationId = _id(col)
+
+    color_tag = col.color_tag
+    if color_tag and color_tag != "NONE":
+        convered_collection["colorTag"] = col.color_tag
+
     return convered_collection
 
 @define(slots=True)
@@ -68,20 +73,6 @@ class BlenderCommitObjectBuilder(CommitObjectBuilder[Object]):
 
         return convered_collection
 
-    # def find_collection_parent(self, col: Collection) -> Optional[Collection]:
-    #     for p in bpy.data.collections:
-    #         if col.name in p.children.keys():
-    #             return p
-    #     return None
-
-    #TODO: I've started an approach that will not work
-    # Goal #1 get all collections sending
-    # Sync with Claire, ask how we handle this in Rhino with partial selection of layers (proably how I'm expecting it works, but good to double check)
-    # Goal #2 Figure out how to send collections
-    # - all collections
-    # - all collections that contain a child collection that has geometry...
-    # - only collections explicitly selected
-
     def build_commit_object(self, root_commit_object: Base) -> None:
         assert(root_commit_object.applicationId in self.converted)
 
@@ -127,24 +118,3 @@ class BlenderCommitObjectBuilder(CommitObjectBuilder[Object]):
 
         if should_remove_unuseful_collection(root_commit_object):
             _report("WARNING: Only empty collections have been converted!") #TODO: consider raising exception here, to halt the send operation
-
-
-
-
-    # def build_commit_object(self, root_commit_object: Base) -> None:
-
-    #     convertedObjects = [x for x in self.converted.values()] # Converted objects, but no collections!
-    #     for (id, col) in self._collections.items():
-    #         self.converted[id] = col
-        
-    #     # Apply relationships for all non-collection objects
-    #     self.apply_relationships(convertedObjects, root_commit_object)
-
-    #     # Remove empty collections
-    #     for (id, col) in self._collections.items(): #TODO: XXX: How to ensure empty collections are avoided! Potentially need to traverse from root object down...
-    #         if not col.elements:
-    #             self.converted.pop(id)
-
-    #     self.apply_relationships(convertedObjects, root_commit_object)
-
-    #     return

bpy_speckle/convert/__init__.py

@@ -1,29 +0,0 @@
-from typing import Union
-from bpy_speckle.convert.to_native import convert_to_native
-from specklepy.objects.base import Base
-
-def get_speckle_subobjects(attr: Union[dict, Base], scale: float, name: str) -> list:
-    subobjects = []
-    keys = attr.keys() if isinstance(attr, dict) else attr.get_dynamic_member_names()
-    for key in keys:
-        if isinstance(attr[key], dict):
-            subtype = attr[key].get("type", None)
-            if subtype:
-                name = f"{name}.{key}"
-                subobject = convert_to_native(attr[key], name)
-
-                subobjects.append(subobject)
-                props = attr[key].get("properties", None)
-                if props:
-                    subobjects.extend(get_speckle_subobjects(props, scale, name))
-        elif hasattr(attr[key], "type"):
-            subtype = attr[key].type
-            if subtype:
-                name = "{}.{}".format(name, key)
-                subobject = convert_to_native(attr[key], name)
-
-                subobjects.append(subobject)
-                props = attr[key].get("properties", None)
-                if props:
-                    subobjects.extend(get_speckle_subobjects(props, scale, name))
-    return subobjects

bpy_speckle/convert/constants.py

@@ -0,0 +1,21 @@
+IGNORED_PROPERTY_KEYS = {
+    "id",
+    "elements",
+    "displayMesh",
+    "displayValue",
+    "speckle_type",
+    "parameters",
+    "faces",
+    "colors",
+    "vertices",
+    "renderMaterial",
+    "textureCoordinates",
+    "totalChildrenCount"
+}
+
+DISPLAY_VALUE_PROPERTY_ALIASES = {"displayValue", "@displayValue"}
+ELEMENTS_PROPERTY_ALIASES = {"elements", "@elements"}
+
+OBJECT_NAME_MAX_LENGTH = 62
+SPECKLE_ID_LENGTH = 32
+OBJECT_NAME_SEPERATOR = " -- "

bpy_speckle/convert/to_native.py

@@ -1,6 +1,8 @@
 import math
-from typing import Tuple, Union, Collection
-from bpy_speckle.functions import get_scale_length, _report
+from typing import Any, Dict, Iterable, List, Optional, Union, Collection, cast
+from bpy_speckle.convert.constants import DISPLAY_VALUE_PROPERTY_ALIASES, ELEMENTS_PROPERTY_ALIASES, OBJECT_NAME_MAX_LENGTH, OBJECT_NAME_SEPERATOR, SPECKLE_ID_LENGTH
+from bpy_speckle.functions import get_default_traversal_func, get_scale_length, _report
+from bpy_speckle.convert.util import ConversionSkippedException
 from mathutils import (
     Matrix as MMatrix,
     Vector as MVector,
@@ -8,15 +10,19 @@ from mathutils import (
 )
 import bpy, bmesh
 from specklepy.objects.other import (
+    Collection as SCollection,
     Instance,
     Transform,
     BlockDefinition,
 )
-from specklepy.objects.geometry import *
-from bpy.types import Object
+from specklepy.objects.base import Base
+from specklepy.objects.geometry import Mesh, Line, Polyline, Curve, Arc, Polycurve, Ellipse, Circle, Plane
+from bpy.types import Object, Collection as BCollection
+
 from .util import (
+    add_to_heirarchy,
     get_render_material,
-    link_object_to_collection_nested,
+    get_vertex_color_material,
     render_material_to_native,
     add_custom_properties,
     add_vertices,
@@ -35,7 +41,7 @@ CAN_CONVERT_TO_NATIVE = (
 
 
 def _has_native_convesion(speckle_object: Base) -> bool: 
-    return any(isinstance(speckle_object, t) for t in CAN_CONVERT_TO_NATIVE) #or "View" in speckle_object.speckle_type #hack
+    return any(isinstance(speckle_object, t) for t in CAN_CONVERT_TO_NATIVE) or "View" in speckle_object.speckle_type #hack
 
 def _has_fallback_conversion(speckle_object: Base) -> bool: 
     return any(getattr(speckle_object, alias, None) for alias in DISPLAY_VALUE_PROPERTY_ALIASES)
@@ -91,11 +97,11 @@ def convert_to_native(speckle_object: Base) -> Object:
         converted = mesh_to_native(speckle_object, object_name, scale)
     elif speckle_type in SUPPORTED_CURVES:
         converted = icurve_to_native(speckle_object, object_name, scale)
-    # elif "View" in speckle_object.speckle_type:
-    #     return view_to_native(speckle_object, object_name, scale)
+    elif "View" in speckle_object.speckle_type:
+         return view_to_native(speckle_object, object_name, scale)
     elif isinstance(speckle_object, Instance):
         if convert_instances_as == "linked_duplicates":
-           (converted, children) = instance_to_native_object(speckle_object, scale)
+           converted = instance_to_native_object(speckle_object, scale)
         elif convert_instances_as == "collection_instance":
             converted = instance_to_native_collection_instance(speckle_object, scale)
         else:
@@ -108,19 +114,16 @@ def convert_to_native(speckle_object: Base) -> Object:
     if not isinstance(converted, Object):
         converted = create_new_object(converted, object_name)
     
-    converted.speckle.object_id = str(speckle_object.id)
-    converted.speckle.enabled = True
+    converted.speckle.object_id = str(speckle_object.id) # type: ignore
+    converted.speckle.enabled = True # type: ignore
     add_custom_properties(speckle_object, converted)
 
-    for child in children:
-        child.parent = converted
+    for c in children:
+        c.parent = converted
 
     return converted
 
 
-DISPLAY_VALUE_PROPERTY_ALIASES = ["displayValue", "@displayValue"]
-ELEMENTS_PROPERTY_ALIASES = ["elements", "@elements"]
-
 
 def display_value_to_native(speckle_object: Base, name: str, scale: float) -> tuple[Optional[bpy.types.Mesh], list[bpy.types.Object]]:
     return _members_to_native(speckle_object, name, scale, DISPLAY_VALUE_PROPERTY_ALIASES, True)
@@ -129,7 +132,7 @@ def elements_to_native(speckle_object: Base, name: str, scale: float) -> list[bp
     (_, elements) = _members_to_native(speckle_object, name, scale, ELEMENTS_PROPERTY_ALIASES, False)
     return elements
 
-def _members_to_native(speckle_object: Base, name: str, scale: float, members: List[str], combineMeshes: bool) -> tuple[Optional[bpy.types.Mesh], list[bpy.types.Object]]:
+def _members_to_native(speckle_object: Base, name: str, scale: float, members: Iterable[str], combineMeshes: bool) -> tuple[Optional[bpy.types.Mesh], list[bpy.types.Object]]:
     """
     Converts a given speckle_object by converting specified members
 
@@ -200,7 +203,7 @@ def view_to_native(speckle_view, name: str, scale: float) -> bpy.types.Object:
     scale_factor = get_scale_factor(speckle_view, scale)
     tx = (speckle_view.origin.x * scale_factor)
     ty = (speckle_view.origin.y * scale_factor)
-    tz = (speckle_view.origin.z * scale_factor)
+    tz = (speckle_view.origin.z * scale_factor) #TODO: do these need to be scaled?
 
     forward = MVector((speckle_view.forwardDirection.x, speckle_view.forwardDirection.y, speckle_view.forwardDirection.z))
     up = MVector((speckle_view.upDirection.x, speckle_view.upDirection.y, speckle_view.upDirection.z))
@@ -217,10 +220,11 @@ def view_to_native(speckle_view, name: str, scale: float) -> bpy.types.Object:
 def mesh_to_native(speckle_mesh: Mesh, name: str, scale: float) -> bpy.types.Mesh:
     return meshes_to_native(speckle_mesh, [speckle_mesh], name, scale)
 
+
+
 def meshes_to_native(element: Base, meshes: Collection[Mesh], name: str, scale: float) -> bpy.types.Mesh:
     if name in bpy.data.meshes.keys():
         return bpy.data.meshes[name]
-
     blender_mesh = bpy.data.meshes.new(name=name)
 
     fallback_material = get_render_material(element)
@@ -237,12 +241,20 @@ def meshes_to_native(element: Base, meshes: Collection[Mesh], name: str, scale:
     # Second pass, add face data
     offset = 0
     for i, mesh in enumerate(meshes):
+        if not mesh.vertices: continue
+
         add_faces(mesh, bm, offset, i)
 
-        render_material = get_render_material(mesh) or fallback_material
-        if render_material is not None:
-            native_material = render_material_to_native(render_material)
-            blender_mesh.materials.append(native_material)
+        try:
+            render_material = get_render_material(mesh) or fallback_material
+            if render_material is not None:
+                native_material = render_material_to_native(render_material)
+                blender_mesh.materials.append(native_material)
+            elif mesh.colors:
+                native_material = get_vertex_color_material()
+                blender_mesh.materials.append(native_material)
+        except Exception as ex:
+            _report(f"Failed converting render material for {name}: {ex}")
 
         offset += len(mesh.vertices) // 3
 
@@ -251,8 +263,15 @@ def meshes_to_native(element: Base, meshes: Collection[Mesh], name: str, scale:
 
     # Third pass, add vertex instance data
     for mesh in meshes:
-        add_colors(mesh, bm)
-        add_uv_coords(mesh, bm)
+        try:
+            add_colors(mesh, bm)
+        except Exception as ex:
+            _report(f"Skipping converting vertex colors for {name}: {ex}")
+            
+        try:
+            add_uv_coords(mesh, bm)
+        except Exception as ex:
+            _report(f"Skipping converting uv coordinates for {name}: {ex}")
 
     bm.to_mesh(blender_mesh)
     bm.free()  
@@ -264,7 +283,7 @@ def meshes_to_native(element: Base, meshes: Collection[Mesh], name: str, scale:
 Curves
 """
 
-def line_to_native(speckle_curve: Line, blender_curve: bpy.types.Curve, scale: float) -> list[bpy.types.Spline]:
+def line_to_native(speckle_curve: Line, blender_curve: bpy.types.Curve, scale: float) -> List[bpy.types.Spline]:
     if not speckle_curve.end: return []
 
     line = blender_curve.splines.new("POLY")
@@ -287,14 +306,14 @@ def line_to_native(speckle_curve: Line, blender_curve: bpy.types.Curve, scale: f
     return [line]
 
 
-def polyline_to_native(scurve: Polyline, bcurve: bpy.types.Curve, scale: float) -> list[bpy.types.Spline]:
+def polyline_to_native(scurve: Polyline, bcurve: bpy.types.Curve, scale: float) -> List[bpy.types.Spline]:
     if not (value := scurve.value): return []
     N = len(value) // 3
 
     polyline = bcurve.splines.new("POLY")
 
     if hasattr(scurve, "closed"):
-        polyline.use_cyclic_u = scurve.closed
+        polyline.use_cyclic_u = scurve.closed or False
 
     polyline.points.add(N - 1)
     for i in range(N):
@@ -309,15 +328,17 @@ def polyline_to_native(scurve: Polyline, bcurve: bpy.types.Curve, scale: float)
     
 
 
-def nurbs_to_native(scurve: Curve, bcurve: bpy.types.Curve, scale: float) -> list[bpy.types.Spline]:
+def nurbs_to_native(scurve: Curve, bcurve: bpy.types.Curve, scale: float) -> List[bpy.types.Spline]:
     if not (points := scurve.points): return []
+    if not scurve.degree: raise Exception("curve is missing degree")
+    if not scurve.weights: raise Exception("curve is missing weights")
 
     # Closed curves from rhino will have n + degree points. We ignore the extras
     num_points = len(points) // 3 - scurve.degree if (scurve.closed) else (
         len(points) // 3)   
     
     nurbs = bcurve.splines.new("NURBS")
-    nurbs.use_cyclic_u = scurve.closed
+    nurbs.use_cyclic_u = scurve.closed or False
     nurbs.use_endpoint_u = not scurve.periodic
     
     nurbs.points.add(num_points - 1)
@@ -339,6 +360,9 @@ def nurbs_to_native(scurve: Curve, bcurve: bpy.types.Curve, scale: float) -> lis
 
 def arc_to_native(rcurve: Arc, bcurve: bpy.types.Curve, scale: float) -> Optional[bpy.types.Spline]:
     # TODO: improve Blender representation of arc - check autocad test stream
+    if not rcurve.radius: raise Exception("curve is missing radius")
+    if not rcurve.startAngle: raise Exception("curve is missing startAngle")
+    if not rcurve.endAngle: raise Exception("curve is missing endAngle")
 
     plane = rcurve.plane
     if not plane:
@@ -350,8 +374,8 @@ def arc_to_native(rcurve: Arc, bcurve: bpy.types.Curve, scale: float) -> Optiona
     startAngle = rcurve.startAngle
     endAngle = rcurve.endAngle
 
-    startQuat = MQuaternion(normal, startAngle)
-    endQuat = MQuaternion(normal, endAngle)
+    startQuat = MQuaternion(normal, startAngle) # type: ignore
+    endQuat = MQuaternion(normal, endAngle) # type: ignore
 
     # Get start and end vectors, centre point, angles, etc.
     r1 = MVector([plane.xdir.x, plane.xdir.y, plane.xdir.z])
@@ -376,7 +400,7 @@ def arc_to_native(rcurve: Arc, bcurve: bpy.types.Curve, scale: float) -> Optiona
 
     Ndiv = max(int(math.floor(angle / 0.3)), 2)
     step = angle / float(Ndiv)
-    stepQuat = MQuaternion(normal, step)
+    stepQuat = MQuaternion(normal, step) # type: ignore
     tan = math.tan(step / 2) * radius
 
     arc.points.add(Ndiv + 1)
@@ -403,11 +427,11 @@ def polycurve_to_native(scurve: Polycurve, bcurve: bpy.types.Curve, scale: float
     """
     Convert Polycurve object
     """
-    segments = scurve.segments
+    if not scurve.segments: raise Exception("curve is missing segments")
 
     curves = []
 
-    for seg in segments:
+    for seg in scurve.segments:
         speckle_type = type(seg)
 
         if speckle_type in SUPPORTED_CURVES:
@@ -417,14 +441,20 @@ def polycurve_to_native(scurve: Polycurve, bcurve: bpy.types.Curve, scale: float
 
     return curves
  
-def ellipse_to_native(ellipse: Union[Ellipse, Circle], bcurve: bpy.types.Curve, units_scale: float) -> list[bpy.types.Spline]:
+def ellipse_to_native(ellipse: Union[Ellipse, Circle], bcurve: bpy.types.Curve, units_scale: float) -> List[bpy.types.Spline]:
+    if not ellipse.plane: raise Exception("curve is missing plane")
 
     radX: float
     radY: float
     if isinstance(ellipse, Ellipse):
+        if not ellipse.firstRadius: raise Exception("curve is missing firstRadius")
+        if not ellipse.secondRadius: raise Exception("curve is missing secondRadius")
+
         radX = ellipse.firstRadius * units_scale
         radY = ellipse.secondRadius * units_scale
     else:
+        if not ellipse.radius: raise Exception("curve is missing radius")
+
         radX = ellipse.radius * units_scale
         radY = ellipse.radius * units_scale
 
@@ -457,9 +487,9 @@ def ellipse_to_native(ellipse: Union[Ellipse, Circle], bcurve: bpy.types.Curve,
     spline.bezier_points.add(len(points) - 1)
 
     for i in range(len(points)):
-        spline.bezier_points[i].co = transform @ MVector(points[i])
-        spline.bezier_points[i].handle_left = transform @ MVector(left_handles[i])
-        spline.bezier_points[i].handle_right = transform @ MVector(right_handles[i])
+        spline.bezier_points[i].co = transform @ MVector(points[i]) # type: ignore
+        spline.bezier_points[i].handle_left = transform @ MVector(left_handles[i]) # type: ignore
+        spline.bezier_points[i].handle_right = transform @ MVector(right_handles[i]) # type: ignore
 
     spline.use_cyclic_u = True
     
@@ -467,26 +497,28 @@ def ellipse_to_native(ellipse: Union[Ellipse, Circle], bcurve: bpy.types.Curve,
     return [spline]
 
 
-def icurve_to_native_spline(speckle_curve: Base, blender_curve: bpy.types.Curve, scale: float) -> list[bpy.types.Spline]:
+def icurve_to_native_spline(speckle_curve: Base, blender_curve: bpy.types.Curve, scale: float) -> List[bpy.types.Spline]:
     # polycurves
     if isinstance(speckle_curve, Polycurve):
         return polycurve_to_native(speckle_curve, blender_curve, scale)
 
+    splines: List[bpy.types.Spline]
     # single curves
     if isinstance(speckle_curve, Line):
-        spline = line_to_native(speckle_curve, blender_curve, scale)
+        splines = line_to_native(speckle_curve, blender_curve, scale)
     elif isinstance(speckle_curve, Curve):
-        spline = nurbs_to_native(speckle_curve, blender_curve, scale)
+        splines = nurbs_to_native(speckle_curve, blender_curve, scale)
     elif isinstance(speckle_curve, Polyline):
-        spline = polyline_to_native(speckle_curve, blender_curve, scale)
+        splines = polyline_to_native(speckle_curve, blender_curve, scale)
     elif isinstance(speckle_curve, Arc):
         spline = arc_to_native(speckle_curve, blender_curve, scale)
+        splines = [spline] if spline else []
     elif isinstance(speckle_curve, Ellipse) or isinstance(speckle_curve, Circle):
-        spline = ellipse_to_native(speckle_curve, blender_curve, scale)
+        splines = ellipse_to_native(speckle_curve, blender_curve, scale)
     else:
         raise TypeError(f"{speckle_curve} is not a supported curve type. Supported types: {SUPPORTED_CURVES}")
 
-    return [spline] if spline is not None else [] 
+    return splines
 
 
 def icurve_to_native(speckle_curve: Base, name: str, scale: float) -> bpy.types.Curve:
@@ -522,7 +554,7 @@ def transform_to_native(transform: Transform, scale: float) -> MMatrix:
     )
     # scale the translation
     for i in range(3):
-        mat[i][3] *= scale
+        mat[i][3] *= scale # type: ignore
     return mat
 
 def plane_to_native_transform(plane: Plane, fallback_scale:float = 1) -> MMatrix:
@@ -545,43 +577,59 @@ Instances / Blocks
 """
 
 def _get_instance_name(instance: Instance) -> str:
-    name_prefix = _get_friendly_object_name(instance) or _get_friendly_object_name(instance.definition) or _simplified_speckle_type(instance.speckle_type)
+    if not instance.definition: raise Exception("Instance is missing a definition")
+    name_prefix = (
+        _get_friendly_object_name(instance) 
+        or _get_friendly_object_name(instance.definition) 
+        or _simplified_speckle_type(instance.speckle_type)
+    )
     return f"{name_prefix}{OBJECT_NAME_SEPERATOR}{instance.id}"
 
 
-def instance_to_native_object(instance: Instance, scale: float) -> Tuple[bpy.types.Object, List[bpy.types.Object]]:
+def instance_to_native_object(instance: Instance, scale: float) -> Object:
     """
     Converts Instance to a unique object with (potentially) shared data (linked duplicate)
     """
-    if not instance.definition: raise Exception(f"Instance is missing a definition")
-    if not instance.transform: raise Exception(f"Instance is missing a transform")
+    if not instance.definition: raise Exception("Instance is missing a definition")
+    if not instance.transform: raise Exception("Instance is missing a transform")
+    definition = instance.definition
+    if not definition.id: raise Exception("Instance is missing a valid definition")
 
     name = _get_instance_name(instance)
-    definition = instance.definition
 
-    native_instance: Object
-    native_elements: List[Object] = []
-    elements_on_instance: List[Object] = []
-
-    if isinstance(definition, BlockDefinition): #NOTE: We have to handle BlockDefinitions specially here, since they don't follow normal traversal rules
-        native_instance = create_new_object(None, name) #Instance will be empty
+    native_instance: Optional[Object] = None
+    converted_objects: Dict[str, Union[Object, BCollection]] = {}
+    traversal_root: Base = definition
+    
+    if not can_convert_to_native(definition):
+        # Non-convertable (like all blocks, and some revit instances) will not be converted as part of the deep_traversal.
+        # so we explicitly convert them as empties.
+        native_instance = create_new_object(None, name) 
         native_instance.empty_display_size = 0
-        for geo in definition.geometry:
-            native_elements.append(convert_to_native(geo))
-    else:
-        native_instance = convert_to_native(instance.definition)
+
+        converted_objects["__ROOT"] = native_instance # we create a dummy root to avoid id conflicts, since revit definitions have displayValues, they are convertable
+        traversal_root = Base(elements=definition, id="__ROOT")
+
+    #Convert definition + "elements" on definition
+    _deep_conversion(traversal_root, converted_objects, False)
+
+    if not native_instance:
+        assert(can_convert_to_native(definition))
+
+        if not definition.id in converted_objects:
+            raise Exception("Definition was not converted")
+
+        converted = converted_objects[definition.id]
+
+        if not isinstance(converted, Object):
+            raise Exception("Definition was not converted to an Object")
+        
+        native_instance = converted
 
     instance_transform = transform_to_native(instance.transform, scale)
-    instance_transform_inverted = instance_transform.inverted()
     native_instance.matrix_world = instance_transform
-    
-    elements_on_instance = elements_to_native(instance, name, scale)
-    for c in elements_on_instance:
-        c.matrix_world = instance_transform_inverted @ c.matrix_world #Undo the instance transform on elements
 
-    native_elements.extend(elements_on_instance)
-
-    return (native_instance, native_elements) #TODO: need to double check that all child objects have custom props attached correctly
+    return native_instance
 
 def instance_to_native_collection_instance(instance: Instance, scale: float) -> bpy.types.Object:
     """
@@ -591,19 +639,15 @@ def instance_to_native_collection_instance(instance: Instance, scale: float) ->
     The definition collection won't be linked to the current scene
     Any Elements on the instance object will also be converted (and spacially transformed)
     """
-    if not instance.definition: raise Exception(f"Instance is missing a definition")
-    if not instance.transform: raise Exception(f"Instance is missing a transform")
+    if not instance.definition: raise Exception("Instance is missing a definition")
+    if not instance.transform: raise Exception("Instance is missing a transform")
 
     name = _get_instance_name(instance)
 
     # Get/Convert definition collection
     collection_def = _instance_definition_to_native(instance.definition)
 
-    # Convert elements as children of collection instance object
-    elements = elements_to_native(instance, name, scale)
-
     instance_transform = transform_to_native(instance.transform, scale)
-    instance_transform_inverted = instance_transform.inverted()
 
     native_instance = bpy.data.objects.new(name, None)
 
@@ -612,12 +656,8 @@ def instance_to_native_collection_instance(instance: Instance, scale: float) ->
     native_instance.empty_display_size = 0
     native_instance.instance_collection = collection_def
     native_instance.instance_type = "COLLECTION"
-    native_instance.matrix_world =instance_transform
-
-    for c in elements:
-        c.matrix_world = instance_transform_inverted @ c.matrix_world #Undo the instance transform on elements
-        c.parent = native_instance #TODO: need to double check that all child objects have custom props attached correctly
-
+    native_instance.matrix_world = instance_transform
+        
     return native_instance 
 
 def _instance_definition_to_native(definition: Union[Base, BlockDefinition]) -> bpy.types.Collection:
@@ -632,17 +672,76 @@ def _instance_definition_to_native(definition: Union[Base, BlockDefinition]) ->
     native_def = bpy.data.collections.new(name)
     native_def["applicationId"] = definition.applicationId
 
-    #TODO could maybe replace BlockDefinition awareness with a single traverse member call
-    geometry = definition.geometry if isinstance(definition, BlockDefinition) else [definition]
-
-    for geo in geometry:
-        if not geo: continue
-        converted = convert_to_native(geo) #NOTE: we assume the last item is the root converted item
-        link_object_to_collection_nested(converted, native_def)
+    converted_objects = {}
+    converted_objects["__ROOT"] = native_def # we create a dummy root to avoid id conflicts, since revit definitions have displayValues, they are convertable
+    dummyRoot = Base(elements=definition, id="__ROOT")
 
+    _deep_conversion(dummyRoot, converted_objects, True)
 
     return native_def
 
+def _deep_conversion(root: Base, converted_objects: Dict[str, Union[Object, BCollection]], preserve_transform: bool):
+    traversal_func = get_default_traversal_func(can_convert_to_native)
+
+    for item in traversal_func.traverse(root):
+        
+        current: Base = item.current
+        if can_convert_to_native(current) or isinstance(current, SCollection):
+            try:
+                if not current or not current.id: raise Exception(f"{current} was an invalid speckle object")
+
+                #Convert the object!
+                converted_data_type: str
+                converted: Union[Object, BCollection, None]
+                if isinstance(current, SCollection):
+                    if(current.collectionType == "Scene Collection"): raise ConversionSkippedException()
+                    converted = collection_to_native(current)
+                    converted_data_type = "COLLECTION"
+                else:
+                    converted = convert_to_native(current)
+                    converted_data_type = "COLLECTION_INSTANCE" if converted.instance_collection else str(converted.type)
+                
+                if converted is None:
+                    raise Exception("Conversion returned None")
+                    
+                converted_objects[current.id] = converted
+
+                add_to_heirarchy(converted, item, converted_objects, preserve_transform)
+
+                _report(f"Successfully converted {type(current).__name__} {current.id} as '{converted_data_type}'")
+            except ConversionSkippedException as ex:
+                _report(f"Skipped converting {type(current).__name__} {current.id}: {ex}")
+            except Exception as ex:
+                _report(f"Failed to converted {type(current).__name__} {current.id}: {ex}")
+
+def collection_to_native(collection: SCollection) -> BCollection: 
+    name = collection.name or f"{collection.collectionType} -- {collection.applicationId or collection.id}"  #TODO: consider consolidating name formatting with Rhino
+    ret =  get_or_create_collection(name)
+
+    color = getattr(collection, "colorTag", None)
+    if color:
+        ret.color_tag = color
+
+    return ret
+
+def get_or_create_collection(name: str, clear_collection: bool = True) -> BCollection:
+    existing = cast(BCollection, bpy.data.collections.get(name))
+    if existing:
+        if clear_collection:
+            for obj in existing.objects:
+                existing.objects.unlink(obj)
+        return existing
+    else:
+        new_collection = bpy.data.collections.new(name)
+
+        #NOTE: We want to not render revit "Rooms" collections by default.
+        if name == "Rooms":
+            new_collection.hide_viewport = True
+            new_collection.hide_render = True
+
+        return new_collection
+    
+    
 
 """
 Object Naming
@@ -658,9 +757,7 @@ def _get_friendly_object_name(speckle_object: Base) -> Optional[str]:
 # Blender object names must not exceed 62 characters
 # We need to ensure the complete ID is included in the name (to prevent identity collisions)
 # So we if the name is too long, we need to truncate
-OBJECT_NAME_MAX_LENGTH = 62
-SPECKLE_ID_LENGTH = 32
-OBJECT_NAME_SEPERATOR = " -- "
+
 
 def _truncate_object_name(name: str) -> str:
 

bpy_speckle/convert/to_speckle.py

@@ -6,6 +6,7 @@ from bpy.types import (
     Object, 
     Curve as NCurve,
     Mesh as NMesh,
+    Camera as NCamera,
 )
 from deprecated import deprecated
 from mathutils.geometry import interpolate_bezier
@@ -16,10 +17,12 @@ from mathutils import (
 from specklepy.objects import Base
 from specklepy.objects.other import BlockInstance, BlockDefinition, RenderMaterial, Transform
 from specklepy.objects.geometry import (
-     Mesh, Curve, Interval, Box, Point, Polyline
+     Mesh, Curve, Interval, Box, Point, Vector, Polyline,
 )
-from bpy_speckle.convert.to_native import OBJECT_NAME_SEPERATOR, SPECKLE_ID_LENGTH
+from bpy_speckle.blender_commit_object_builder import BlenderCommitObjectBuilder
+from bpy_speckle.convert.constants import OBJECT_NAME_SEPERATOR, SPECKLE_ID_LENGTH
 from bpy_speckle.convert.util import (
+    ConversionSkippedException,
     get_blender_custom_properties,
     make_knots,
     nurb_make_curve,
@@ -27,13 +30,11 @@ from bpy_speckle.convert.util import (
 )
 from bpy_speckle.functions import _report
 
-class ConversionSkippedException(Exception):
-    pass
 
 Units: str = "m" # The desired final units to send
 UnitsScale: float = 1 # The scale factor conversions need to apply to position data to get to the desired units
 
-CAN_CONVERT_TO_SPECKLE = ("MESH", "CURVE", "EMPTY")
+CAN_CONVERT_TO_SPECKLE = ("MESH", "CURVE", "EMPTY", "CAMERA")
 
 
 def convert_to_speckle(raw_blender_object: Object, units_scale: float, units: str, depsgraph: Optional[Depsgraph]) -> Base:
@@ -66,7 +67,8 @@ def convert_to_speckle(raw_blender_object: Object, units_scale: float, units: st
         converted = curve_to_speckle(blender_object, cast(NCurve, blender_object.data))
     elif blender_type == "EMPTY":
         converted = empty_to_speckle(blender_object)
-
+    elif blender_type == "CAMERA":
+        converted = camera_to_speckle_view(blender_object, cast(NCamera, blender_object.data))
     if not converted:
         raise Exception("Conversion returned None")
 
@@ -97,7 +99,7 @@ def mesh_to_speckle_meshes(blender_object: Object, data: bpy.types.Mesh) -> List
         submesh_data[p.material_index].append(p)
 
     transform = cast(MMatrix, blender_object.matrix_world)
-    scaled_vertices = [tuple(transform @ x.co * UnitsScale) for x in data.vertices]
+    scaled_vertices = [tuple(transform @ x.co * UnitsScale) for x in data.vertices] # type: ignore
 
     # Create Speckle meshes for each material
     submeshes = []
@@ -158,17 +160,17 @@ def bezier_to_speckle(matrix: MMatrix, spline: bpy.types.Spline, name: Optional[
     points: List[Tuple[MVector]] = []
     for i, bp in enumerate(spline.bezier_points):
         if i > 0:
-            points.append(tuple(matrix @ bp.handle_left * UnitsScale))
-        points.append(tuple(matrix @ bp.co * UnitsScale))
+            points.append(tuple(matrix @ bp.handle_left * UnitsScale)) # type: ignore
+        points.append(tuple(matrix @ bp.co * UnitsScale)) # type: ignore
         if i < len(spline.bezier_points) - 1:
-            points.append(tuple(matrix @ bp.handle_right * UnitsScale))
+            points.append(tuple(matrix @ bp.handle_right * UnitsScale)) # type: ignore
 
     if closed:
         points.extend(
             (
-                tuple(matrix @ spline.bezier_points[-1].handle_right * UnitsScale),
-                tuple(matrix @ spline.bezier_points[0].handle_left * UnitsScale),
-                tuple(matrix @ spline.bezier_points[0].co * UnitsScale),
+                tuple(matrix @ spline.bezier_points[-1].handle_right * UnitsScale), # type: ignore
+                tuple(matrix @ spline.bezier_points[0].handle_left * UnitsScale), # type: ignore
+                tuple(matrix @ spline.bezier_points[0].co * UnitsScale), # type: ignore
             )
         )
     
@@ -215,7 +217,7 @@ def nurbs_to_speckle(matrix: MMatrix, spline: bpy.types.Spline, name: Optional[s
     weights = [pt.weight for pt in spline.points]
     is_rational = all(w == weights[0] for w in weights)
 
-    points = [tuple(matrix @ pt.co.xyz * UnitsScale) for pt in spline.points]
+    points = [tuple(matrix @ pt.co.xyz * UnitsScale) for pt in spline.points] # type: ignore
 
     flattend_points = []
     for row in points: flattend_points.extend(row)
@@ -252,13 +254,13 @@ def nurbs_to_speckle_polyline(matrix: MMatrix, spline: bpy.types.Spline, length:
     """
     Samples a nurbs curve with resolution_u creating a polyline
     """
-    points = []
+    points: List[float] = []
     sampled_points = nurb_make_curve(spline, spline.resolution_u, 3)
     for i in range(0, len(sampled_points), 3):
-        scaled_point = matrix @ MVector((
+        scaled_point = cast(Vector, matrix @ MVector((
         sampled_points[i + 0],
         sampled_points[i + 1],
-        sampled_points[i + 2])) * UnitsScale
+        sampled_points[i + 2])) * UnitsScale)
 
         points.append(scaled_point.x)
         points.append(scaled_point.y)
@@ -313,7 +315,7 @@ def to_speckle_name(blender_object: bpy.types.ID) -> str:
         return blender_object.name
 
 def poly_to_speckle(matrix: MMatrix, spline: bpy.types.Spline, name: Optional[str] = None) -> Polyline:
-    points = [tuple(matrix @ pt.co.xyz * UnitsScale) for pt in spline.points]
+    points = [tuple(matrix @ pt.co.xyz * UnitsScale) for pt in spline.points] # type: ignore
 
     flattend_points = []
     for row in points: flattend_points.extend(row)
@@ -382,7 +384,7 @@ def ngons_to_speckle_polylines(blender_object: Object, data: bpy.types.Mesh) ->
     for i, poly in enumerate(data.polygons):
         value = []
         for v in poly.vertices:
-            value.extend(mat @ verts[v].co * UnitsScale)
+            value.extend(mat @ verts[v].co * UnitsScale) # type: ignore
 
         domain = Interval(start=0, end=1)
         poly = Polyline(
@@ -408,38 +410,60 @@ def material_to_speckle(blender_mat: bpy.types.Material) -> RenderMaterial:
     if blender_mat.use_nodes:
         if blender_mat.node_tree.nodes.get("Principled BSDF"):
             inputs = blender_mat.node_tree.nodes["Principled BSDF"].inputs
-            speckle_mat.diffuse = to_argb_int(inputs["Base Color"].default_value)
-            speckle_mat.emissive = to_argb_int(inputs["Emission"].default_value)
-            speckle_mat.roughness = inputs["Roughness"].default_value
-            speckle_mat.metalness = inputs["Metallic"].default_value
-            speckle_mat.opacity = inputs["Alpha"].default_value
+            speckle_mat.diffuse = to_argb_int(inputs["Base Color"].default_value) # type: ignore
+            speckle_mat.emissive = to_argb_int(inputs["Emission"].default_value) # type: ignore
+            speckle_mat.roughness = inputs["Roughness"].default_value # type: ignore
+            speckle_mat.metalness = inputs["Metallic"].default_value # type: ignore
+            speckle_mat.opacity = inputs["Alpha"].default_value # type: ignore
             return speckle_mat
         elif blender_mat.node_tree.nodes.get("Diffuse BSDF"):
             inputs = blender_mat.node_tree.nodes["Diffuse BSDF"].inputs
-            speckle_mat.diffuse = to_argb_int(inputs["Color"].default_value)
-            speckle_mat.roughness = inputs["Roughness"].default_value
+            speckle_mat.diffuse = to_argb_int(inputs["Color"].default_value) # type: ignore
+            speckle_mat.roughness = inputs["Roughness"].default_value # type: ignore
             return speckle_mat
         #TODO: Support more shaders
 
     # fallback to standard material props
-    speckle_mat.diffuse = to_argb_int(blender_mat.diffuse_color)
+    speckle_mat.diffuse = to_argb_int(blender_mat.diffuse_color) # type: ignore
     speckle_mat.metalness = blender_mat.metallic
     speckle_mat.roughness = blender_mat.roughness
 
     return speckle_mat
 
-@deprecated
-def material_to_speckle_old(blender_object: Object) -> Optional[RenderMaterial]:
-    """Create and return a render material from a blender object"""
-    if not getattr(blender_object.data, "materials", None):
-        return None
+def camera_to_speckle_view(blender_object: Object, data: NCamera) -> Base:
+    if data.type != 'PERSP':
+        raise Exception(f"Cameras of type {data.type} are not currently supported")
+    
+    matrix = cast(MMatrix, blender_object.matrix_world)
+    up = matrix.col[1].xyz # type: ignore
+    forwards = -matrix.col[2].xyz # type: ignore
+    translation = matrix.translation
 
-    blender_mat: bpy.types.Material = blender_object.data.materials[0]
-    if not blender_mat:
-        return None
+    view = Base.of_type("Objects.BuiltElements.View:Objects.BuiltElements.View3D") #HACK: views are not in specklepy yet!
+    view.name = to_speckle_name(blender_object)
+    view.origin = vector_to_speckle_point(translation)
+    view.upDirection = vector_to_speckle(up)
+    view.forwardDirection = vector_to_speckle(forwards)
+    view.target = vector_to_speckle_point(forwards) #TODO: do these need to be scaled?
+    view.units = Units
+    view.isOrthogonal = False
+    return view
 
-    return material_to_speckle(blender_mat)
+def vector_to_speckle_point(xyz: MVector) -> Point:
+    return Point(
+        x = xyz.x * UnitsScale,
+        y = xyz.y * UnitsScale,
+        z = xyz.z * UnitsScale,
+        units = Units,
+        )
 
+def vector_to_speckle(xyz: MVector) -> Vector:
+    return Vector(
+        x = xyz.x * UnitsScale,
+        y = xyz.y * UnitsScale,
+        z = xyz.z * UnitsScale,
+        units = Units,
+        )
 
 def transform_to_speckle(blender_transform: Union[Iterable[Iterable[float]], MMatrix]) -> Transform:
     iterable_transform = cast(Iterable[Iterable[float]], blender_transform) #NOTE: Matrix are itterable, even if type hinting says they are not
@@ -452,20 +476,23 @@ def transform_to_speckle(blender_transform: Union[Iterable[Iterable[float]], MMa
 
 
 def block_def_to_speckle(blender_definition: bpy.types.Collection) -> BlockDefinition:
-    geometry = []
+    geometryBuilder = BlenderCommitObjectBuilder()
     for geo in blender_definition.objects:
         try:
-            #TODO: right now, geometry will be a flat list of objects. Eventually we will want to preseve the parent relationship
-            geometry.append(convert_to_speckle(geo, UnitsScale, Units, None))
+            c = convert_to_speckle(geo, UnitsScale, Units, None)
+            geometryBuilder.include_object(c, geo)
         except ConversionSkippedException as ex:
             _report(f"Skipped converting '{geo.name_full}' inside collection instance: '{ex}")
         except Exception as ex:
             _report(f"Failed to converted '{geo.name_full}' inside collection instance: '{ex}'")
 
+    dummyRoot = Base()
+    geometryBuilder.apply_relationships(geometryBuilder.converted.values(), dummyRoot)
+
     block_def = BlockDefinition(
         units=Units,
         name=to_speckle_name(blender_definition),
-        geometry=geometry,
+        geometry=dummyRoot["@elements"],
         basePoint=Point(units=Units),
     )
     # blender_props = get_blender_custom_properties(blender_definition)

bpy_speckle/convert/util.py

@@ -1,29 +1,19 @@
 import math
-from typing import Any, Optional, Tuple
+from typing import Any, Dict, Optional, Tuple, Union, cast
 from bmesh.types import BMesh
-import bpy, struct, idprop
+import bpy, idprop
 
 from specklepy.objects.base import Base
-from specklepy.objects.geometry import Circle, Mesh, Ellipse
+from specklepy.objects.geometry import Mesh
 from specklepy.objects.other import RenderMaterial
+from bpy_speckle.convert.constants import IGNORED_PROPERTY_KEYS
 from bpy_speckle.functions import _report
-from bpy.types import Material, Object
+from bpy.types import Material, Object, Collection as BCollection, Node, ShaderNodeVertexColor
 
-IGNORED_PROPERTY_KEYS = {
-    "id",
-    "elements",
-    "displayMesh",
-    "displayValue",
-    "speckle_type",
-    "parameters",
-    "faces",
-    "colors",
-    "vertices",
-    "renderMaterial",
-    "textureCoordinates",
-    "totalChildrenCount"
-}
+from bpy_speckle.specklepy_extras.traversal import TraversalContext
 
+class ConversionSkippedException(Exception):
+    pass
 
 def to_rgba(argb_int: int) -> Tuple[float, float, float, float]:
     """Converts the int representation of a colour into a percent RGBA tuple"""
@@ -97,29 +87,53 @@ def render_material_to_native(speckle_mat: RenderMaterial) -> Material:
         blender_mat.use_nodes = True
         inputs = blender_mat.node_tree.nodes["Principled BSDF"].inputs
 
-        inputs["Base Color"].default_value = to_rgba(speckle_mat.diffuse)
-        inputs["Emission"].default_value = to_rgba(speckle_mat.emissive)
-        inputs["Roughness"].default_value = speckle_mat.roughness
-        inputs["Metallic"].default_value = speckle_mat.metalness
-        inputs["Alpha"].default_value = speckle_mat.opacity
+        inputs["Base Color"].default_value = to_rgba(speckle_mat.diffuse) # type: ignore
+        inputs["Emission"].default_value = to_rgba(speckle_mat.emissive) # type: ignore
+        inputs["Roughness"].default_value = speckle_mat.roughness # type: ignore
+        inputs["Metallic"].default_value = speckle_mat.metalness # type: ignore
+        inputs["Alpha"].default_value = speckle_mat.opacity # type: ignore
 
     if speckle_mat.opacity < 1.0:
         blender_mat.blend_method = "BLEND"
 
     return blender_mat
 
+_vertex_color_material: Optional[Material] = None
+
+def get_vertex_color_material() -> Material:
+    global _vertex_color_material
+    
+    #see https://stackoverflow.com/a/69807985
+    if not _vertex_color_material:
+        _vertex_color_material = bpy.data.materials.new("Vertex Color Material")
+        _vertex_color_material.use_nodes = True
+        nodes = _vertex_color_material.node_tree.nodes
+        principled_bsdf_node = cast(Node, nodes.get("Principled BSDF"))
+    
+        if not "VERTEX_COLOR" in [node.type for node in nodes]:
+            vertex_color_node = cast(ShaderNodeVertexColor, nodes.new(type = "ShaderNodeVertexColor"))
+        else:
+            vertex_color_node = cast(ShaderNodeVertexColor, nodes.get("Vertex Color"))
+        vertex_color_node.layer_name = "Col"
+
+        links = _vertex_color_material.node_tree.links
+        link = links.new(vertex_color_node.outputs[0], principled_bsdf_node.inputs[0])
+
+    return _vertex_color_material
+
 def get_render_material(speckle_object: Base) -> Optional[RenderMaterial]:
-    """Trys to get a RenderMaterial on given speckle_object and convert it to a blender material"""
+    """Trys to get a RenderMaterial on given speckle_object"""
 
     speckle_mat = getattr(
         speckle_object,
         "renderMaterial",
         getattr(speckle_object, "@renderMaterial", None),
     )
-    if not isinstance(speckle_mat, RenderMaterial):
-        return None
 
-    return speckle_mat
+    if isinstance(speckle_mat, RenderMaterial):
+        return speckle_mat
+
+    return None
     
 
 
@@ -151,7 +165,7 @@ def add_faces(speckle_mesh: Mesh, blender_mesh: BMesh, indexOffset: int, materia
             i += 1
             try:
                 f = blender_mesh.faces.new(
-                    [blender_mesh.verts[x + indexOffset] for x in sfaces[i : i + n]]
+                    [blender_mesh.verts[x + indexOffset] for x in sfaces[i : i + n]] # type: ignore
                 )
                 f.material_index = materialIndex
                 f.smooth = smooth
@@ -169,10 +183,8 @@ def add_colors(speckle_mesh: Mesh, blender_mesh: BMesh):
         if len(scolors) > 0:
 
             for i in range(len(scolors)):
-                col = int(scolors[i])
-                (a, r, g, b) = [
-                    int(x) for x in struct.unpack("!BBBB", struct.pack("!i", col))
-                ]
+                argb = int(scolors[i])
+                (a, r, g, b) = argb_split(argb)
                 colors.append(
                     (
                         float(r) / 255.0,
@@ -183,13 +195,20 @@ def add_colors(speckle_mesh: Mesh, blender_mesh: BMesh):
                 )
 
         # Make vertex colors
-        if len(scolors) == len(blender_mesh.verts):
+        if len(scolors) == len(blender_mesh.verts): # type: ignore
             color_layer = blender_mesh.loops.layers.color.new("Col")
 
-            for face in blender_mesh.faces:
+            for face in blender_mesh.faces: # type: ignore
                 for loop in face.loops:
                     loop[color_layer] = colors[loop.vert.index]
 
+def argb_split(argb: int) -> Tuple[int, int, int, int]:
+    alpha = (argb >> 24) & 0xFF
+    red = (argb >> 16) & 0xFF
+    green = (argb >> 8) & 0xFF
+    blue = argb & 0xFF
+
+    return (alpha, red, green, blue)
 
 def add_uv_coords(speckle_mesh: Mesh, blender_mesh: BMesh):
     s_uvs = speckle_mesh.textureCoordinates
@@ -198,21 +217,21 @@ def add_uv_coords(speckle_mesh: Mesh, blender_mesh: BMesh):
     try:
         uv = []
 
-        if len(s_uvs) // 2 == len(blender_mesh.verts):
+        if len(s_uvs) // 2 == len(blender_mesh.verts): # type: ignore
             uv.extend(
                 (float(s_uvs[i]), float(s_uvs[i + 1]))
                 for i in range(0, len(s_uvs), 2)
             )
         else:
             _report(
-                f"Failed to match UV coordinates to vert data. Blender mesh verts: {len(blender_mesh.verts)}, Speckle UVs: {len(s_uvs) // 2}"
+                f"Failed to match UV coordinates to vert data. Blender mesh verts: {len(blender_mesh.verts)}, Speckle UVs: {len(s_uvs) // 2}" # type: ignore
             )
             return
 
         # Make UVs
         uv_layer = blender_mesh.loops.layers.uv.verify()
 
-        for f in blender_mesh.faces:
+        for f in blender_mesh.faces: # type: ignore
             for l in f.loops:
                 luv = l[uv_layer]
                 luv.uv = uv[l.vert.index]
@@ -248,7 +267,7 @@ def get_blender_custom_properties(obj, max_depth: int = 200):
         }
 
     if isinstance(obj, (list, tuple, idprop.types.IDPropertyArray)):
-        return [get_blender_custom_properties(o, max_depth - 1) for o in obj]
+        return [get_blender_custom_properties(o, max_depth - 1) for o in obj] # type: ignore
     
     return obj
 
@@ -304,7 +323,7 @@ def basis_nurb(t: float, order: int, point_count: int, knots: list[float], basis
     i1 = i2 = 0
     orderpluspnts = order + point_count
     opp2 = orderpluspnts - 1
-
+    
     # this is for float inaccuracy
     if t < knots[0]:
         t = knots[0]
@@ -329,7 +348,7 @@ def basis_nurb(t: float, order: int, point_count: int, knots: list[float], basis
         else:
             basis[i] = 0.0
 
-    basis[i] = 0.0
+    basis[i] = 0.0 #type: ignore
 
     # this is order 2, 3, ...
     for j in range(2, order + 1):
@@ -393,14 +412,14 @@ def nurb_make_curve(nu: bpy.types.Spline, resolu: int, stride: int = 3) -> list[
             else:
                 pt_index += 1
 
-            sum_array[sum_index] = basisu[i] * nu.points[pt_index].co[3]
+            sum_array[sum_index] = basisu[i] * nu.points[pt_index].co[3] #type: ignore
             sumdiv += sum_array[sum_index]
             sum_index += 1
 
         if (sumdiv != 0.0) and (sumdiv < 1.0 - EPS or sumdiv > 1.0 + EPS):
             sum_index = 0
             for i in range(istart, iend + 1):
-                sum_array[sum_index] /= sumdiv
+                sum_array[sum_index] /= sumdiv #type: ignore
                 sum_index += 1
 
         coord_array[coord_index: coord_index + 3] = (0.0, 0.0, 0.0)
@@ -423,9 +442,48 @@ def nurb_make_curve(nu: bpy.types.Spline, resolu: int, stride: int = 3) -> list[
 
     return coord_array
 
-def link_object_to_collection_nested(obj: bpy.types.Object, col: bpy.types.Collection):
-    if obj.name not in col.objects:
+def link_object_to_collection_nested(obj: Object, col: BCollection):
+    if obj.name not in col.objects: #type: ignore
         col.objects.link(obj)
 
-    for child in obj.children:
-        link_object_to_collection_nested(child, col)
+    for child in obj.children: #type: ignore
+        link_object_to_collection_nested(child, col)
+
+def add_to_heirarchy(converted: Union[Object, BCollection], traversalContext : 'TraversalContext', converted_objects: Dict[str, Union[Object, BCollection]], preserve_transform: bool) -> None:
+    nextParent = traversalContext.parent
+
+    # Traverse up the tree to find a direct parent object, and a containing collection
+    parent_collection: Optional[BCollection] = None
+    parent_object: Optional[Object] = None
+
+    while nextParent:
+        if nextParent.current.id in converted_objects:
+            c = converted_objects[nextParent.current.id]
+
+            if isinstance(c, BCollection):
+                parent_collection = c
+                break
+            else: #isinstance(c, Object):
+                parent_object = parent_object or c
+
+        nextParent = nextParent.parent
+
+    # If no containing collection is found, fall back to the scene collection
+    if not parent_collection:
+        parent_collection = bpy.context.scene.collection
+
+    if isinstance(converted, Object):
+        if parent_object:
+            set_parent(converted, parent_object, preserve_transform)
+        link_object_to_collection_nested(converted, parent_collection)
+    elif converted.name not in parent_collection.children.keys():
+        parent_collection.children.link(converted)
+
+
+def set_parent(child: Object, parent: Object, preserve_transform: bool = False) -> None:
+    if preserve_transform :
+        previous = child.matrix_world.copy() # type: ignore
+        child.parent = parent
+        child.matrix_world = previous
+    else:
+        child.parent = parent

bpy_speckle/functions.py

@@ -1,8 +1,6 @@
-from typing import Callable, Set
-
-import bpy
+from typing import Callable
 from specklepy.objects.base import Base
-from bpy_speckle.properties.scene import SpeckleSceneSettings
+from bpy_speckle.convert.constants import ELEMENTS_PROPERTY_ALIASES
 
 from bpy_speckle.specklepy_extras.traversal import GraphTraversal, TraversalRule
 
@@ -10,7 +8,7 @@ from bpy_speckle.specklepy_extras.traversal import GraphTraversal, TraversalRule
 Speckle functions
 """
 
-unit_scale = {
+UNIT_SCALE = {
     "meters": 1.0,
     "centimeters": 0.01,
     "millimeters": 0.001,
@@ -40,8 +38,8 @@ def _report(msg):
 
 
 def get_scale_length(units: str) -> float:
-    if units.lower() in unit_scale.keys():
-        return unit_scale[units]
+    if units.lower() in UNIT_SCALE.keys():
+        return UNIT_SCALE[units]
     _report("Units <{}> are not supported.".format(units))
     return 1.0
 
@@ -50,32 +48,29 @@ def get_scale_length(units: str) -> float:
 Client, user, and stream functions
 """
 
-elements_aliases: Set[str] = {"elements", "@elements"}
-ignore_props: Set[str] = {"@blockDefinition", "displayValue", "@displayValue", "units", "id", "applicationId"}
 
 def get_default_traversal_func(can_convert_to_native: Callable[[Base], bool]) -> GraphTraversal:
     """
     Traversal func for traversing a speckle commit object
     """
+    
+    ignore_rule = TraversalRule(
+    [
+        lambda o: "Objects.Structural.Results" in o.speckle_type, #Sadly, this one is nessasary to avoid double conversion...
+        lambda o: "Objects.BuiltElements.Revit.Parameter" in o.speckle_type, #This one is just for traversal performance of revit commits
+    ], 
+    lambda _: [],
+    )
 
     convertable_rule = TraversalRule(
     [can_convert_to_native],
-    lambda _: [i for i in elements_aliases if i not in ignore_props],
+    lambda _: ELEMENTS_PROPERTY_ALIASES,
     )
 
-    ignore_result_rule = TraversalRule(
-    [lambda o: "Objects.Structural.Results" in o.speckle_type, #Sadly, this one is nessasary to avoid double conversion...
-    lambda o: "Objects.BuiltElements.Revit.Parameter" in o.speckle_type], #This one is just for traversal performance of revit commits
-    lambda _: [],
-    )
 
     default_rule = TraversalRule(
     [lambda _: True],
     lambda o: o.get_member_names(), #TODO: avoid deprecated members
     )
 
-    return GraphTraversal([convertable_rule, ignore_result_rule, default_rule])
-
-
-def get_speckle(context: bpy.types.Context) -> 'SpeckleSceneSettings':
-    return context.scene.speckle #type: ignore
+    return GraphTraversal([ignore_rule, convertable_rule, default_rule])

bpy_speckle/operators/__init__.py

@@ -15,7 +15,6 @@ from .streams import (
     SelectOrphanObjects,
 )
 from .streams import (
-    UpdateGlobal,
     AddStreamFromURL,
     CreateStream,
     CopyStreamId,
@@ -54,7 +53,6 @@ operator_classes.extend(
         ViewStreamDataApi,
         DeleteStream,
         SelectOrphanObjects,
-        UpdateGlobal,
         AddStreamFromURL,
         CreateStream,
         OpenSpeckleGuide,

bpy_speckle/operators/commit.py

@@ -1,12 +1,10 @@
 """
 Commit operators
 """
-from typing import cast
 import bpy
 from bpy.props import BoolProperty
-from bpy_speckle.functions import _report, get_speckle
 from bpy_speckle.clients import speckle_clients
-from bpy_speckle.properties.scene import SpeckleSceneSettings
+from bpy_speckle.properties.scene import get_speckle
 
 
 class DeleteCommit(bpy.types.Operator):

bpy_speckle/operators/streams.py

@@ -1,10 +1,8 @@
 """
 Stream operators
 """
-from itertools import chain
 from math import radians
-from deprecated import deprecated
-from typing import Any, Callable, Dict, Iterable, List, Optional, Union, cast
+from typing import Callable, Dict, Optional, Union, cast
 import webbrowser
 import bpy
 from bpy.props import (
@@ -20,24 +18,22 @@ from bpy.types import (
 from bpy_speckle.blender_commit_object_builder import BlenderCommitObjectBuilder
 from bpy_speckle.convert.to_native import (
     can_convert_to_native,
+    collection_to_native,
     convert_to_native,
     set_convert_instances_as,
 )
 from bpy_speckle.convert.to_speckle import (
-    ConversionSkippedException,
     convert_to_speckle,
 )
 from bpy_speckle.functions import (
     get_default_traversal_func,
     _report,
     get_scale_length,
-    get_speckle,
 )
 from bpy_speckle.clients import speckle_clients
 from bpy_speckle.operators.users import add_user_stream
-from bpy_speckle.properties.scene import SpeckleSceneSettings, SpeckleUserObject
-from bpy_speckle.convert.util import link_object_to_collection_nested
-
+from bpy_speckle.properties.scene import SpeckleSceneSettings, SpeckleUserObject, get_speckle
+from bpy_speckle.convert.util import ConversionSkippedException, add_to_heirarchy
 from specklepy.api.models import Commit
 from specklepy.api import operations, host_applications
 from specklepy.api.wrapper import StreamWrapper
@@ -48,71 +44,6 @@ from specklepy.objects.other import Collection as SCollection
 from specklepy.logging.exceptions import SpeckleException
 from specklepy.logging import metrics
 
-from bpy_speckle.specklepy_extras.traversal import TraversalContext
-
-@deprecated
-def get_objects_collections(base: Base) -> Dict[str, list]:
-    """Create collections based on the dynamic members on a root commit object"""
-    collections = {}
-    for name in base.get_dynamic_member_names():
-        value = base[name]
-        if isinstance(value, list):
-            col = get_or_create_collection(name)
-            collections[name] = get_objects_nested_lists(value, col)
-        if isinstance(value, Base):
-            col = get_or_create_collection(name)
-            collections[name] = get_objects_collections_recursive(value, col)
-
-    return collections
-
-@deprecated
-def get_objects_nested_lists(items: list, parent_col: Optional[bpy.types.Collection] = None) -> List:
-    """For handling the weird nested lists that come from Grasshopper"""
-    objects = []
-    if not items:
-        return objects
-
-    if isinstance(items[0], list):
-        items = list(chain.from_iterable(items))
-        objects.extend(get_objects_nested_lists(items, parent_col))
-    else:
-        objects = [
-            get_objects_collections_recursive(item, parent_col)
-            for item in items
-            if isinstance(item, Base)
-        ]
-
-    return objects
-
-@deprecated
-def get_objects_collections_recursive(base: Base, parent_col: Optional[bpy.types.Collection] = None) -> List:
-    """Recursively create collections based on the dynamic members on nested `Base` objects within the root commit object"""
-    # if it's a convertable (registered) class and not just a plain `Base`, return the object itself
-    if can_convert_to_native(base):
-        return [base]
-
-    # if it's an unknown type, try to drill further down to find convertable objects
-    objects = []
-
-    for name in base.get_dynamic_member_names():
-        value = base[name]
-        if isinstance(value, list):
-            objects.extend(item for item in value if isinstance(item, Base))
-        if isinstance(value, Base):
-            col = parent_col.children.get(name)
-            if not col:
-                col = get_or_create_collection(name)
-                try:
-                    parent_col.children.link(col)
-                except:
-                    _report(
-                        f"Problem linking collection {col.name} to parent {parent_col.name}; skipping"
-                    )
-            objects.append({name: get_objects_collections_recursive(value, col)})
-
-    return objects
-
-
 ObjectCallback = Optional[Callable[[bpy.types.Context, Object, Base], Object]]
 ReceiveCompleteCallback = Optional[Callable[[bpy.types.Context, Dict[str, Union[Object, Collection]]], None]]
 
@@ -136,192 +67,6 @@ def get_receive_funcs(speckle: SpeckleSceneSettings) -> tuple[ObjectCallback, Re
 
     return (objectCallback, receiveCompleteCallback)
 
-@deprecated
-def bases_to_native(context: bpy.types.Context, collections: Dict[str, list], scale: float, stream_id: str, func: ObjectCallback = None):
-    for col_name, objects in collections.items():
-        col = bpy.data.collections[col_name]
-        existing = get_existing_collection_objs(col)
-        if isinstance(objects, dict):
-            bases_to_native(context, objects, scale, stream_id)
-        elif isinstance(objects, list):
-            for obj in objects:
-                if isinstance(obj, dict):
-                    bases_to_native(context, obj, scale, stream_id, func)
-                elif isinstance(obj, list): #FIXME: wtf are these nested if statement, can this not be a recursive call?
-                    for item in obj:
-                        if isinstance(item, dict):
-                            bases_to_native(context, item, scale, stream_id, func)
-                        elif isinstance(item, Base):
-                            base_to_native(
-                                context, item, scale, stream_id, col, existing, func
-                            )
-                elif isinstance(obj, Base):
-                    base_to_native(context, obj, scale, stream_id, col, existing, func)
-
-                else:
-                    _report(
-                        f"Something went wrong when receiving collection: {col_name}" #FIXME: undescript report message
-                    )
-
-            bpy.context.view_layer.update()
-
-            if context.area:
-                context.area.tag_redraw()
-
-
-@deprecated
-def base_to_native(context: bpy.types.Context,
-    base: Base,
-    scale: float,
-    stream_id: str,
-    col: bpy.types.Collection,
-    existing: Dict[str, Object],
-    func: ObjectCallback = None
-    ):
-
-    new_objects = convert_to_native(base)
-
-    #NOTE: this code is ancient, and in testing does nothing, so we are removing it.
-    # if hasattr(base, "properties") and base.properties is not None: 
-    #     new_objects.extend(get_speckle_subobjects(base.properties, scale, base.id))
-    # elif isinstance(base, dict) and "properties" in base.keys():
-    #     new_objects.extend(
-    #          get_speckle_subobjects(base["properties"], scale, base["id"])
-    #      )
- 
-    """
-    Set object Speckle settings
-    """
-    for new_object in new_objects:
-        if new_object is None:
-            continue
-
-        """
-        Run injected function
-        """
-        if func:
-            new_object = func(context, new_object, base) #this base object isn't always the right one for hosted elements! #TODO: may be it now, need to double check!
-
-        if (
-            new_object is None
-        ):  # If the injected function returned None, then we should ignore this object.
-            _report(f"Script '{func.__module__}' returned None.")
-            continue
-
-        new_object.speckle.stream_id = stream_id
-        new_object.speckle.send_or_receive = "receive"
-
-        if new_object.speckle.object_id in existing.keys():
-            name = existing[new_object.speckle.object_id].name
-            existing[new_object.speckle.object_id].name = f"{name}__deleted"
-            new_object.name = name
-            col.objects.unlink(existing[new_object.speckle.object_id])
-
-        link_object_to_collection_nested(new_object, col)
-        #if new_object.name not in col.objects:
-            #col.objects.link(new_object)
-
-
-def _add_to_heirarchy(converted: Union[Object, Collection], traversalContext : TraversalContext, converted_objects: Dict[str, Union[Object, Collection]]) -> None:
-    nextParent = traversalContext.parent
-
-    # Traverse up the tree to find a direct parent object, and a containing collection
-    parent_collection: Optional[Collection] = None
-    parent_object: Optional[Object] = None
-
-    while nextParent:
-        if nextParent.current.id in converted_objects:
-            c = converted_objects[nextParent.current.id]
-
-            if isinstance(c, Collection):
-                parent_collection = c
-                break
-            else: #isinstance(c, Object):
-                parent_object = parent_object or c
-
-        nextParent = nextParent.parent
-
-    # If no containing collection is found, fall back to the scene collection
-    if not parent_collection:
-        parent_collection = bpy.context.scene.collection
-
-    if isinstance(converted, Object):
-        if parent_object:
-            converted.parent = parent_object
-        link_object_to_collection_nested(converted, parent_collection)
-    elif converted.name not in parent_collection.children.keys():
-        parent_collection.children.link(converted)
-    
-
-def collection_to_native(collection: SCollection) -> Collection: 
-    name = collection.name or f"{collection.collectionType} -- {collection.applicationId or collection.id}"  #TODO: consider consolidating name formatting with Rhino
-    return get_or_create_collection(name)
-
-def get_or_create_collection(name: str, clear_collection: bool = True) -> Collection:
-    existing = cast(Collection, bpy.data.collections.get(name))
-    if existing:
-        if clear_collection:
-            for obj in existing.objects:
-                existing.objects.unlink(obj)
-        return existing
-    else:
-        new_collection = bpy.data.collections.new(name)
-
-        #NOTE: We want to not render revit "Rooms" collections by default.
-        if name == "Rooms":
-            new_collection.hide_viewport = True
-            new_collection.hide_render = True
-
-        return new_collection
-
-
-
-def create_child_collections(parent_col: bpy.types.Collection, children_names: Iterable[str]) -> None:
-    for name in children_names:
-        col = get_or_create_collection(name)
-        parent_col.children.link(col)
-
-@deprecated
-def get_existing_collection_objs(col: bpy.types.Collection) -> Dict[str, bpy.types.Object]:
-    return {
-        obj.speckle.object_id: obj for obj in col.objects if obj.speckle.object_id != ""
-    }
-
-
-def get_collection_parents(collection: bpy.types.Collection, names: list[str]) -> None:
-    for parent in bpy.data.collections:
-        if collection.name in parent.children.keys():
-            # TODO: this should be rethought to make it clear when this is an IFC delim so we know to replace it
-            # with `/` again on receive
-            names.append(parent.name.replace("/", "::").replace(".", "::"))
-            get_collection_parents(parent, names)
-
-
-def get_collection_hierarchy(collection: Optional[bpy.types.Collection]) -> list[str]:
-    if not collection:
-        return []
-    names = [collection.name.replace("/", "::").replace(".", "::")]
-    get_collection_parents(collection, names)
-
-    return names
-
-
-def create_nested_hierarchy(base: Base, hierarchy: List[str], objects: Any):
-    child = base
-
-    while hierarchy:
-        name = hierarchy.pop()
-        if not hasattr(child, name):
-            child[name] = Base()
-            child.add_detachable_attrs({name})
-        child = child[name]
-
-    if not hasattr(child, "@elements"):
-        child["@elements"] = []
-    child["@elements"].extend(objects)
-
-    return base
-
 #RECEIVE_MODES = [#TODO: modes
 #    ("create", "Create", "Add new geometry, without removing any existing objects"),
 #    ("replace", "Replace", "Replace objects from previous receive operations from the same stream"),
@@ -435,8 +180,8 @@ class ReceiveStreamObjects(bpy.types.Operator):
         converted_count: int = 0
         (object_converted_callback, on_complete_callback) = get_receive_funcs(speckle)
 
-        # older commits won't will have a non-collection root object
-        # for the sake of consistant behaviour, we will wrap anynon-collection commit objects in a collection
+        # older commits will have a non-collection root object
+        # for the sake of consistant behaviour, we will wrap any non-collection commit objects in a collection
         if not isinstance(commit_object, SCollection):
             dummy_commit_object = SCollection()
             dummy_commit_object.elements = [commit_object]
@@ -451,9 +196,10 @@ class ReceiveStreamObjects(bpy.types.Operator):
         for item in traversalFunc.traverse(commit_object):
             
             current: Base = item.current
+
             if can_convert_to_native(current) or isinstance(current, SCollection):
                 try:
-                    if not current or not current.id: raise Exception("{current} was an invalid speckle object")
+                    if not current or not current.id: raise Exception(f"{current} was an invalid speckle object")
 
                     #Convert the object!
                     converted_data_type: str
@@ -475,7 +221,7 @@ class ReceiveStreamObjects(bpy.types.Operator):
                         
                     converted_objects[current.id] = converted
 
-                    _add_to_heirarchy(converted, item, converted_objects)
+                    add_to_heirarchy(converted, item, converted_objects, True)
 
                     _report(f"Successfully converted {type(current).__name__} {current.id} as '{converted_data_type}'")
                 except ConversionSkippedException as ex:
@@ -888,43 +634,6 @@ class SelectOrphanObjects(bpy.types.Operator):
 
         return {"FINISHED"}
 
-@deprecated
-class UpdateGlobal(bpy.types.Operator):
-    """
-    DEPRECATED
-    Update all Speckle objects
-    """
-
-    bl_idname = "speckle.update_global"
-    bl_label = "Update Global"
-    bl_options = {"REGISTER", "UNDO"}
-    bl_description = "Update all Speckle objects"
-
-    client = None
-
-    def draw(self, context):
-        layout = self.layout
-        row = layout.row()
-        label = row.label(text="Update everything.")
-
-    def execute(self, context):
-        
-        client = context.scene.speckle.client
-
-        profiles = client.load_local_profiles()
-        if len(profiles) < 1:
-            raise ValueError("No profiles found.")
-        client.use_existing_profile(sorted(profiles.keys())[0])
-        context.scene.speckle.user = sorted(profiles.keys())[0]
-
-        for obj in context.scene.objects:
-            if obj.speckle.enabled:
-                UpdateObject(context.scene.speckle_client, obj)
-
-        context.scene.update()
-        return {"FINISHED"}
-
-
 class CopyStreamId(bpy.types.Operator):
     """
     Copy stream ID to clipboard

bpy_speckle/operators/users.py

@@ -4,9 +4,9 @@ User account operators
 from typing import cast
 import bpy
 from bpy.types import Context
-from bpy_speckle.functions import _report, get_speckle
+from bpy_speckle.functions import _report
 from bpy_speckle.clients import speckle_clients
-from bpy_speckle.properties.scene import SpeckleCommitObject, SpeckleSceneSettings, SpeckleUserObject
+from bpy_speckle.properties.scene import SpeckleCommitObject, SpeckleSceneSettings, SpeckleUserObject, get_speckle
 from specklepy.api.client import SpeckleClient
 from specklepy.api.models import Stream
 from specklepy.api.credentials import get_local_accounts

bpy_speckle/properties/scene.py

@@ -13,7 +13,6 @@ from bpy.props import (
     PointerProperty,
 )
 
-
 class SpeckleSceneObject(bpy.types.PropertyGroup):
     name: bpy.props.StringProperty(default="")
 
@@ -191,4 +190,7 @@ class SpeckleSceneSettings(bpy.types.PropertyGroup):
         return (user, stream, branch, commit)
     
 class SelectionException(Exception):
-    pass
+    pass
+
+def get_speckle(context: bpy.types.Context) -> SpeckleSceneSettings:
+    return context.scene.speckle #type: ignore

bpy_speckle/specklepy_extras/traversal.py

@@ -58,10 +58,11 @@ class GraphTraversal:
             for child_prop in members_to_traverse:
                 try:
                     if child_prop in {"speckle_type", "units", "applicationId"}: continue #debug: to avoid noisy exceptions, explicitly avoid checking ones we know will fail, this is not exhaustive
-                    value = current[child_prop]
-                    self._traverse_member_to_stack(
-                        stack, value, child_prop, head
-                    )
+                    if getattr(current, child_prop, None):
+                        value = current[child_prop]
+                        self._traverse_member_to_stack(
+                            stack, value, child_prop, head
+                        )
                 except KeyError as ex:
                     # Unset application ids, and class variables like SpeckleType will throw when __getitem__ is called
                     pass

pyproject.toml

@@ -7,7 +7,7 @@ license = "Apache-2.0"
 
 [tool.poetry.dependencies]
 python = ">=3.8, <4.0.0"
-specklepy = "^2.14.0"
+specklepy = "^2.15.1"
 attrs = "^23.1.0"
 
 # [tool.poetry.group.local_specklepy.dependencies]