fix send stream object cases (#207)

* fix send stream object cases

* clean logs

* revert workaround

* revert unnecessary logic

* revert unnecessary logic

* rename set_user

---------

Co-authored-by: Soylu <alper.soylu@siemens.com>

.circleci/config.yml

@@ -71,24 +71,44 @@ jobs:
   build-installer-win:
     executor:
       name: win/default
-      shell: cmd.exe
+    environment:
+      SSM: 'C:\Program Files\DigiCert\DigiCert One Signing Manager Tools'
     steps:
       - attach_workspace:
           at: ./
       - run:
           name: Patch installer
-          shell: powershell.exe
           command: python patch_installer.py (Get-Content -Raw SEMVER)
-      - run:
-          name: Create Innosetup signing cert
-          shell: powershell.exe
-          command: |
-            echo $env:PFX_B64 > "speckle-sharp-ci-tools\SignTool\AEC Systems Ltd.txt"
-            certutil -decode "speckle-sharp-ci-tools\SignTool\AEC Systems Ltd.txt" "speckle-sharp-ci-tools\SignTool\AEC Systems Ltd.pfx"
-      - run:
-          name: Installer
-          shell: cmd.exe #does not work in powershell
-          command: speckle-sharp-ci-tools\InnoSetup\ISCC.exe speckle-sharp-ci-tools\blender.iss /Sbyparam=$p
+      - unless: # Build installers unsigned on non-tagged builds
+          condition: << pipeline.git.tag >>
+          steps:
+            - run:
+                name: Build Installer
+                command: speckle-sharp-ci-tools\InnoSetup\ISCC.exe speckle-sharp-ci-tools\blender.iss /Sbyparam=$p
+                shell: cmd.exe #does not work in powershell
+      - when: # Setup certificates and build installers signed for tagged builds
+          condition: << pipeline.git.tag >>
+          steps:
+            - run:
+                name: "Digicert Signing Manager Setup"
+                command: |
+                  cd C:\
+                  curl.exe -X GET  https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download -H "x-api-key:$env:SM_API_KEY" -o smtools-windows-x64.msi
+                  msiexec.exe /i smtools-windows-x64.msi /quiet /qn | Wait-Process
+            - run:
+                name: Create Auth & OV Signing Cert
+                command: |
+                  cd C:\
+                  echo $env:SM_CLIENT_CERT_FILE_B64 > certificate.txt
+                  certutil -decode certificate.txt certificate.p12
+            - run:
+                name: Sync Certs
+                command: |
+                  & $env:SSM\smksp_cert_sync.exe
+            - run:
+                name: Build Installer
+                command: speckle-sharp-ci-tools\InnoSetup\ISCC.exe speckle-sharp-ci-tools\blender.iss /Sbyparam=$p /DSIGN_INSTALLER /DCODE_SIGNING_CERT_FINGERPRINT=%SM_CODE_SIGNING_CERT_SHA1_HASH%
+                shell: cmd.exe #does not work in powershell
       - persist_to_workspace:
           root: ./
           paths:
@@ -96,7 +116,8 @@ jobs:
 
   build-installer-mac:
     macos:
-      xcode: 12.5.1
+      xcode: 13.4.1
+    resource_class: macos.m1.medium.gen1
     parameters:
       runtime:
         type: string
@@ -109,6 +130,9 @@ jobs:
       - checkout
       - attach_workspace:
           at: ./
+      - run:
+          name: Exit if External PR
+          command: if [ "$CIRCLE_PR_REPONAME" ]; then circleci-agent step halt; fi
       - run:
           name: Install mono
           command: |
@@ -214,7 +238,7 @@ workflows:
           filters: *build_filters
 
       - build-installer-win:
-          context: innosetup
+          context: digicert-keylocker
           name: Windows Installer Build
           requires:
             - package-connector
@@ -304,4 +328,4 @@ workflows:
             - Windows Installer Build
             - Mac Intel Build
             - Mac ARM Build
-          filters: *deploy_filters
+          filters: *deploy_filters

README.md

@@ -41,42 +41,57 @@ Give Speckle a try in no time by:
 - [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=for-the-badge&logo=read-the-docs&logoColor=white)](https://speckle.guide/user/blender.html) reference on almost any end-user and developer functionality
 
 
-# Repo structure
+# Blender Connector
 
 The Speckle UI can be found in the 3d viewport toolbar (N), under the Speckle tab.
 
 Head to the [**📚 documentation**](https://speckle.guide/user/blender.html) for more information.
 
-## Disclaimer
-This code is WIP and as such should be used with extreme caution on non-sensitive projects.
-
 ## Installation
 
-1. Place `bpy_speckle` folder in your `addons` folder. On Windows this is typically `%APPDATA%/Blender Foundation/Blender/2.80/scripts/addons`.
-2. Go to `Edit->Preferences` (Ctrl + Alt + U)
-3. Go to the `Add-ons` tab
-4. Find and enable `SpeckleBlender 2.0` in the `Scene` category. <!-- **If enabling for the first time, expect the UI to freeze for bit while it silently installs all the dependencies.** -->
-5. The Speckle UI can be found in the 3d viewport toolbar (N), under the `Speckle` tab.
+We officially support Blender 3.3 and newer, on Windows and Mac.
+
+Please follow our installation instructions on our [connector docs](https://speckle.guide/user/blender.html#installation)
 
 ## Usage
+Once enabled in `Preferences -> Addons`,
+The Speckle connector UI can be found in the 3d viewport toolbar (N), under the `Speckle` tab.
+
 - Available user accounts are automatically detected and made available. To add user accounts use **Speckle Manager**.
-- Select the user from the dropdown list in the `Users` panel. This will populate the `Streams` list with available streams for the selected user.
-- Select a branch and commit from the dropdown menus.
-- Click on `Receive` to download the objects from the selected stream, branch, and commit. The stream objects will be loaded into a Blender Collection, named `<STREAM_NAME> [ <STREAM_BRANCH> @ <BRANCH_COMMIT> ]`. <!-- You can filter the stream by entering a query into the `Filter` field (i.e. `properties.weight>10` or `type="Mesh"`). -->
-- Click on `Open Stream in Web` to view the stream in your web browser.
+- Select the user from the dropdown list in the `Users` panel. This will populate the `Projects` list with available projects for the selected user account.
+- Select a model and version from the dropdown menus.
+- Click on `Receive` to download and convert the objects from the selected model version. The objects will be linked into a Blender Collection, named `<PROJECT_NAME> [ <MODEL_NAME> @ <VERSION_ID> ]`.
+- Click on `Open Model in Web` to view the model in your web browser.
 
-## Caveats
+## Supported Elements
 
-- Mesh objects are supported. Breps are imported as meshes using their `displayValue` data. 
-- Curves have limited support: `Polylines` are supported; `NurbsCurves` are supported, though they are not guaranteed to look the same; `Lines` are supported; `Arcs` are not supported, though they are very roughly approximated; `PolyCurves` are supported for linear / polyline segments and very approximate arc segments. These conversions are a point of focus for further development.
+The Blender Connector is still a work in progress and, as such, data sent from the Blender connector is a highly lossy exchange. Our connectors are ever evolving to facilitate more and more Speckle usecases. We welcome feedback, requests, edge cases, and contributions!
 
-## Custom properties
+The full matrix of supported Blender and Speckle types [can be found here](https://speckle.guide/user/support-tables.html#blender)
+
+
+## Additional Features
 
-- **SpeckleBlender** will look for a `texture_coordinates` property and use that to create a UV layer for the imported object. These texture coordinates are a space-separated list of floats (`[u v u v u v etc...]`) that is encoded as a base64 blob. This is subject to change as **SpeckleBlender** develops.
-- If a `renderMaterial` property is found, **SpeckleBlender** will create a material named using the sub-property `renderMaterial.name`. If a material with that name already exists in Blender, **SpeckleBlender** will just assign that existing material to the object. This allows geometry to be updated without having to re-assign and re-create materials.
-- Vertex colors are supported. The `colors` list from Speckle meshes is translated to a vertex color layer.
 - Speckle properties will be imported as custom properties on Blender objects. Nested dictionaries are expanded to individual properties by flattening their key hierarchy. I.e. `propA:{'propB': {'propC':10, 'propD':'foobar'}}` is flattened to `propA.propB.propC = 10` and `propA.propB.propD = "foobar"`.
 
+- If a `renderMaterial` property is found, **SpeckleBlender** will create a material named using the sub-property `renderMaterial.name`. If a material with that name already exists in Blender, **SpeckleBlender** will just assign that existing material to the object. This allows geometry to be updated without having to re-assign and re-create materials.
+
+- Receiving vertex colors is supported. The `colors` list from Speckle meshes is translated to a vertex color layer.
+
+- Receive/Send scripts. Allow injecting a custom python function to the receive/send process to automate any blender operations
+
+## Dependency Installation and Compatibility with Other Blender Addons
+
+Upon first launch of the addon, the Speckle connector installs its SpecklePy dependencies in `%appdata%/Speckle/connector_installations` on Windows and `~/.config/Speckle/connector_installations` on Mac.
+This is done through our [`installer.py`](https://github.com/specklesystems/speckle-blender/blob/main/bpy_speckle/installer.py). Through pip, we install the correct version of each dependency for your blender python version, host OS, and system architecture.
+As such, an internet connection is required for first launch of the connector.
+
+Other blender addons may require dependencies that conflict with specklepy. In these cases, one or both addons may fail to load.
+If you suspect you're seeing a conflict, Please uninstall other third party addons one at a time to identify which addon is conflicting.
+
+If you find an addon that conflicts, please try using a different version of that addon (newer or older).
+
+If you can't find a version of an addon that works, please let us know on [our forums](https://speckle.community/) the name of the addon, the versions you've tried, the version of the Speckle connector you've tried, and your OS (win/mac/linux).
 
 ## Contributing
 

bpy_speckle/blender_commit_object_builder.py

@@ -1,26 +1,31 @@
-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
 from bpy_speckle.functions import _report
-from bpy_speckle.specklepy_extras.commit_object_builder import CommitObjectBuilder, ROOT
+from specklepy.objects.graph_traversal.commit_object_builder import CommitObjectBuilder, ROOT
 from specklepy.objects import Base
 from specklepy.objects.other import Collection as SCollection
 from attrs import define
 
 ELEMENTS = "elements"
 
-def _id(natvive_object: ID) -> str:
+def _id(native_object: ID) -> str:
     #NOTE: to avoid naming collisions, we prefix collections and objects differently
-    return f"{type(natvive_object).__name__}:{natvive_object.name_full}" 
+    return f"{type(native_object).__name__}:{native_object.name_full}" 
 
-def _try_id(natvive_object: Optional[Union[Collection, Object]]) -> Optional[str]:
-    return _id(natvive_object) if natvive_object else None
+def _try_id(native_object: Optional[Union[Collection, Object]]) -> Optional[str]:
+    return _id(native_object) if native_object else None
 
 def convert_collection_to_speckle(col: Collection) -> SCollection:
-    convered_collection = SCollection(name = col.name_full, collectionType = "Blender Collection", elements = [])
-    convered_collection.applicationId = _id(col)
-    return convered_collection
+    converted_collection = SCollection(name = col.name_full, collectionType = "Blender Collection", elements = [])
+    converted_collection.applicationId = _id(col)
+
+    color_tag = col.color_tag
+    if color_tag and color_tag != "NONE":
+        converted_collection["colorTag"] = col.color_tag
+
+    return converted_collection
 
 @define(slots=True)
 class BlenderCommitObjectBuilder(CommitObjectBuilder[Object]):
@@ -36,7 +41,7 @@ class BlenderCommitObjectBuilder(CommitObjectBuilder[Object]):
         # Set the Child -> Parent relationships
         parent = native_object.parent
         
-        parent_collections: Tuple[Collection] = native_object.users_collection # type: ignore 
+        parent_collections = native_object.users_collection 
         parent_collection = parent_collections[0] if len(parent_collections) > 0 else None #NOTE: we don't support objects appearing in more than one collection, for now, we will just take the zeroth one
         
         app_id = _id(native_object)
@@ -62,25 +67,11 @@ class BlenderCommitObjectBuilder(CommitObjectBuilder[Object]):
         # parent = self.find_collection_parent(col)
         # self.set_relationship(id, (_try_builder_id(parent), ELEMENTS), (ROOT, ELEMENTS)) 
 
-        convered_collection = convert_collection_to_speckle(col)
-        self.converted[id] = convered_collection
-        self._collections[id] = convered_collection
+        converted_collection = convert_collection_to_speckle(col)
+        self.converted[id] = converted_collection
+        self._collections[id] = converted_collection
 
-        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
+        return converted_collection
 
     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/clients.py

@@ -1,7 +1,7 @@
 """
 Permanent handle on all user clients
 """
-from specklepy.api.client import SpeckleClient
+from specklepy.core.api.client import SpeckleClient
 
 
 speckle_clients: list[SpeckleClient] = []

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,22 @@
+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_SPECKLE_SEPARATOR = " -- "
+OBJECT_NAME_NUMERAL_SEPARATOR = '.'

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, Sequence, Union, Collection, cast
+from bpy_speckle.convert.constants import DISPLAY_VALUE_PROPERTY_ALIASES, ELEMENTS_PROPERTY_ALIASES, OBJECT_NAME_MAX_LENGTH, OBJECT_NAME_NUMERAL_SEPARATOR, OBJECT_NAME_SPECKLE_SEPARATOR, 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_hierarchy,
     get_render_material,
-    link_object_to_collection_nested,
+    get_vertex_color_material,
     render_material_to_native,
     add_custom_properties,
     add_vertices,
@@ -34,36 +40,19 @@ 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
+def _has_native_conversion(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
 
 def _has_fallback_conversion(speckle_object: Base) -> bool: 
     return any(getattr(speckle_object, alias, None) for alias in DISPLAY_VALUE_PROPERTY_ALIASES)
 
 def can_convert_to_native(speckle_object: Base) -> bool:
 
-    if(_has_native_convesion(speckle_object) or _has_fallback_conversion(speckle_object)):
+    if(_has_native_conversion(speckle_object) or _has_fallback_conversion(speckle_object)):
         return True
     return False
 
-def create_new_object(obj_data: Optional[bpy.types.ID], desired_name: str, counter: int = 0) -> bpy.types.Object:
-    """
-    Creates a new blender object with a unique name,
-    if the desired_name is already taken
-    we'll append a number, with the format .xxx to the desired_name to ensure the name is unique.
-    """
-    name = desired_name if counter == 0 else f"{desired_name[:OBJECT_NAME_MAX_LENGTH - 4]}.{counter:03d}"  # format counter as name.xxx, truncate to ensure we don't exceed the object name max length
-
-    #TODO: This is very slow, and gets slower the more objects you receive with the same name...
-    # We could use a binary/galloping search, and/or cache the name -> index within a receive.
-    if name in bpy.data.objects.keys():
-        #Object already exists, increment counter and try again!
-        return create_new_object(obj_data, desired_name, counter + 1)
-
-    blender_object = bpy.data.objects.new(name, obj_data)
-    return blender_object
-
-convert_instances_as: str #HACK: This is hacky, we need a better way to pass settings down to the converter
+convert_instances_as: str = "" #HACK: This is hacky, we need a better way to pass settings down to the converter
 def set_convert_instances_as(value: str):
     global convert_instances_as
     convert_instances_as = value
@@ -81,7 +70,7 @@ def convert_to_native(speckle_object: Base) -> Object:
     children: list[Object] = []
 
     # convert elements/breps
-    if not _has_native_convesion(speckle_object):
+    if not _has_native_conversion(speckle_object):
         (converted, children) = display_value_to_native(speckle_object, object_name, scale)
         if not converted and not children:
             raise Exception(f"Zero geometry converted from displayValues for {speckle_object}")
@@ -91,11 +80,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 +97,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 +115,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
 
@@ -147,8 +133,8 @@ def _members_to_native(speckle_object: Base, name: str, scale: float, members: L
         display = getattr(speckle_object, alias, None)
 
         count = 0
-        MAX_DEPTH = 255 # some large value, to prevent infinite reccursion
-        def seperate(value: Any) -> bool:
+        MAX_DEPTH = 255 # some large value, to prevent infinite recursion
+        def separate(value: Any) -> bool:
             nonlocal meshes, others, count, MAX_DEPTH
 
             if combineMeshes and isinstance(value, Mesh):
@@ -160,11 +146,11 @@ def _members_to_native(speckle_object: Base, name: str, scale: float, members: L
                 if(count > MAX_DEPTH):
                     return True
                 for x in value:
-                    seperate(x) 
+                    separate(x) 
 
             return False
 
-        did_halt = seperate(display)
+        did_halt = separate(display)
 
         if did_halt:
             _report(f"Traversal of {speckle_object.speckle_type} {speckle_object.id} halted after traversal depth exceeds MAX_DEPTH={MAX_DEPTH}. Are there circular references object structure?")
@@ -195,6 +181,9 @@ def view_to_native(speckle_view, name: str, scale: float) -> bpy.types.Object:
         native_cam = bpy.data.cameras.new(name=name)
         native_cam.lens = 18 # 90° horizontal fov
 
+    if not hasattr(speckle_view, "origin"):
+        raise ConversionSkippedException("2D views not supported")
+
     cam_obj = create_new_object(native_cam, name)
 
     scale_factor = get_scale_factor(speckle_view, scale)
@@ -217,10 +206,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 +227,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 +249,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 +269,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 +292,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 +314,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 +346,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 +360,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 +386,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 +413,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 +427,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 +473,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 +483,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:
@@ -500,7 +518,7 @@ def icurve_to_native(speckle_curve: Base, name: str, scale: float) -> bpy.types.
         else bpy.data.curves.new(name, type="CURVE")
     )
     blender_curve.dimensions = "3D"
-    blender_curve.resolution_u = 12 #TODO: We could maybe decern the resolution from the ployline displayValue
+    blender_curve.resolution_u = 12 #TODO: We could maybe decern the resolution from the polyline displayValue
 
     icurve_to_native_spline(speckle_curve, blender_curve, scale)
 
@@ -508,7 +526,7 @@ def icurve_to_native(speckle_curve: Base, name: str, scale: float) -> bpy.types.
 
 
 """
-Transforms and Intances
+Transforms and Instances
 """
 
 def transform_to_native(transform: Transform, scale: float) -> MMatrix:
@@ -545,43 +563,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)
-    return f"{name_prefix}{OBJECT_NAME_SEPERATOR}{instance.id}"
+    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_SPECKLE_SEPARATOR}{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-convertible (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 convertible
+        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,33 +625,25 @@ 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)
+    native_instance = create_new_object(None, name)
 
     #add_custom_properties(instance, native_instance)
     # hide the instance axes so they don't clutter the viewport
     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:
@@ -629,42 +655,143 @@ def _instance_definition_to_native(definition: Union[Base, BlockDefinition]) ->
     if native_def:
         return native_def
 
-    native_def = bpy.data.collections.new(name)
+    native_def = create_new_collection(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 convertible
+    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_hierarchy(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:
+    #Disabled for now, since update mode needs rescoping.
+    # existing = cast(Optional[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 = create_new_collection(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
+Object Naming and Creation
 """
 
+def create_new_collection( desired_name: str) -> bpy.types.Collection:
+    """
+    Creates a new blender collection with a unique name
+    If the desired_name is already taken
+    we'll append a number, with the format .xxx to the desired_name to ensure the name is unique.
+    """
+    name = _make_unique_name(desired_name, bpy.data.collections.keys())
+
+    blender_collection = bpy.data.collections.new(name)
+    return blender_collection
+
+def create_new_object(obj_data: Optional[bpy.types.ID], desired_name: str) -> bpy.types.Object:
+    """
+    Creates a new blender object with a unique name,
+    If the desired_name is already taken
+    we'll append a number, with the format .xxx to the desired_name to ensure the name is unique.
+    """
+    name = _make_unique_name(desired_name, bpy.data.objects.keys())
+
+    blender_object = bpy.data.objects.new(name, obj_data)
+    return blender_object
+
+def _make_unique_name( desired_name: str, taken_names: Collection[str], counter: int = 0) -> str:
+    """
+    Using Blenders default naming (append numeral in .xxx format) to avoid name conflicts with taken names
+    """
+    name = desired_name if counter == 0 else f"{desired_name[:OBJECT_NAME_MAX_LENGTH - 4]}{OBJECT_NAME_NUMERAL_SEPARATOR}{counter:03d}"  # format counter as name.xxx, truncate to ensure we don't exceed the object name max length
+
+    #TODO: This is very slow, and gets slower the more objects you receive with the same name...
+    # We could use a binary/galloping search, and/or cache the name -> index within a receive.
+    if name in taken_names:
+        #Name already taken, increment counter and try again!
+        return _make_unique_name(desired_name, taken_names, counter + 1)
+
+    return name
+
+
 def _get_friendly_object_name(speckle_object: Base) -> Optional[str]:
     return (getattr(speckle_object, "name", None)
         or getattr(speckle_object, "Name", None)
-        or getattr(speckle_object, "family", None)
+        or _get_revit_family_name(speckle_object)
         )
 
+def _get_revit_family_name(speckle_object: Base) -> Optional[str]:
+    family = getattr(speckle_object, "family", None)
+    family_type = getattr(speckle_object, "type", None)
+
+    if family and family_type:
+        return f"{family_type}-{family}"
+    else:
+        return None
 
 # 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:
 
-    MAX_NAME_LENGTH = OBJECT_NAME_MAX_LENGTH - SPECKLE_ID_LENGTH - len(OBJECT_NAME_SEPERATOR)
+    MAX_NAME_LENGTH = OBJECT_NAME_MAX_LENGTH - SPECKLE_ID_LENGTH - len(OBJECT_NAME_SPECKLE_SEPARATOR)
 
     return name[:MAX_NAME_LENGTH]
     
@@ -680,7 +807,7 @@ def _generate_object_name(speckle_object: Base) -> str:
     else:
         prefix = _simplified_speckle_type(speckle_object.speckle_type)
 
-    return f"{prefix}{OBJECT_NAME_SEPERATOR}{speckle_object.id}"
+    return f"{prefix}{OBJECT_NAME_SPECKLE_SEPARATOR}{speckle_object.id}"
 
 
 def get_scale_factor(speckle_object: Base, fallback: float = 1.0) -> float:

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_SPECKLE_SEPARATOR, 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", "FONT", "SURFACE", "META")
 
 
 def convert_to_speckle(raw_blender_object: Object, units_scale: float, units: str, depsgraph: Optional[Depsgraph]) -> Base:
@@ -66,7 +67,10 @@ 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))
+    elif blender_type == "FONT" or "SURFACE" or "META":
+        converted = anything_to_speckle_mesh(blender_object)
     if not converted:
         raise Exception("Conversion returned None")
 
@@ -97,7 +101,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] 
 
     # Create Speckle meshes for each material
     submeshes = []
@@ -105,7 +109,7 @@ def mesh_to_speckle_meshes(blender_object: Object, data: bpy.types.Mesh) -> List
     for i in submesh_data:
         index_mapping: Dict[int, int] = {}
 
-        #Loop through each polygon, and map indicies to their new index in m_verts
+        #Loop through each polygon, and map indices to their new index in m_verts
     
         mesh_area = 0
         m_verts: List[float] = []
@@ -158,24 +162,24 @@ 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
             )
         )
     
     num_points = len(points)
 
-    flattend_points = []
-    for row in points: flattend_points.extend(row)
+    flattened_points = []
+    for row in points: flattened_points.extend(row)
 
     knot_count = num_points + degree - 1
     knots = [0] * knot_count
@@ -190,7 +194,7 @@ def bezier_to_speckle(matrix: MMatrix, spline: bpy.types.Spline, name: Optional[
         degree=degree,
         closed=spline.use_cyclic_u,
         periodic= not spline.use_endpoint_u,
-        points=flattend_points,
+        points=flattened_points,
         weights=[1] * num_points,
         knots=knots,
         rational=True,
@@ -215,17 +219,17 @@ 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)
+    flattened_points = []
+    for row in points: flattened_points.extend(row)
 
     if spline.use_cyclic_u:
         for i in range(0, degree * 3, 3):
             # Rhino expects n + degree number of points (for closed curves). So we need to add an extra point for each degree
-            flattend_points.append(flattend_points[i + 0])
-            flattend_points.append(flattend_points[i + 1])
-            flattend_points.append(flattend_points[i + 2])
+            flattened_points.append(flattened_points[i + 0])
+            flattened_points.append(flattened_points[i + 1])
+            flattened_points.append(flattened_points[i + 2])
         
         for i in range(0, degree):
             weights.append(weights[i])
@@ -235,7 +239,7 @@ def nurbs_to_speckle(matrix: MMatrix, spline: bpy.types.Spline, name: Optional[s
         degree=degree,
         closed=spline.use_cyclic_u,
         periodic= not spline.use_endpoint_u,
-        points=flattend_points,
+        points=flattened_points,
         weights=weights,
         knots=knots,
         rational=is_rational, 
@@ -252,13 +256,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)
@@ -303,27 +307,27 @@ def bezier_to_speckle_polyline(matrix: MMatrix, spline: bpy.types.Spline, length
     domain = Interval(start=0, end=length, totalChildrenCount=0)
     return Polyline(value=points, closed = spline.use_cyclic_u, domain=domain, area=0, len=length)
 
-_QUICK_TEST_NAME_LENGTH = SPECKLE_ID_LENGTH + len(OBJECT_NAME_SEPERATOR)
+_QUICK_TEST_NAME_LENGTH = SPECKLE_ID_LENGTH + len(OBJECT_NAME_SPECKLE_SEPARATOR)
 
 def to_speckle_name(blender_object: bpy.types.ID) -> str:
-    does_name_contain_id = len(blender_object.name) > _QUICK_TEST_NAME_LENGTH and OBJECT_NAME_SEPERATOR in blender_object.name
+    does_name_contain_id = len(blender_object.name) > _QUICK_TEST_NAME_LENGTH and OBJECT_NAME_SPECKLE_SEPARATOR in blender_object.name
     if does_name_contain_id:
-        return blender_object.name.rsplit(OBJECT_NAME_SEPERATOR, 1)[0]
+        return blender_object.name.rsplit(OBJECT_NAME_SPECKLE_SEPARATOR, 1)[0]
     else:
         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)
+    flattened_points = []
+    for row in points: flattened_points.extend(row)
 
     length = spline.calc_length()
     domain = Interval(start=0, end=length, totalChildrenCount=0)
     return Polyline(
         name=name,
         closed=bool(spline.use_cyclic_u),
-        value=list(flattend_points),
+        value=list(flattened_points),
         length=length,
         domain=domain,
         bbox=Box(area=0.0, volume=0.0),
@@ -368,6 +372,12 @@ def curve_to_speckle_geometry(blender_object: Object, data: bpy.types.Curve) ->
 
     return (meshes, curves)
 
+def anything_to_speckle_mesh(blender_object: Object) -> Base:
+
+    mesh = mesh_to_speckle(blender_object, blender_object.to_mesh())
+    blender_object.to_mesh_clear()
+    return mesh
+
 @deprecated
 def ngons_to_speckle_polylines(blender_object: Object, data: bpy.types.Mesh) -> Optional[List[Polyline]]:
     UNITS = "m" if bpy.context.scene.unit_settings.system == "METRIC" else "ft"
@@ -382,7 +392,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,41 +418,65 @@ 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
+            emission_color = "Emission" if "Emission" in inputs else "Emission Color" # type: ignore 
+            
+            speckle_mat.diffuse = to_argb_int(inputs["Base Color"].default_value) # type: ignore
+            speckle_mat.emissive = to_argb_int(inputs[emission_color].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 = cast(MVector, matrix.col[1].xyz)
+    forwards = cast(MVector, -matrix.col[2].xyz)
+    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
+    iterable_transform = cast(Iterable[Iterable[float]], blender_transform) #NOTE: Matrix are iterable, even if type hinting says they are not
     value = [y for x in iterable_transform for y in x]
     # scale the translation
     for i in (3, 7, 11):
@@ -452,20 +486,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)
@@ -488,14 +525,13 @@ def empty_to_speckle(blender_object: Object) -> Union[BlockInstance, Base]:
     # probably an instance collection (block) so let's try it
 
     if blender_object.instance_collection and blender_object.instance_type == "COLLECTION":
+        # Empty -> Block
         return block_instance_to_speckle(blender_object)
     else:
-        #raise ConversionSkippedException("Sending non-collection instance empties are not currently supported")
+        # Empty -> Point
         wrapper = Base()
         wrapper["@displayValue"] = matrix_to_speckle_point(cast(MMatrix, blender_object.matrix_world))
         return wrapper
-        #TODO: we could do a Empty -> Point conversion here. However, the viewer (and likly  other apps) don't support a pont with "elements"
-        #return matrix_to_speckle_point(cast(MMatrix, blender_object.matrix_world))
 
 
 def matrix_to_speckle_point(matrix: MMatrix, units_scale: float = 1.0) -> Point:

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, NodeInputs
 
-IGNORED_PROPERTY_KEYS = {
-    "id",
-    "elements",
-    "displayMesh",
-    "displayValue",
-    "speckle_type",
-    "parameters",
-    "faces",
-    "colors",
-    "vertices",
-    "renderMaterial",
-    "textureCoordinates",
-    "totalChildrenCount"
-}
+from specklepy.objects.graph_traversal.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,56 @@ 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["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
+
+        # Blender >=4.0 use "Emission Color"
+        emission_color = "Emission" if "Emission" in inputs else "Emission Color" # type: ignore 
+        inputs[emission_color].default_value = to_rgba(speckle_mat.emissive) # 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
     
 
 
@@ -169,10 +186,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,
@@ -190,6 +205,13 @@ def add_colors(speckle_mesh: Mesh, blender_mesh: BMesh):
                 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
@@ -235,8 +257,9 @@ ignored_keys = {
     "_chunkable",
 }
 
-def get_blender_custom_properties(obj, max_depth: int = 200):
-    if max_depth < 0:
+def get_blender_custom_properties(obj, max_depth: int = 63):
+    """Recursively grabs custom properties on blender objects. Max depth is determined by the max allowed by Newtonsoft.NET, don't exceed unless you know what you're doing"""
+    if max_depth <= 0:
         return obj
 
     if hasattr(obj, "keys"):
@@ -248,7 +271,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 +327,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 +352,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 +416,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 +446,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)
+        link_object_to_collection_nested(child, col)
+
+def add_to_hierarchy(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,38 +1,12 @@
-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
-
-"""
-Speckle functions
-"""
-
-unit_scale = {
-    "meters": 1.0,
-    "centimeters": 0.01,
-    "millimeters": 0.001,
-    "inches": 0.0254,
-    "feet": 0.3048,
-    "kilometers": 1000.0,
-    "mm": 0.001,
-    "cm": 0.01,
-    "m": 1.0,
-    "km": 1000.0,
-    "in": 0.0254,
-    "ft": 0.3048,
-    "yd": 0.9144,
-    "mi": 1609.340,
-}
-
-"""
-Utility functions
-"""
+from specklepy.objects.graph_traversal.traversal import GraphTraversal, TraversalRule
+from specklepy.objects.units import get_scale_factor_to_meters, get_units_from_string
 
 
-def _report(msg):
+def _report(msg: object) -> None:
     """
     Function for printing messages to the console
     """
@@ -40,42 +14,32 @@ def _report(msg):
 
 
 def get_scale_length(units: str) -> float:
-    if units.lower() in unit_scale.keys():
-        return unit_scale[units]
-    _report("Units <{}> are not supported.".format(units))
-    return 1.0
+    """Returns a scalar to convert distance values from one unit system to meters"""
+    return get_scale_factor_to_meters(get_units_from_string(units))
 
 
-"""
-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
     """
-
-    convertable_rule = TraversalRule(
-    [can_convert_to_native],
-    lambda _: [i for i in elements_aliases if i not in ignore_props],
-    )
-
-    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
+    
+    ignore_rule = TraversalRule(
+    [
+        lambda o: "Objects.Structural.Results" in o.speckle_type, #Sadly, this one is necessary 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 _: [],
     )
 
+    convertible_rule = TraversalRule(
+    [can_convert_to_native],
+    lambda _: ELEMENTS_PROPERTY_ALIASES,
+    )
+
+
     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, convertible_rule, default_rule])

bpy_speckle/installer.py

@@ -138,7 +138,6 @@ def ensure_pip() -> None:
 def get_requirements_path() -> Path:
     # we assume that a requirements.txt exists next to the __init__.py file
     path = Path(Path(__file__).parent, "requirements.txt")
-    assert path.exists()
     return path
 
 
@@ -147,29 +146,51 @@ def install_requirements(host_application: str) -> None:
     # script path. Here we'll install the
     # dependencies
     path = connector_installation_path(host_application)
-    print(f"Installing Speckle dependencies to {path}")
 
     from subprocess import run
 
+    def debugger_is_active() -> bool:
+        """Return if the debugger is currently active"""
+        return hasattr(sys, 'gettrace') and sys.gettrace() is not None
+    
+    requirements_path = get_requirements_path()
+
+    is_debug = debugger_is_active()
+    
+    if not is_debug and not requirements_path.exists():
+        print("Skipped installing dependencies")
+        return
+
+    print(f"Installing Speckle dependencies to {path}")
     completed_process = run(
         [
             PYTHON_PATH,
             "-m",
             "pip",
+            "-q",
+            "--disable-pip-version-check",
             "install",
+            "--prefer-binary",
+            "--ignore-installed",
+            "--no-compile",
             "-t",
             str(path),
             "-r",
-            str(get_requirements_path()),
+            str(requirements_path),
         ],
         capture_output=True,
         text=True,
     )
 
     if completed_process.returncode != 0:
-        m = f"Failed to install dependenices through pip, got {completed_process.returncode} return code"
+        m = f"Failed to install dependencies through pip, got {completed_process.returncode} return code"
         print(m)
         raise Exception(m)
+    
+    print("Successfully installed dependencies")
+
+    if not is_debug:
+        requirements_path.unlink()
 
 
 def install_dependencies(host_application: str) -> None:

bpy_speckle/operators/__init__.py

@@ -15,12 +15,12 @@ from .streams import (
     SelectOrphanObjects,
 )
 from .streams import (
-    UpdateGlobal,
     AddStreamFromURL,
     CreateStream,
     CopyStreamId,
     CopyCommitId,
     CopyBranchName,
+    CopyModelId,
 )
 from .commit import DeleteCommit
 from .misc import OpenSpeckleGuide, OpenSpeckleTutorials, OpenSpeckleForum
@@ -34,6 +34,7 @@ operator_classes = [
     CopyStreamId,
     CopyCommitId,
     CopyBranchName,
+    CopyModelId,
 ]
 
 operator_classes.extend([DeleteCommit])
@@ -54,7 +55,6 @@ operator_classes.extend(
         ViewStreamDataApi,
         DeleteStream,
         SelectOrphanObjects,
-        UpdateGlobal,
         AddStreamFromURL,
         CreateStream,
         OpenSpeckleGuide,

bpy_speckle/operators/commit.py

@@ -1,29 +1,29 @@
 """
 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.functions import _report
+from bpy_speckle.properties.scene import get_speckle
+from specklepy.logging import metrics
 
 
 class DeleteCommit(bpy.types.Operator):
     """
-    Deletes the selected commit from the selected stream.
+    Permanently deletes the selected version from the selected model.
     To execute from code, call: `bpy.ops.speckle.delete_commit(are_you_sure=True)`
     """
 
     bl_idname = "speckle.delete_commit"
-    bl_label = "Delete commit"
+    bl_label = "Delete Version"
     bl_options = {"REGISTER", "UNDO"}
-    bl_description = "Delete active commit permanently"
+    bl_description = "Permanently Deletes the selected version from the selected model"
 
     are_you_sure: BoolProperty(
         name="Confirm",
         default=False,
-    )
+    ) # type: ignore
 
     def draw(self, context):
         layout = self.layout
@@ -39,29 +39,34 @@ class DeleteCommit(bpy.types.Operator):
         return {"CANCELLED"}
 
     def execute(self, context):
-        try:
-            self.delete_commit(context)
-            return {"FINISHED"}
-        except Exception as ex:
-            print(f"{self.bl_idname}: failed: {ex}")
-            return {"CANCELLED"}
-
-    def delete_commit(self, context: bpy.types.Context) -> None: 
-
         if not self.are_you_sure:
-            raise Exception("Cancelled by user")
-
+            _report("Cancelled by user")
+            return {"CANCELLED"}
         self.are_you_sure = False
 
+        self.delete_commit(context)
+        return {"FINISHED"}
+
+    @staticmethod
+    def delete_commit(context: bpy.types.Context) -> None: 
         speckle = get_speckle(context)
 
-        (_, stream, _, commit) = speckle.validate_commit_selection()
+        (_, stream, branch, commit) = speckle.validate_commit_selection()
 
         client = speckle_clients[int(speckle.active_user)]
 
         deleted = client.commit.delete(stream_id=stream.id, commit_id=commit.id)
+
+        metrics.track(
+            "Connector Action",
+            client.account, 
+            custom_props={
+                "name": "delete_commit"
+            },
+        )
+        
         if not deleted:
             raise Exception("Delete operation failed")
 
-        print(f"{self.bl_idname}: succeeded - commit {commit.id} ({commit.message}) has been deleted from stream {stream.id}")
+        print(f"Version {commit.id} ({commit.message}) of model {branch.id} ({branch.name}) has been deleted from project {stream.id} ({stream.name})")
 

bpy_speckle/operators/misc.py

@@ -1,35 +1,65 @@
 import bpy
 import webbrowser
+from specklepy.logging import metrics 
+
+
 
 
 class OpenSpeckleGuide(bpy.types.Operator):
-    bl_idname = "speckle.open_speckle_guide"
-    bl_label = "Speckle Guide"
-    bl_options = {"REGISTER", "UNDO"}
-    bl_description = "Browse the documentation on the Speckle Guide"
+    _guide_url = "https://speckle.guide/user/blender.html"
 
+    bl_idname = "speckle.open_speckle_guide"
+    bl_label = "Speckle Docs"
+    bl_options = {"REGISTER", "UNDO"}
+    bl_description = f"Browse the documentation on the Speckle Guide ({_guide_url})"
+    
     def execute(self, context):
-        webbrowser.open("https://speckle.guide/user/blender.html")
+        webbrowser.open(self._guide_url)
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "OpenSpeckleGuide"
+            },
+        )
         return {"FINISHED"}
 
 
 class OpenSpeckleTutorials(bpy.types.Operator):
+    _tutorials_url = "https://speckle.systems/tutorials/"
+
     bl_idname = "speckle.open_speckle_tutorials"
     bl_label = "Tutorials Portal"
     bl_options = {"REGISTER", "UNDO"}
-    bl_description = "Visit our tutorials portal for learning resources"
+    bl_description = f"Visit our tutorials portal for learning resources ({_tutorials_url})"
 
     def execute(self, context):
-        webbrowser.open("https://speckle.systems/tutorials/")
+        webbrowser.open(self._tutorials_url)
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "OpenSpeckleTutorials"
+            },
+        )
         return {"FINISHED"}
 
 
 class OpenSpeckleForum(bpy.types.Operator):
+    _forum_url = "https://speckle.community/"
+
     bl_idname = "speckle.open_speckle_forum"
     bl_label = "Community Forum"
     bl_options = {"REGISTER", "UNDO"}
-    bl_description = "Ask questions and join the discussion on our community forum"
+    bl_description = f"Ask questions and join the discussion on our community forum ({_forum_url})"
 
     def execute(self, context):
-        webbrowser.open("https://speckle.community/")
+        webbrowser.open(self._forum_url)
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "OpenSpeckleForum"
+            },
+        )
         return {"FINISHED"}

bpy_speckle/operators/object.py

@@ -11,8 +11,9 @@ from bpy_speckle.convert.to_speckle import (
 )
 from bpy_speckle.functions import get_scale_length, _report
 from bpy_speckle.clients import speckle_clients
+from specklepy.logging import metrics
 
-
+@deprecated
 class UpdateObject(bpy.types.Operator):
     """
     Update local (receive) or remote (send) object depending on
@@ -21,7 +22,7 @@ class UpdateObject(bpy.types.Operator):
     """
 
     bl_idname = "speckle.update_object"
-    bl_label = "Update Object"
+    bl_label = "Update Object (DEPRECATED)"
     bl_options = {"REGISTER", "UNDO"}
 
     client = None
@@ -56,19 +57,26 @@ class UpdateObject(bpy.types.Operator):
                 _report("Updating object {}".format(sm["_id"]))
                 client.objects.update(active.speckle.object_id, sm)
 
+                metrics.track(
+                    "Connector Action",
+                    None, 
+                    custom_props={
+                        "name": "UpdateObject"
+                    },
+                )
                 return {"FINISHED"}
 
             return {"CANCELLED"}
         return {"CANCELLED"}
 
-
+@deprecated
 class ResetObject(bpy.types.Operator):
     """
     Reset Speckle object settings
     """
 
     bl_idname = "speckle.reset_object"
-    bl_label = "Reset Object"
+    bl_label = "Reset Object (DEPRECATED)"
     bl_options = {"REGISTER", "UNDO"}
 
     def execute(self, context):
@@ -79,16 +87,24 @@ class ResetObject(bpy.types.Operator):
         context.object.speckle.enabled = False
         context.view_layer.update()
 
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "ResetObject"
+            },
+        )
+
         return {"FINISHED"}
 
