Update v0.5.0

- New button to collapse all collections easily
- When creating route collection, new options available to automatically exclude/hide/unlink original collections and objects (enabled by default)

Author: vcossy

README.md

@@ -40,7 +40,8 @@ You can use this addon at the very start of a blender map project.
 
 ### Select Map Collection
 1. Once it is imported, you have to find the collection that contains the textured meshes<br>
-  You can `ctrl+left-click` on the visibility toggle of the collection to hide everything else (in the outliner)
+   - You can use the small button right to the collection input to collapse all collections in the outliner (or press `shift+A` when hovering in the outliner)
+   - In the outliner too, you can `ctrl+left-click` on the visibility toggle of the collection to hide everything else
 2. Select this collection in the addon panel, and click on the `Clean Map Collection` button
 3. Depending on how you imported the NR files, you might want to disable `Flip vertically` and `Flip faces` in the popup window
 4. Delete manually things that are not wanted and away from the route
@@ -49,7 +50,5 @@ You can use this addon at the very start of a blender map project.
 Now you have one object per material in the resulting collection.
 1. Select the ones that are part of the route with `shift+left-click`
 2. Click on the `Create Route Collection`
-3. If you don't want the resulting objects to be linked to the first collection:
-   - Select them in the first collection
-   - `right-click` -> `Unlink`
+3. By default, it will hide and exclude the original collection, and unlink the objects in there so they only exist in the newly created collection. You can disable this in the popup window.
 4. Now you can make use of the `Cleaning Tools` to help you with the finishing touches

__init__.py

@@ -1,7 +1,7 @@
 bl_info = {
     "name": "NR_Cleanup",
     "author": "Bigthirsty & Skyrow",
-    "version": (0, 4, 1), #<major>.<minor>.<patch>
+    "version": (0, 5, 0), #<major>.<minor>.<patch>
     "blender": (3, 6, 0),
     "location": "3D Viewport > Sidebar > NR Cleanup",
     "description": "Cleans up NinjaRipped trackmania2020 maps to driving surfaces only",

operators/__init__.py

@@ -2,7 +2,10 @@
 
 # clean_imported_nr
 from .clean_imported_nr.OT_clean_nr_collection import (
-    OBJECT_OT_clean_nr_collection,
+    COLLECTION_OT_clean_nr_collection,
+)
+from .clean_imported_nr.OT_collapse_all_collections import (
+    COLLECTION_OT_collapse_all_collections,
 )
 from .clean_imported_nr.OT_make_route_collection import (
     OBJECT_OT_make_route_collection,
@@ -45,7 +48,8 @@
     # Props and UIList must be registered before operators
     _MaterialSelection,
     _MATERIAL_UL_material_selection,
-    OBJECT_OT_clean_nr_collection,
+    COLLECTION_OT_clean_nr_collection,
+    COLLECTION_OT_collapse_all_collections,
     OBJECT_OT_make_route_collection,
     OBJECT_OT_delete_faces_by_material,
     OBJECT_OT_delete_vertical_faces,

operators/clean_imported_nr/OT_clean_nr_collection.py

@@ -1,7 +1,7 @@
 import bpy
 
 
-class OBJECT_OT_clean_nr_collection(bpy.types.Operator):
+class COLLECTION_OT_clean_nr_collection(bpy.types.Operator):
     """Join all objects in the selected collection and remove other collections"""
     bl_idname = 'collection.clean_nr_collection'
     bl_label = 'Clean NR Collection'

operators/clean_imported_nr/OT_collapse_all_collections.py

@@ -0,0 +1,26 @@
+import bpy
+
+
+class COLLECTION_OT_collapse_all_collections(bpy.types.Operator):
+    """Collapse all collections in the outliner"""
+    bl_idname = 'collection.collapse_all_collections'
+    bl_label = 'Collapse All Collections'
+    bl_options = {'REGISTER', 'UNDO'}
+
+    @classmethod
+    def poll(cls, context):
+        return True
+    
+    def execute(self, context):
+        
+        areaOverride = context.area
+        for area in bpy.context.screen.areas:
+            if area.type == 'OUTLINER':
+                areaOverride=area
+
+        with bpy.context.temp_override(area=areaOverride):
+            bpy.ops.outliner.show_one_level(open=False)
+        
+        areaOverride.tag_redraw()
+
+        return {'FINISHED'}

operators/clean_imported_nr/OT_make_route_collection.py

@@ -7,6 +7,10 @@ class OBJECT_OT_make_route_collection(bpy.types.Operator):
     bl_label = 'Make Route Collection'
     bl_options = {'REGISTER', 'UNDO'}
 
+    exclude_original_collections: bpy.props.BoolProperty(name='Exclude original collections', default=True)
+    hide_original_collections: bpy.props.BoolProperty(name='Hide original collections', default=True)
+    unlink_original_objexts: bpy.props.BoolProperty(name='Unlink original objects', default=True)
+
     @classmethod
     def poll(cls, context):
         return (
@@ -15,15 +19,37 @@ def poll(cls, context):
         )
 
     def execute(self, context):
+        selected_objects = bpy.context.selected_objects
+
+        # Create a new collection for the selected objects
         cleaned_route_collection = bpy.data.collections.get('Cleaned Route')
         if not cleaned_route_collection:
             cleaned_route_collection = bpy.data.collections.new('Cleaned Route')
             bpy.context.scene.collection.children.link(cleaned_route_collection)
 
-        selected_objects = bpy.context.selected_objects
+        # Get the original collections of selected objects
+        original_collections = set()
         for obj in selected_objects:
+            for collection in obj.users_collection:
+                original_collections.add(collection)
+
+        # Link the selected objects to the new collection 
+        for obj in selected_objects:
+            if self.unlink_original_objexts:
+                for col in obj.users_collection:
+                    col.objects.unlink(obj)
             cleaned_route_collection.objects.link(obj)
 
+        # Exclude all collections and enable only new collection
+        for layer_collection in context.view_layer.layer_collection.children:
+            if self.exclude_original_collections:
+                layer_collection.exclude = True
+            if self.hide_original_collections:
+                layer_collection.hide_viewport = True
+        context.view_layer.layer_collection.children[cleaned_route_collection.name].exclude = False    
+        context.view_layer.layer_collection.children[cleaned_route_collection.name].hide_viewport = False    
+
+        # Deselect all objects
         bpy.ops.object.select_all(action='DESELECT')
 
         return {'FINISHED'}

panels/PT_clean_imported_nr.py

@@ -4,7 +4,8 @@
 
 from ..operators import (
     UI_OT_message_popup,
-    OBJECT_OT_clean_nr_collection,
+    COLLECTION_OT_clean_nr_collection,
+    COLLECTION_OT_collapse_all_collections,
     OBJECT_OT_make_route_collection,
 )
 
@@ -28,8 +29,10 @@ def draw(self, context):
             + 'It will join all objects inside of the selected collection\n' \
             + 'and then separate it by material.\n' \
             + 'EVERYTHING ELSE IN THE SCENE WILL BE DELETED !'
-        box.prop(nrc_props, 'nr_collection', text='')
-        box.operator(OBJECT_OT_clean_nr_collection.bl_idname, text='Clean Map Collection')
+        row = box.row(align=True)
+        row.prop(nrc_props, 'nr_collection', text='')
+        row.operator(COLLECTION_OT_collapse_all_collections.bl_idname, text='', icon='FULLSCREEN_EXIT')
+        box.operator(COLLECTION_OT_clean_nr_collection.bl_idname, text='Clean Map Collection')
         # Create route collection
         box = layout.box()
         row = box.row()