-
+@deprecated
 class DeleteObject(bpy.types.Operator):
     """
     Delete object from the server and update relevant stream
     """
 
     bl_idname = "speckle.delete_object"
-    bl_label = "Delete Object"
+    bl_label = "Delete Object (DEPRECATED)"
     bl_options = {"REGISTER", "UNDO"}
 
     def execute(self, context):
@@ -125,6 +141,14 @@ class DeleteObject(bpy.types.Operator):
             active.speckle.enabled = False
             context.view_layer.update()
 
+            metrics.track(
+                "Connector Action",
+                None, 
+                custom_props={
+                    "name": "DeleteObject"
+                },
+            )
+
         return {"FINISHED"}
 
 @deprecated
@@ -135,7 +159,7 @@ class UploadNgonsAsPolylines(bpy.types.Operator):
     """
 
     bl_idname = "speckle.upload_ngons_as_polylines"
-    bl_label = "Upload Ngons As Polylines"
+    bl_label = "Upload Ngons As Polylines (DEPRECATED)"
     bl_options = {"REGISTER", "UNDO"}
 
     clear_stream: BoolProperty(
@@ -197,6 +221,13 @@ class UploadNgonsAsPolylines(bpy.types.Operator):
             context.view_layer.update()
             _report("Done.")
 
+            metrics.track(
+                "Connector Action",
+                None, 
+                custom_props={
+                    "name": "UploadNgonsAsPolylines"
+                },
+            )
         return {"FINISHED"}
 
     def invoke(self, context, event):
@@ -217,7 +248,7 @@ def get_custom_speckle_props(self, context):
 
     return [(x, "{}".format(x), "") for x in active.keys()]
 
-
+@deprecated
 class SelectIfSameCustomProperty(bpy.types.Operator):
     """
     Select scene objects if they have the same custom property
@@ -225,7 +256,7 @@ class SelectIfSameCustomProperty(bpy.types.Operator):
     """
 
     bl_idname = "speckle.select_if_same_custom_props"
-    bl_label = "Select Identical Custom Props"
+    bl_label = "Select Identical Custom Props (DEPRECATED)"
     bl_options = {"REGISTER", "UNDO"}
 
     custom_prop: EnumProperty(
@@ -267,9 +298,17 @@ class SelectIfSameCustomProperty(bpy.types.Operator):
             else:
                 obj.select_set(False)
 
+            metrics.track(
+                "Connector Action",
+                None, 
+                custom_props={
+                    "name": "SelectIfSameCustomProperty"
+                },
+            )
+                
         return {"FINISHED"}
 
-
+@deprecated
 class SelectIfHasCustomProperty(bpy.types.Operator):
     """
     Select scene objects if they have the same custom property
@@ -277,7 +316,7 @@ class SelectIfHasCustomProperty(bpy.types.Operator):
     """
 
     bl_idname = "speckle.select_if_has_custom_props"
-    bl_label = "Select Same Custom Prop"
+    bl_label = "Select Same Custom Prop (DEPRECATED)"
     bl_options = {"REGISTER", "UNDO"}
 
     custom_prop: EnumProperty(
@@ -315,4 +354,13 @@ class SelectIfHasCustomProperty(bpy.types.Operator):
             else:
                 obj.select_set(False)
 
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "SelectIfHasCustomProperty"
+            },
+        )
+
+
         return {"FINISHED"}

bpy_speckle/operators/users.py

@@ -1,15 +1,16 @@
 """
 User account operators
 """
-from typing import cast
+from typing import List, 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 specklepy.api.client import SpeckleClient
-from specklepy.api.models import Stream
-from specklepy.api.credentials import get_local_accounts
+from bpy_speckle.properties.scene import SpeckleBranchObject, SpeckleCommitObject, SpeckleSceneSettings, SpeckleStreamObject, SpeckleUserObject, get_speckle, restore_selection_state
+from specklepy.core.api.client import SpeckleClient
+from specklepy.core.api.models import Stream
+from specklepy.core.api.credentials import get_local_accounts, Account
+from specklepy.logging import metrics
 
 class ResetUsers(bpy.types.Operator):
     """
@@ -17,12 +18,20 @@ class ResetUsers(bpy.types.Operator):
     """
 
     bl_idname = "speckle.users_reset"
-    bl_label = "Reset users"
+    bl_label = "Reset Users"
     bl_options = {"REGISTER", "UNDO"}
 
     def execute(self, context):
         self.reset_ui(context)
 
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "ResetUsers"
+            },
+        )
+
         bpy.context.view_layer.update()
         if context.area:
             context.area.tag_redraw()
@@ -37,134 +46,166 @@ class ResetUsers(bpy.types.Operator):
 
 class LoadUsers(bpy.types.Operator):
     """
-    Load all users from local user database
+    Loads all user accounts from the credentials in the local database.
+    See docs to add accounts via Manager
     """
 
     bl_idname = "speckle.users_load"
-    bl_label = "Load users"
+    bl_label = "Load Users"
     bl_options = {"REGISTER", "UNDO"}
+    bl_description = "Loads all user accounts from the credentials in the local database.\nSee docs to add accounts via Manager"
 
     def execute(self, context):
 
         _report("Loading users...")
 
-        speckle = cast(SpeckleSceneSettings, context.scene.speckle) #type: ignore
-        users = speckle.users
+        speckle = get_speckle(context)
+        users_list = speckle.users
 
         ResetUsers.reset_ui(context)
 
         profiles = get_local_accounts()
         active_user_index = 0
 
-        for profile in profiles:
-            user = users.add()
-            user.server_name = profile.serverInfo.name or "Speckle Server"
-            user.server_url = profile.serverInfo.url
-            user.id = profile.userInfo.id
-            user.name = profile.userInfo.name
-            user.email = profile.userInfo.email
-            user.company = profile.userInfo.company or ""
-            try:
-                url = profile.serverInfo.url
-                assert(url)
-                client = SpeckleClient(
-                    host=url,
-                    use_ssl="https" in url,
-                )
-                client.authenticate_with_account(profile)
-                speckle_clients.append(client)
-            except Exception as ex:
-                _report(ex)
-                users.remove(len(users) - 1)
-            if profile.isDefault:
-                active_user_index = len(users) - 1
+        metrics.track(
+            "Connector Action",
+            None, 
+            custom_props={
+                "name": "LoadUsers",
+            },
+        )
+
+        if not profiles:
+            raise Exception("Zero accounts were found, please add one through Speckle Manager or a local account")
+
+        for profile in profiles:
+            try:
+                add_user_account(profile, speckle)
+            except Exception as ex:
+                _report(f"Failed to authenticate user account {profile.userInfo.email} with server {profile.serverInfo.url}: {ex}")
+                users_list.remove(len(users_list) - 1)
+                continue
+
+            if profile.isDefault:
+                active_user_index = len(users_list) - 1
+
+        _report(f"Authenticated {len(users_list)}/{len(profiles)} accounts")
+
+        if active_user_index < len(users_list):
+            speckle.active_user = str(active_user_index)
 
-        speckle.active_user = str(active_user_index)
         bpy.context.view_layer.update()
 
         if context.area:
             context.area.tag_redraw()
+
+        if not users_list:
+            raise Exception("Zero valid user accounts were found, please ensure account is valid and the server is running")
+
         return {"FINISHED"}
 
+def add_user_account(account: Account, speckle: SpeckleSceneSettings) -> SpeckleUserObject:
+    """Creates a new new SpeckleUserObject for the provided user Account and adds it to the SpeckleSceneSettings"""
+    users_list = speckle.users
+
+    URL = account.serverInfo.url
+
+    user = cast(SpeckleUserObject, users_list.add())
+    user.server_name = account.serverInfo.name or "Speckle Server"
+    user.server_url = URL
+    user.id = account.userInfo.id
+    user.name = account.userInfo.name
+    user.email = account.userInfo.email
+    user.company = account.userInfo.company or ""
+
+    assert(URL)
+    client = SpeckleClient(
+        host=URL,
+        use_ssl="https" in URL,
+    )
+    client.authenticate_with_account(account)
+    speckle_clients.append(client)
+    return user
+
 
 def add_user_stream(user: SpeckleUserObject, stream: Stream):
-    s = user.streams.add()
+    """Adds the provided Stream (with branch & commits) to the SpeckleUserObject"""
+    s = cast(SpeckleStreamObject, user.streams.add())
     s.name = stream.name
     s.id = stream.id
     s.description = stream.description
 
-    if not stream.branches:
-        return
-
-    # branches = [branch for branch in stream.branches.items if branch.name != "globals"]
-    for b in stream.branches.items:
-        branch = s.branches.add()
-        branch.name = b.name
-
-        if not b.commits:
-            continue
-
-        for c in b.commits.items:
-            commit: SpeckleCommitObject = branch.commits.add()
-            commit.id = commit.name = c.id
-            commit.message = c.message or ""
-            commit.author_name = c.authorName
-            commit.author_id = c.authorId
-            commit.created_at = c.createdAt.strftime("%Y-%m-%d %H:%M:%S.%f%Z") if c.createdAt else ""
-            commit.source_application = str(c.sourceApplication)
-            commit.referenced_object = c.referencedObject
-
-    if hasattr(s, "baseProperties"):
-        s.units = stream.baseProperties.units # type: ignore
-    else:
-        s.units = "Meters"
+    _report(f"Adding stream {s.id} - {s.name}")
+    
+    if stream.branches:
+        s.load_stream_branches(stream)
 
 
 class LoadUserStreams(bpy.types.Operator):
     """
-    Load all available streams for active user user
+    (Re)Load all available projects for active user
     """
 
     bl_idname = "speckle.load_user_streams"
-    bl_label = "Load user streams"
+    bl_label = "Load User's Projects"
     bl_options = {"REGISTER", "UNDO"}
-    bl_description = "(Re)load all available user streams"
+    bl_description = "(Re)Load all available projects for active user"
+
+    stream_limit: int = 20
+    branch_limit: int = 100
+    commits_limit: int = 10
 
     def execute(self, context):
-        try:
-            self.add_stream_from_url(context)
-            return {"FINISHED"}
-        except Exception as ex:
-            _report(f"{self.bl_idname} failed: {ex}")
-            return {"CANCELLED"} 
+        self.load_user_stream(context)
+        return {"FINISHED"}
+
         
-    def add_stream_from_url(self, context: Context) -> None:
+    def load_user_stream(self, context: Context) -> None:
         speckle = get_speckle(context)
 
         user = speckle.validate_user_selection()
 
         client = speckle_clients[int(speckle.active_user)]
-
         try:
-            streams = client.stream.list(stream_limit=20)
-        except Exception as e:
-            _report(f"Failed to retrieve streams: {e}")
-            return
+            streams = client.stream.list(stream_limit=self.stream_limit)
+        except Exception as ex:
+            raise Exception(f"Failed to retrieve projects") from ex
+        
         if not streams:
-            _report("Failed to retrieve streams.")
+            _report("Zero projects found")
             return
 
+
+        active_stream_id = None
+        if active_stream := user.get_active_stream():
+            active_stream_id = active_stream.id
+        elif len(user.streams) > 0:
+            active_stream_id = user.streams[0].id
+
         user.streams.clear()
 
-        default_units = "Meters"
-
-        for s in streams:
+        for i, s in enumerate(streams):
             assert(s.id)
-            sstream = client.stream.get(id=s.id, branch_limit=20)
-            add_user_stream(user, sstream)
+            load_branches = s.id == active_stream_id if active_stream_id else i == 0
+            if load_branches:
+                sstream = client.stream.get(id=s.id, branch_limit=self.branch_limit, commit_limit=10)
+                add_user_stream(user, sstream)
+            else:
+                add_user_stream(user, s)
+
+        restore_selection_state(speckle)
 
         bpy.context.view_layer.update()
 
         if context.area:
             context.area.tag_redraw()
+                
+        metrics.track(
+            "Connector Action",
+            client.account, 
+            custom_props={
+                "name": "LoadUserStreams"
+            },
+        )
+
 

bpy_speckle/properties/collection.py

@@ -5,7 +5,7 @@ import bpy
 
 
 class SpeckleCollectionSettings(bpy.types.PropertyGroup):
-    enabled: bpy.props.BoolProperty(default=False, name="Enabled")
+    enabled: bpy.props.BoolProperty(default=False, name="Enabled") # type: ignore
 
     send_or_receive: bpy.props.EnumProperty(
         name="Mode",
@@ -13,7 +13,6 @@ class SpeckleCollectionSettings(bpy.types.PropertyGroup):
             ("send", "Send", "Send data to Speckle server."),
             ("receive", "Receive", "Receive data from Speckle server."),
         ),
-    )
-    stream_id: bpy.props.StringProperty(default="")
-    name: bpy.props.StringProperty(default="")
-    units: bpy.props.StringProperty(default="")
+    ) # type: ignore
+    stream_id: bpy.props.StringProperty(default="") # type: ignore
+    name: bpy.props.StringProperty(default="") # type: ignore

bpy_speckle/properties/object.py

@@ -13,6 +13,6 @@ class SpeckleObjectSettings(bpy.types.PropertyGroup):
             ("send", "Send", "Send data to Speckle server."),
             ("receive", "Receive", "Receive data from Speckle server."),
         ),
-    )
-    stream_id: bpy.props.StringProperty(default="")
-    object_id: bpy.props.StringProperty(default="")
+    ) # type: ignore
+    stream_id: bpy.props.StringProperty(default="") # type: ignore
+    object_id: bpy.props.StringProperty(default="") # type: ignore

bpy_speckle/properties/scene.py

@@ -1,78 +1,113 @@
 """
 Scene properties
 """
-from typing import Optional, Tuple
+from typing import Iterable, Optional, Tuple, Union, cast
+from dataclasses import dataclass
 import bpy
 from bpy.props import (
     StringProperty,
-    BoolProperty,
     FloatProperty,
     CollectionProperty,
     EnumProperty,
     IntProperty,
-    PointerProperty,
 )
 
+from bpy_speckle.clients import speckle_clients
+from specklepy.core.api.models import Stream
 
 class SpeckleSceneObject(bpy.types.PropertyGroup):
-    name: bpy.props.StringProperty(default="")
+    name: bpy.props.StringProperty(default="") # type: ignore
 
 
 class SpeckleCommitObject(bpy.types.PropertyGroup):
-    id: StringProperty(default="")
-    message: StringProperty(default="")
-    author_name: StringProperty(default="")
-    author_id: StringProperty(default="")
-    created_at: StringProperty(default="")
-    source_application: StringProperty(default="")
-    referenced_object: StringProperty(default="")
+    id: StringProperty(default="") # type: ignore
+    message: StringProperty(default="") # type: ignore
+    author_name: StringProperty(default="") # type: ignore
+    author_id: StringProperty(default="") # type: ignore
+    created_at: StringProperty(default="") # type: ignore
+    source_application: StringProperty(default="") # type: ignore
+    referenced_object: StringProperty(default="") # type: ignore
 
 
 class SpeckleBranchObject(bpy.types.PropertyGroup):
     def get_commits(self, context):
         if self.commits != None and len(self.commits) > 0:
+            COMMITS = cast(Iterable[SpeckleCommitObject], self.commits)
             return [
                 (str(i), commit.id, commit.message, i)
-                for i, commit in enumerate(self.commits)
+                for i, commit in enumerate(COMMITS)
             ]
         return [("0", "<none>", "<none>", 0)]
+  
+    def commit_update_hook(self, context: bpy.types.Context):
+        selection_state.selected_commit_id = SelectionState.get_item_id_by_index(self.commits, self.commit)
+        selection_state.selected_branch_id = self.id
+        # print(f"commit_update_hook: {selection_state.selected_commit_id=}, {selection_state.selected_branch_id=}")
 
-    name: StringProperty(default="main")
-    commits: CollectionProperty(type=SpeckleCommitObject)
+    name: StringProperty(default="main") # type: ignore
+    id: StringProperty(default="") # type: ignore
+    description: StringProperty(default="") # type: ignore
+    commits: CollectionProperty(type=SpeckleCommitObject) # type: ignore
     commit: EnumProperty(
-        name="Commit",
-        description="Active commit",
+        name="Version",
+        description="Selected model version",
         items=get_commits,
-    )
+        update=commit_update_hook,
+    ) # type: ignore
     
     def get_active_commit(self) -> Optional[SpeckleCommitObject]:
         selected_index = int(self.commit)
         if 0 <= selected_index < len(self.commits): 
             return self.commits[selected_index]
         return None
-
-
+    
 class SpeckleStreamObject(bpy.types.PropertyGroup):
+    def load_stream_branches(self, sstream: Stream):
+        self.branches.clear()
+        # branches = [branch for branch in stream.branches.items if branch.name != "globals"]
+        for b in sstream.branches.items:
+            branch = cast(SpeckleBranchObject, self.branches.add())
+            branch.name = b.name
+            branch.id = b.id
+            branch.description = b.description or ""
+
+            if not b.commits:
+                continue
+
+            for c in b.commits.items:
+                commit: SpeckleCommitObject = branch.commits.add()
+                commit.id = commit.name = c.id
+                commit.message = c.message or ""
+                commit.author_name = c.authorName
+                commit.author_id = c.authorId
+                commit.created_at = c.createdAt.strftime("%Y-%m-%d %H:%M:%S.%f%Z") if c.createdAt else ""
+                commit.source_application = str(c.sourceApplication)
+                commit.referenced_object = c.referencedObject
+
     def get_branches(self, context):
         if self.branches:
+            BRANCHES = cast(Iterable[SpeckleBranchObject], self.branches)
             return [
-                (str(i), branch.name, branch.name, i)
-                for i, branch in enumerate(self.branches)
+                (str(i), branch.name, branch.description, i)
+                for i, branch in enumerate(BRANCHES)
                 if branch.name != "globals"
             ]
         return [("0", "<none>", "<none>", 0)]
+    
+    def branch_update_hook(self, context: bpy.types.Context):
+        selection_state.selected_branch_id = SelectionState.get_item_id_by_index(self.branches, self.branch)
+        # print(f"branch_update_hook: {selection_state.selected_branch_id=}, {selection_state.selected_stream_id=}")
 
-    name: StringProperty(default="SpeckleStream")
-    description: StringProperty(default="No description provided.")
-    id: StringProperty(default="")
-    units: StringProperty(default="Meters")
-    query: StringProperty(default="")
-    branches: CollectionProperty(type=SpeckleBranchObject)
+    name: StringProperty(default="") # type: ignore
+    description: StringProperty(default="") # type: ignore
+    id: StringProperty(default="") # type: ignore
+    branches: CollectionProperty(type=SpeckleBranchObject) # type: ignore
     branch: EnumProperty(
-        name="Branch",
-        description="Active branch",
+        name="Model",
+        description="Selected Model",
         items=get_branches,
-    )
+        update=branch_update_hook,
+    ) # type: ignore
 
     def get_active_branch(self) -> Optional[SpeckleBranchObject]:
         selected_index = int(self.branch)
@@ -80,22 +115,35 @@ class SpeckleStreamObject(bpy.types.PropertyGroup):
             return self.branches[selected_index]
         return None
 
-
 class SpeckleUserObject(bpy.types.PropertyGroup):
-    server_name: StringProperty(default="SpeckleXYZ")
-    server_url: StringProperty(default="https://speckle.xyz")
-    id: StringProperty(default="")
-    name: StringProperty(default="Speckle User")
-    email: StringProperty(default="user@speckle.xyz")
-    company: StringProperty(default="SpeckleSystems")
-    streams: CollectionProperty(type=SpeckleStreamObject)
-    active_stream: IntProperty(default=0)
+    def fetch_stream_branches(self, context: bpy.types.Context, stream: SpeckleStreamObject):
+        speckle = context.scene.speckle
+        client = speckle_clients[int(speckle.active_user)]
+        sstream = client.stream.get(id=stream.id, branch_limit=100, commit_limit=10) # TODO: refactor magic numbers
+        stream.load_stream_branches(sstream)
+
+    def stream_update_hook(self, context: bpy.types.Context):
+        stream = SelectionState.get_item_by_index(self.streams, self.active_stream)
+        selection_state.selected_stream_id = stream.id
+        # print(f"stream_update_hook: {selection_state.selected_stream_id=}, {selection_state.selected_user_id=}")
+        if len(stream.branches) == 0: # do not reload on selection, same as the old behavior 
+            self.fetch_stream_branches(context, stream)
+
+    server_name: StringProperty(default="SpeckleXYZ") # type: ignore
+    server_url: StringProperty(default="https://speckle.xyz") # type: ignore
+    id: StringProperty(default="") # type: ignore
+    name: StringProperty(default="Speckle User") # type: ignore
+    email: StringProperty(default="user@speckle.xyz") # type: ignore
+    company: StringProperty(default="SpeckleSystems") # type: ignore
+    streams: CollectionProperty(type=SpeckleStreamObject) # type: ignore
+    active_stream: IntProperty(default=0, update=stream_update_hook) # type: ignore
 
     def get_active_stream(self) -> Optional[SpeckleStreamObject]:
         selected_index = int(self.active_stream)
         if 0 <= selected_index < len(self.streams): 
             return self.streams[selected_index]
         return None
+    
 
 class SpeckleSceneSettings(bpy.types.PropertyGroup):
     def get_scripts(self, context):
@@ -108,51 +156,55 @@ class SpeckleSceneSettings(bpy.types.PropertyGroup):
         name="Available streams",
         description="Available streams associated with user.",
         items=[],
-    )
+    ) # type: ignore
 
-    users: CollectionProperty(type=SpeckleUserObject)
+    users: CollectionProperty(type=SpeckleUserObject) # type: ignore
 
     def get_users(self, context):
+        USERS = cast(Iterable[SpeckleUserObject], self.users)
         return [
-            (str(i), "{} ({})".format(user.email, user.server_name), user.server_url, i)
-            for i, user in enumerate(self.users)
+            (str(i), f"{user.email} ({user.server_name})", user.server_url, i)
+            for i, user in enumerate(USERS)
         ]
 
-    def set_user(self, context):
-        bpy.ops.speckle.load_user_streams()
+    def user_update_hook(self, context):
+        bpy.ops.speckle.load_user_streams() # type: ignore
+        selection_state.selected_user_id = SelectionState.get_item_id_by_index(self.users, self.active_user)
 
     active_user: EnumProperty(
         items=get_users,
         name="Account",
         description="Select account",
-        update=set_user,
+        update=user_update_hook,
         get=None,
         set=None,
-    )
+    ) # type: ignore
 
-    objects: CollectionProperty(type=SpeckleSceneObject)
+    objects: CollectionProperty(type=SpeckleSceneObject) # type: ignore
 
-    scale: FloatProperty(default=0.001)
+    scale: FloatProperty(default=0.001) # type: ignore
 
     user: StringProperty(
         name="User",
-        description="Current user.",
+        description="Current user",
         default="Speckle User",
-    )
+    ) # type: ignore
 
     receive_script: EnumProperty(
         name="Receive script",
-        description="Script to run when receiving stream objects.",
+        description="Custom py script to execute when receiving objects. See docs for function signature.",
         items=get_scripts,
-    )
+    ) # type: ignore
 
     send_script: EnumProperty(
         name="Send script",
-        description="Script to run when sending stream objects.",
+        description="Custom py script to execute when sending objects. See docs for function signature",
         items=get_scripts,
-    )
+    ) # type: ignore
 
     def get_active_user(self) -> Optional[SpeckleUserObject]:
+        if self.active_user is None:
+            return None
         selected_index = int(self.active_user)
         if 0 <= selected_index < len(self.users):
             return self.users[selected_index]
@@ -162,7 +214,7 @@ class SpeckleSceneSettings(bpy.types.PropertyGroup):
     def validate_user_selection(self) -> SpeckleUserObject:
         user = self.get_active_user()
         if not user:
-            raise SelectionException("No user selected/found")
+            raise SelectionException("No user account selected/found")
         return user
         
     def validate_stream_selection(self) -> Tuple[SpeckleUserObject, SpeckleStreamObject]:
@@ -170,7 +222,7 @@ class SpeckleSceneSettings(bpy.types.PropertyGroup):
 
         stream = user.get_active_stream()
         if not stream:
-            raise SelectionException("No stream selected/found")
+            raise SelectionException("No project selected/found")
 
         return (user, stream)
     
@@ -179,16 +231,81 @@ class SpeckleSceneSettings(bpy.types.PropertyGroup):
 
         branch = stream.get_active_branch()
         if not branch:
-            raise SelectionException("No branch selected/found")
+            raise SelectionException("No model selected/found")
         return (user, stream, branch)
     
     def validate_commit_selection(self) ->Tuple[SpeckleUserObject, SpeckleStreamObject, SpeckleBranchObject, SpeckleCommitObject]:
         (user, stream, branch) = self.validate_branch_selection()
         commit = branch.get_active_commit()
         if commit is None:
-            raise SelectionException("No commit selected/found")
+            raise SelectionException("No model version selected/found")
         
         return (user, stream, branch, commit)
     
 class SelectionException(Exception):
-    pass
+    pass
+
+def get_speckle(context: bpy.types.Context) -> SpeckleSceneSettings:
+    """
+    Gets the speckle scene object
+    """
+    return context.scene.speckle #type: ignore
+
+@dataclass
+class SelectionState:
+    selected_user_id : Optional[str] = None
+    selected_stream_id : Optional[str] = None
+    selected_branch_id : Optional[str] = None
+    selected_commit_id : Optional[str] = None
+
+    @staticmethod
+    def get_item_id_by_index(collection: bpy.types.PropertyGroup, index: Union[str, int]) -> Optional[str]:
+        if item := SelectionState.get_item_by_index(collection, index):
+            return item.id
+        return None
+    
+    @staticmethod
+    def get_item_by_index(collection: bpy.types.PropertyGroup, index: Union[str, int]) -> Optional[bpy.types.PropertyGroup]:
+        items = collection.values()
+        i = int(index)
+        if 0 <= i <= len(items):
+            return items[i]
+        return None
+    
+    @staticmethod
+    def get_item_index_by_id(collection: Iterable[SpeckleCommitObject], id: Optional[str]) -> Optional[str]:
+        for index, item in enumerate(collection):
+            if item.id == id:
+                return str(index)
+        return None
+
+selection_state = SelectionState()
+
+def restore_selection_state(speckle: SpeckleSceneSettings) -> None:
+    # Restore branch selection state
+    if selection_state.selected_branch_id != None:
+        (active_user, active_stream) = speckle.validate_stream_selection()
+        # print(f"restore_selection_state: {active_user.id=}, {active_stream.id=}")
+        # print(f"restore_selection_state: {selection_state.selected_user_id=}, {selection_state.selected_stream_id=}, {selection_state.selected_branch_id=}, {selection_state.selected_commit_id=}")
+
+        is_same_user = active_user.id == selection_state.selected_user_id
+    
+        if is_same_user:
+            active_user.active_stream = int(SelectionState.get_item_index_by_id(active_user.streams, selection_state.selected_stream_id))
+            active_stream = SelectionState.get_item_by_index(active_user.streams, active_user.active_stream)
+            if branch := SelectionState.get_item_index_by_id(active_stream.branches, selection_state.selected_branch_id):
+                active_stream.branch = branch
+    
+    # Restore commit selection state
+    if selection_state.selected_commit_id != None:
+        (active_user, active_stream, active_branch) = speckle.validate_branch_selection()
+        # print(f"restore_selection_state: {active_user.id=}, {active_stream.id=}, {active_branch.id=}")
+        # print(f"restore_selection_state: {selection_state.selected_user_id=}, {selection_state.selected_stream_id=}, {selection_state.selected_branch_id=}, {selection_state.selected_commit_id=}")
+
+        is_same_user = active_user.id == selection_state.selected_user_id
+        is_same_stream = active_stream.id == selection_state.selected_stream_id
+        is_same_branch = active_branch.id == selection_state.selected_branch_id
+
+        if is_same_user and is_same_stream and is_same_branch:
+            if commit := SelectionState.get_item_index_by_id(active_branch.commits, selection_state.selected_commit_id):
+                active_branch.commit = commit

bpy_speckle/specklepy_extras/commit_object_builder.py

@@ -1,83 +0,0 @@
-from abc import ABC, abstractmethod
-from dataclasses import dataclass
-from typing import Any, Collection, Dict, Generic, Iterable, List, Optional, Tuple, TypeVar
-from attrs import define
-from specklepy.objects.base import Base
-
-ROOT: str = "__Root"
-
-T = TypeVar('T')
-PARENT_INFO = Tuple[Optional[str], str]
-
-@define(slots=True)
-class CommitObjectBuilder(ABC, Generic[T]):
-
-    converted: Dict[str, Base]
-    _parent_infos: Dict[str, Collection[PARENT_INFO]]
-
-    def __init__(self) -> None:
-        self.converted = {}
-        self._parent_infos = {}
-    
-    @abstractmethod
-    def include_object(self, conversion_result: Base, native_object: T) -> None:
-        pass
-
-    def build_commit_object(self, root_commit_object: Base) -> None:
-        self.apply_relationships(self.converted.values(), root_commit_object)
-
-    def set_relationship(self, app_id: Optional[str], *parent_info : PARENT_INFO) -> None:
-
-        if not app_id:
-            return
-        
-        self._parent_infos[app_id] = parent_info
-
-    def apply_relationships(self, to_add: Iterable[Base], root_commit_object: Base) -> None:
-        for c in to_add:
-            try:
-                self.apply_relationship(c, root_commit_object)
-            except Exception as ex:
-                print(f"Failed to add object {type(c)} to commit object: {ex}")
-
-    def apply_relationship(self, current: Base, root_commit_object: Base):
-        if not current.applicationId: raise Exception(f"Expected applicationId to have been set") 
-        
-        parents = self._parent_infos[current.applicationId]
-        
-        for (parent_id, prop_name) in parents:
-            if not parent_id: continue
-
-            parent: Optional[Base]
-            if parent_id == ROOT:
-                parent = root_commit_object
-            else:
-                parent = self.converted[parent_id] if parent_id in self.converted else None
-            
-            if not parent: continue
-
-            try:
-                elements = get_detached_prop(parent, prop_name)
-                if not isinstance(elements, list):
-                    elements = []
-                    set_detached_prop(parent, prop_name, elements)
-
-                elements.append(current)
-                return
-            except Exception as ex:
-                # A parent was found, but it was invalid (Likely because of a type mismatch on a `elements` property)
-                print(f"Failed to add object {type(current)} to a converted parent; {ex}")
-                
-            raise Exception(f"Could not find a valid parent for object of type {type(current)}. Checked {len(parents)} potential parent, and non were converted!")
-
-
-def get_detached_prop(speckle_object: Base, prop_name: str) -> Optional[Any]:
-    detached_prop_name = get_detached_prop_name(speckle_object, prop_name)
-    return getattr(speckle_object, detached_prop_name, None)
-
-def set_detached_prop(speckle_object: Base, prop_name: str, value: Optional[Any]) -> None:
-    detached_prop_name = get_detached_prop_name(speckle_object, prop_name)
-    setattr(speckle_object, detached_prop_name, value)
-
-def get_detached_prop_name(speckle_object: Base, prop_name: str) -> str:
-    return prop_name if hasattr(speckle_object, prop_name) else f"@{prop_name}"

bpy_speckle/specklepy_extras/traversal.py

@@ -1,121 +0,0 @@
-from typing import Any, Callable, Collection, Iterable, Iterator, List, Optional, Set
-
-from attrs import define
-from typing_extensions import Protocol, final
-
-from specklepy.objects import Base
-
-
-class ITraversalRule(Protocol):
-    def get_members_to_traverse(self, o: Base) -> Set[str]:
-        """Get the members to traverse."""
-        pass
-
-    def does_rule_hold(self, o: Base) -> bool:
-        """Make sure the rule still holds."""
-        pass
-
-
-@final
-class DefaultRule:
-    def get_members_to_traverse(self, _) -> Set[str]:
-        return set()
-
-    def does_rule_hold(self, _) -> bool:
-        return True
-
-
-# we're creating a local protected "singleton"
-_default_rule = DefaultRule()
-
-
-@final
-@define(slots=True, frozen=True)
-class TraversalContext:
-    current: Base
-    member_name: Optional[str] = None
-    parent: Optional["TraversalContext"] = None
-
-
-@final
-@define(slots=True, frozen=True)
-class GraphTraversal:
-
-    _rules: List[ITraversalRule]
-
-    def traverse(self, root: Base) -> Iterator[TraversalContext]:
-        stack: List[TraversalContext] = []
-
-        stack.append(TraversalContext(root))
-
-        while len(stack) > 0:
-            head = stack.pop()
-            yield head
-
-            current = head.current
-            active_rule = self._get_active_rule_or_default_rule(current)
-            members_to_traverse = active_rule.get_members_to_traverse(current)
-            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
-                    )
-                except KeyError as ex:
-                    # Unset application ids, and class variables like SpeckleType will throw when __getitem__ is called
-                    pass
-    @staticmethod
-    def _traverse_member_to_stack(
-        stack: List[TraversalContext],
-        value: Any,
-        member_name: Optional[str] = None,
-        parent: Optional[TraversalContext] = None,
-    ):
-        if isinstance(value, Base):
-            stack.append(TraversalContext(value, member_name, parent))
-        elif isinstance(value, list):
-            for obj in value:
-                GraphTraversal._traverse_member_to_stack(stack, obj, member_name, parent)
-        elif isinstance(value, dict):
-            for obj in value.values():
-                GraphTraversal._traverse_member_to_stack(stack, obj, member_name, parent)
-
-    @staticmethod
-    def traverse_member(value: Optional[Any]) -> Iterator[Base]:
-        if isinstance(value, Base):
-            yield value
-        elif isinstance(value, list):
-            for obj in value:
-                for o in GraphTraversal.traverse_member(obj):
-                    yield o
-        elif isinstance(value, dict):
-            for obj in value.values():
-                for o in GraphTraversal.traverse_member(obj):
-                    yield o
-
-
-    def _get_active_rule_or_default_rule(self, o: Base) -> ITraversalRule:
-        return self._get_active_rule(o) or _default_rule
-
-    def _get_active_rule(self, o: Base) -> Optional[ITraversalRule]:
-        for rule in self._rules:
-            if rule.does_rule_hold(o):
-                return rule
-        return None
-
-
-@final
-@define(slots=True, frozen=True)
-class TraversalRule:
-    _conditions: Collection[Callable[[Base], bool]]
-    _members_to_traverse: Callable[[Base], Iterable[str]]
-
-    def get_members_to_traverse(self, o: Base) -> Set[str]:
-        return set(self._members_to_traverse(o))
-
-    def does_rule_hold(self, o: Base) -> bool:
-        for condition in self._conditions:
-            if condition(o):
-                return True
-        return False

bpy_speckle/ui/object.py

@@ -10,8 +10,9 @@ from bpy.props import (
     CollectionProperty,
     EnumProperty,
 )
+from deprecated import deprecated
 
-
+@deprecated
 class OBJECT_PT_speckle(bpy.types.Panel):
     bl_space_type = "PROPERTIES"
     # bl_idname = 'OBJECT_PT_speckle'
@@ -28,7 +29,7 @@ class OBJECT_PT_speckle(bpy.types.Panel):
         layout.active = ob.speckle.enabled
         col = layout.column()
         col.prop(ob.speckle, "send_or_receive", expand=True)
-        col.prop(ob.speckle, "stream_id", text="Stream ID")
+        col.prop(ob.speckle, "stream_id", text="Project ID")
         col.prop(ob.speckle, "object_id", text="Object ID")
         col.operator("speckle.update_object", text="Update")
         col.operator("speckle.reset_object", text="Reset")

bpy_speckle/ui/view3d.py

@@ -4,20 +4,10 @@ Speckle UI elements for the 3d viewport
 
 
 import bpy
-from bpy.props import (
-    StringProperty,
-    BoolProperty,
-    FloatProperty,
-    CollectionProperty,
-    EnumProperty,
-)
 
 from datetime import datetime
 
-"""
-Compatibility 
-TODO: evaluate if we should still support Blender <2.80
-"""
+from bpy_speckle.properties.scene import get_speckle
 
 Region = "TOOLS" if bpy.app.version < (2, 80, 0) else "UI"
 
@@ -78,7 +68,7 @@ class VIEW3D_UL_SpeckleUsers(bpy.types.UIList):
 
 class VIEW3D_UL_SpeckleStreams(bpy.types.UIList):
     """
-    Speckle stream list
+    Speckle projects list
     """
 
     def draw_item(self, context, layout, data, stream, active_data, active_propname):
@@ -94,7 +84,7 @@ class VIEW3D_UL_SpeckleStreams(bpy.types.UIList):
 
         elif self.layout_type in {"GRID"}:
             layout.alignment = "CENTER"
-            layout.label(text="Streams", icon_value=0)
+            layout.label(text="Projects", icon_value=0)
 
 
 class VIEW3D_PT_SpeckleUser(bpy.types.Panel):
@@ -106,10 +96,10 @@ class VIEW3D_PT_SpeckleUser(bpy.types.Panel):
     bl_region_type = Region
     bl_category = "Speckle"
     bl_context = "objectmode"
-    bl_label = "User"
+    bl_label = "User Account"
 
     def draw(self, context):
-        speckle = context.scene.speckle
+        speckle = get_speckle(context)
 
         layout = self.layout
         col = layout.column()
@@ -119,28 +109,28 @@ class VIEW3D_PT_SpeckleUser(bpy.types.Panel):
         else:
             col.prop(speckle, "active_user", text="")
             user = speckle.users[int(speckle.active_user)]
-            col.label(text="{} ({})".format(user.server_name, user.server_url))
-            col.label(text="{} ({})".format(user.name, user.email))
-            
+            col.label(text=f"{user.server_name} ({user.server_url})")
+            col.label(text=f"{user.name} ({user.email})")
+
         col.operator("speckle.users_load", text="", icon="FILE_REFRESH")
 
 class VIEW3D_PT_SpeckleStreams(bpy.types.Panel):
     """
-    Speckle Streams UI panel in the 3d viewport
+    Speckle projects UI panel in the 3d viewport
     """
 
     bl_space_type = "VIEW_3D"
     bl_region_type = Region
     bl_category = "Speckle"
     bl_context = "objectmode"
-    bl_label = "Streams"
+    bl_label = "Projects"
 
     def draw(self, context):
-        speckle = context.scene.speckle
+        speckle = get_speckle(context)
         col = self.layout.column()
 
         if len(speckle.users) < 1:
-            col.label(text="No stream data.")
+            col.label(text="No Projects")
         else:
             user = speckle.users[int(speckle.active_user)]
             col.template_list(
@@ -149,31 +139,31 @@ class VIEW3D_PT_SpeckleStreams(bpy.types.Panel):
             row = col.row(align=True)
             row.operator("speckle.add_stream_from_url", text="", icon="URL")
             row.operator("speckle.create_stream", text="", icon="ADD")
-            row.operator("speckle.delete_stream", text="", icon="REMOVE")
             row.operator("speckle.load_user_streams", text="", icon="FILE_REFRESH")
 
 
 class VIEW3D_PT_SpeckleActiveStream(bpy.types.Panel):
     """
-    Speckle Active Streams UI panel in the 3d viewport
+    Speckle Active Projects UI panel in the 3d viewport
     """
 
     bl_space_type = "VIEW_3D"
     bl_region_type = Region
     bl_category = "Speckle"
     bl_context = "objectmode"
-    bl_label = "Active stream"
+    bl_label = "Active Project"
 
     def draw(self, context):
-        speckle = context.scene.speckle
+        speckle = get_speckle(context)
         col = self.layout.column()
 
         if len(speckle.users) < 1:
-            col.label(text="No stream data.")
+            col.label(text="No projects")
         else:
-            user = speckle.users[int(speckle.active_user)]
+            user = speckle.validate_user_selection()
+            #user = speckle.users[int(speckle.active_user)]
             if len(user.streams) < 1:
-                col.label(text="No active stream.")
+                col.label(text="No active project")
             else:
                 stream = user.streams[user.active_stream]
                 # user.active_stream = min(user.active_stream, len(user.streams) - 1)
@@ -183,14 +173,14 @@ class VIEW3D_PT_SpeckleActiveStream(bpy.types.Panel):
                 col.separator()
 
                 row = col.row()
-                row.prop(stream, "branch", text="")
-                row.operator("speckle.branch_copy_name", text="", icon="COPY_ID")
+                row.prop(stream, "branch", text="Model")
+                row.operator("speckle.model_copy_id", text="", icon="COPY_ID")
 
                 if len(stream.branches) > 0:
                     branch = stream.branches[int(stream.branch)]
 
                     row = col.row()
-                    row.prop(branch, "commit", text="")
+                    row.prop(branch, "commit", text="Version")
                     row.operator("speckle.commit_copy_id", text="", icon="COPY_ID")
 
                     if len(branch.commits) > 0:
@@ -213,7 +203,7 @@ class VIEW3D_PT_SpeckleActiveStream(bpy.types.Panel):
                         col.label(text=f"{commit.author_name} ({commit.author_id})")
                         col.label(text=commit.source_application)
                 else:
-                    col.label(text="No branches found!")
+                    col.label(text="No models found!")
 
                 col.separator()
 
@@ -225,7 +215,6 @@ class VIEW3D_PT_SpeckleActiveStream(bpy.types.Panel):
                 subcol = row.column()
                 subcol.operator("speckle.send_stream_objects", text="Send")
                 subcol.prop(speckle, "send_script", text="")
-                area.prop(stream, "query", text="Filter")
 
                 col.separator()
 
@@ -246,7 +235,7 @@ class VIEW3D_PT_SpeckleActiveStream(bpy.types.Panel):
 
                 area.separator()
                 col.separator()
-                col.operator("speckle.view_stream_data_api", text="Open Stream in Web")
+                col.operator("speckle.view_stream_data_api", text="Open Model in Web")
 
 
 class VIEW3D_PT_SpeckleHelp(bpy.types.Panel):

pyproject.toml

@@ -7,18 +7,17 @@ license = "Apache-2.0"
 
 [tool.poetry.dependencies]
 python = ">=3.8, <4.0.0"
-specklepy = "^2.14.0"
+specklepy = "^2.19.1"
 attrs = "^23.1.0"
 
 # [tool.poetry.group.local_specklepy.dependencies]
 # specklepy = {path = "../specklepy", develop = true}
 
 [tool.poetry.group.dev.dependencies]
-numpy = "^1.23.5"
-fake-bpy-module-latest = "^20230117"
-black = "^22.10.0"
+fake-bpy-module-latest = "^20240524"
+black = "23.11.0"
 pylint = "^2.15.7"
-ruff = "^0.0.166"
+ruff = "^0.4.4"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]