Icons to header & sidebar

2026-08-11 18:16:40 +00:00 · 2024-08-25 00:24:08 -04:00
parent fea8e3a5c9
commit 86f123b6b0
2 changed files with 188 additions and 95 deletions
@@ -216,6 +216,7 @@ def register():
    bpy.types.VIEW3D_MT_add.append(ui.add_menu)
    bpy.app.handlers.load_post.append(handler.load_post)

+    workspace.load_custom_icons()

 def unregister():
    if not bpy.app.background:
@@ -241,3 +242,4 @@ def unregister():
    bpy.app.handlers.load_post.remove(handler.load_post)
    bpy.types.VIEW3D_MT_mesh_add.remove(ui.add_mesh_object_menu)
    bpy.types.VIEW3D_MT_add.remove(ui.add_menu)
+    workspace.unload_custom_icons()
@@ -18,6 +18,7 @@

 import os
 import bpy
+import bpy.utils.previews
 import bonsai.tool as tool
 import bonsai.core.model as core
 from bonsai.bim.module.model.wall import DumbWallJoiner
@@ -27,11 +28,28 @@ from bonsai.bim.module.model.data import AuthoringData
 from bonsai.bim.module.system.data import PortData
 from bonsai.bim.module.model.prop import get_ifc_class

+custom_icon_previews = None
+
+def load_custom_icons():
+    global custom_icon_previews
+    icons_dir = os.path.join(os.path.dirname(__file__), "..", "..", "data", "icons")
+    custom_icon_previews = bpy.utils.previews.new()
+    for entry in os.scandir(icons_dir):
+        if entry.name.endswith(".png"):
+            name = os.path.splitext(entry.name)[0]
+            custom_icon_previews.load(name.upper(), entry.path, "IMAGE")
+
+
+def unload_custom_icons():
+    global custom_icon_previews
+    if custom_icon_previews:
+        bpy.utils.previews.remove(custom_icon_previews)
+        custom_icon_previews = None
+

 class BimTool(WorkSpaceTool):
    bl_space_type = "VIEW_3D"
    bl_context_mode = "OBJECT"
-
    bl_idname = "bim.bim_tool"
    bl_label = "BIM Tool"
    bl_description = "Create and edit elements by construction class"
@@ -220,7 +238,7 @@ class CableTool(BimTool):
        BimToolUI.draw(context, layout, ifc_element_type=cls.ifc_element_type)


-def add_layout_hotkey_operator(layout, text, hotkey, description):
+def add_layout_hotkey_operator(layout, text, hotkey, description, ui_context=""):
    modifiers = {
        "A": "EVENT_ALT",
        "C": "EVENT_CTRL",
@@ -228,11 +246,19 @@ def add_layout_hotkey_operator(layout, text, hotkey, description):
    }
    modifier, key = hotkey.split("_")

-    row = layout.row(align=True)
-    row.label(text="", icon=modifiers[modifier])
-    row.label(text="", icon=f"EVENT_{key}")
+    try:
+        custom_icon = custom_icon_previews[text.upper().replace(" ", "_")].icon_id
+    except KeyError:
+        custom_icon = custom_icon_previews["IFC"].icon_id
+
+    row = layout.row(align=True) 
+    if ui_context == "TOOL_HEADER": 
+        op = row.operator("bim.hotkey", text="", icon_value=custom_icon)
+    else:
+        op = row.operator("bim.hotkey", text=text, icon_value=custom_icon)
+        row.label(text="", icon=modifiers[modifier])
+        row.label(text="", icon=f"EVENT_{key}")

-    op = row.operator("bim.hotkey", text=text)
    op.hotkey = hotkey
    op.description = description
    return op
@@ -260,16 +286,22 @@ class BimToolUI:
            AuthoringData.load(ifc_element_type)

        if context.region.type == "TOOL_HEADER":
-            cls.draw_header_interface()
-        elif context.region.type in ("UI", "WINDOW"):
-            # same interface for both n-panel sidebar and object properties
-            cls.draw_basic_bim_tool_interface()
+            cls.draw_container(context)
+            cls.draw_type_selection_interface(context)
+            if context.active_object and context.selected_objects:
+                cls.draw_edit_object_interface(context)

-        if context.active_object and context.selected_objects:
-            cls.draw_edit_object_interface(context)
-        elif not context.selected_objects:
+        elif context.region.type in ("UI", "WINDOW"):
+            cls.draw_container(context)
+            cls.draw_thumbnail()
+            cls.draw_type_selection_interface(context)
+            if context.active_object and context.selected_objects:
+                cls.draw_edit_object_interface(context)
+
+        if not context.selected_objects:
            cls.draw_create_object_interface()

+
    @classmethod
    def draw_create_object_interface(cls):
        if not AuthoringData.data["relating_type_id"]:
@@ -285,10 +317,10 @@ class BimToolUI:
            row.prop(data=cls.props, property="length", text="Length")

            row = cls.layout.row(align=True)
-            row.prop(data=cls.props, property="x_angle", text="X Angle")
+            row.prop(data=cls.props, property="x_angle", text="Angle")
        elif cls.props.ifc_class in ("IfcSlabType", "IfcRampType", "IfcRoofType"):
            row = cls.layout.row(align=True)
-            row.prop(data=cls.props, property="x_angle", text="X Angle")
+            row.prop(data=cls.props, property="x_angle", text="Angle")
        elif cls.props.ifc_class in ("IfcColumnType", "IfcBeamType", "IfcMemberType"):
            row = cls.layout.row(align=True)
            row.prop(data=cls.props, property="cardinal_point", text="Axis")
@@ -319,46 +351,72 @@ class BimToolUI:

    @classmethod
    def draw_edit_object_interface(cls, context):
+        ui_context = str(context.region.type)
        if AuthoringData.data["active_material_usage"] == "LAYER2":
            row = cls.layout.row(align=True)
-            row.prop(data=cls.props, property="extrusion_depth", text="Height")
+            row.prop(data=cls.props, property="extrusion_depth", text="Height:")
            op = row.operator("bim.change_extrusion_depth", icon="FILE_REFRESH", text="")
            op.depth = cls.props.extrusion_depth

            row = cls.layout.row(align=True)
-            row.prop(data=cls.props, property="length", text="Length")
+            row.prop(data=cls.props, property="length", text="Length:")
            op = row.operator("bim.change_layer_length", icon="FILE_REFRESH", text="")
            op.length = cls.props.length

            row = cls.layout.row(align=True)
-            row.prop(data=cls.props, property="x_angle", text="X Angle")
+            row.prop(data=cls.props, property="x_angle", text="Angle:")
            op = row.operator("bim.change_extrusion_x_angle", icon="FILE_REFRESH", text="")
            op.x_angle = cls.props.x_angle

-            add_layout_hotkey_operator(cls.layout, "Extend", "S_E", "")
-            add_layout_hotkey_operator(cls.layout, "Butt", "S_T", "")
+            cls.layout.separator()
+
+            add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.recalculate_wall.__doc__ + "\n⇧ G", ui_context)
+
+            cls.layout.separator()
+
+            add_layout_hotkey_operator(
+                cls.layout,
+                "Extend",
+                "S_E",
+                "Extends/reduces element to 3D cursor\n⇧ E",
+                ui_context,
+            )
+            add_layout_hotkey_operator(
+                cls.layout,
+                "Butt", "S_T",
+                "Intersects two non-parallel elements to a butt corner junction\n⇧ T",
+                ui_context,
+            )
            add_layout_hotkey_operator(
                cls.layout,
                "Mitre",
                "S_Y",
-                "Join two intersecting walls using a mitre joint.\nOther selected wall is connected to the active",
+                "Intersects two non-parallel elements to a mitred corner junction\n⇧ Y",
+                ui_context,
            )
+                        
+            row = cls.layout.row(align=True)
+            if ui_context == "TOOL_HEADER":
+                op = row.operator("bim.unjoin_walls", text="", icon_value=custom_icon_previews["UNJOIN_WALLS"].icon_id)
+            else:
+                op = row.operator("bim.unjoin_walls", text="Unjoin Walls", icon_value=custom_icon_previews["UNJOIN_WALLS"].icon_id)
+            cls.layout.separator()

-            add_layout_hotkey_operator(cls.layout, "Merge", "S_M", bpy.ops.bim.merge_wall.__doc__)
-            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", bpy.ops.bim.flip_wall.__doc__)
-            add_layout_hotkey_operator(cls.layout, "Split", "S_K", bpy.ops.bim.split_wall.__doc__)
-            add_layout_hotkey_operator(cls.layout, "Rotate 90", "S_R", bpy.ops.bim.rotate_90.__doc__)
-            add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.recalculate_wall.__doc__)
-            row.operator("bim.unjoin_walls", icon="X", text="")
+            add_layout_hotkey_operator(cls.layout, "Merge", "S_M", bpy.ops.bim.merge_wall.__doc__ + "\n⇧ M", ui_context)
+            add_layout_hotkey_operator(cls.layout, "Split", "S_K", bpy.ops.bim.split_wall.__doc__ + "\n⇧ K", ui_context)
+            add_layout_hotkey_operator(cls.layout, "Rotate 90", "S_R", bpy.ops.bim.rotate_90.__doc__ + "\n⇧ R", ui_context)
+            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", bpy.ops.bim.flip_wall.__doc__ + "\n⇧ F", ui_context)
+            
+            # row.operator("bim.unjoin_walls", icon="X", text="")

        elif AuthoringData.data["active_material_usage"] == "LAYER3":
            if len(context.selected_objects) == 1:
-                add_layout_hotkey_operator(cls.layout, "Edit Profile", "S_E", "")
+                add_layout_hotkey_operator(cls.layout, "Edit Profile", "S_E", "", ui_context)
            elif "LAYER2" in AuthoringData.data["selected_material_usages"]:
-                add_layout_hotkey_operator(cls.layout, "Extend Wall To Slab", "S_E", "")
+                add_layout_hotkey_operator(cls.layout, "Extend Wall To Slab", "S_E", "", ui_context)

            row = cls.layout.row(align=True)
-            row.prop(data=cls.props, property="x_angle", text="X Angle")
+            row.prop(data=cls.props, property="x_angle", text="Angle")
            op = row.operator("bim.change_extrusion_x_angle", icon="FILE_REFRESH", text="")
            op.x_angle = cls.props.x_angle

@@ -376,8 +434,14 @@ class BimToolUI:
            op = row.operator("bim.change_profile_depth", icon="FILE_REFRESH", text="")
            op.depth = cls.props.extrusion_depth

-            add_layout_hotkey_operator(cls.layout, "Extend", "S_E", "")
-            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", bpy.ops.bim.flip_object.__doc__)
+            add_layout_hotkey_operator(
+                cls.layout,
+                "Extend",
+                "S_E",
+                "",
+                ui_context,
+            )
+            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", bpy.ops.bim.flip_object.__doc__, ui_context)

            if AuthoringData.data["active_class"] in (
                "IfcCableCarrierSegment",
@@ -386,18 +450,36 @@ class BimToolUI:
                "IfcPipeSegment",
            ):

-                add_layout_hotkey_operator(cls.layout, "Add Fitting", "S_Y", "")
+                add_layout_hotkey_operator(cls.layout, "Add Fitting", "S_Y", "", ui_context)
                if context.region.type != "TOOL_HEADER":
                    cls.layout.operator("bim.mep_add_bend")
                    cls.layout.operator("bim.mep_add_transition")
                    cls.layout.operator("bim.mep_add_obstruction")

            else:
-                add_layout_hotkey_operator(cls.layout, "Edit Axis", "A_E", "")
-                add_layout_hotkey_operator(cls.layout, "Butt", "S_T", "")
-                add_layout_hotkey_operator(cls.layout, "Mitre", "S_Y", "")
-                add_layout_hotkey_operator(cls.layout, "Rotate 90", "S_R", bpy.ops.bim.rotate_90.__doc__)
-                add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.recalculate_profile.__doc__)
+                add_layout_hotkey_operator(
+                    cls.layout,
+                    "Edit Axis",
+                    "A_E",
+                    "",
+                    ui_context,
+                )
+                add_layout_hotkey_operator(
+                    cls.layout,
+                    "Butt",
+                    "S_T",
+                    "",
+                    ui_context,
+                )
+                add_layout_hotkey_operator(
+                    cls.layout,
+                    "Mitre",
+                    "S_Y",
+                    "",
+                    ui_context,
+                )
+                add_layout_hotkey_operator(cls.layout, "Rotate 90", "S_R", bpy.ops.bim.rotate_90.__doc__, ui_context)
+                add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.recalculate_profile.__doc__, ui_context)
            row.operator("bim.extend_profile", icon="X", text="").join_type = ""

        elif (
@@ -422,15 +504,15 @@ class BimToolUI:
                row = cls.layout.row(align=True)
                row.prop(data=cls.props, property="rl1", text="RL")

-            add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.recalculate_fill.__doc__)
-            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", "")
+            add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.recalculate_fill.__doc__, ui_context)
+            add_layout_hotkey_operator(cls.layout, "Flip", "S_F", "", ui_context)

        elif AuthoringData.data["active_representation_type"] == "SweptSolid":
            if not tool.Model.is_parametric_window_active() and not tool.Model.is_parametric_door_active():
-                add_layout_hotkey_operator(cls.layout, "Edit Profile", "S_E", "")
+                add_layout_hotkey_operator(cls.layout, "Edit Profile", "S_E", "", ui_context)

        elif AuthoringData.data["active_class"] in ("IfcSpace",):
-            add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.generate_space.__doc__)
+            add_layout_hotkey_operator(cls.layout, "Regen", "S_G", bpy.ops.bim.generate_space.__doc__, ui_context)

        elif tool.Model.is_parametric_roof_active() and not context.active_object.BIMRoofProperties.is_editing_path:
            row = cls.layout.row(align=True)
@@ -439,25 +521,29 @@ class BimToolUI:

        if context.region.type != "TOOL_HEADER" and PortData.data["total_ports"] > 0:
            add_layout_hotkey_operator(
-                cls.layout, "Regen MEP", "S_G", bpy.ops.bim.regenerate_distribution_element.__doc__
+                cls.layout, "Regen MEP", "S_G", bpy.ops.bim.regenerate_distribution_element.__doc__, ui_context
            )
            cls.layout.operator("bim.mep_connect_elements")

        row = cls.layout.row(align=True)
-        row.label(text="", icon="EVENT_SHIFT")
-        row.label(text="", icon="EVENT_O")
-
        if len(context.selected_objects) > 1:
-            row.operator("bim.add_opening", text="Apply Void")
+            if ui_context == "TOOL_HEADER":
+                row.operator("bim.add_opening", text="", icon_value=custom_icon_previews["VOID"].icon_id)
+            else:
+                row.operator("bim.add_opening", text="Apply Void", icon_value=custom_icon_previews["VOID"].icon_id)
        else:
-            row.operator("bim.add_potential_opening", text="Add Void")
+            if ui_context == "TOOL_HEADER":
+                row.operator("bim.add_potential_opening", text="", icon_value=custom_icon_previews["ADD_VOID"].icon_id)
+            else:
+                row.operator("bim.add_potential_opening", text="Add Void", icon_value=custom_icon_previews["ADD_VOID"].icon_id)
+                row.label(text="", icon="EVENT_SHIFT")
+                row.label(text="", icon="EVENT_O")

        if AuthoringData.data["is_voidable_element"]:
            if AuthoringData.data["has_visible_openings"]:
+                row = cls.layout.row(align=True)
                row.operator("bim.edit_openings", icon="CHECKMARK", text="")
                row.operator("bim.hide_openings", icon="CANCEL", text="")
-            else:
-                row.operator("bim.show_openings", icon="HIDE_OFF", text="")

        if AuthoringData.data["active_class"] in ("IfcOpeningElement",):
            row.operator("bim.edit_openings", icon="CHECKMARK", text="")
@@ -468,52 +554,70 @@ class BimToolUI:
                row.label(text="", icon="EVENT_L")
                row.operator("bim.clone_opening", text="Clone Opening")

-        cls.layout.row(align=True).label(text="Align")
-        add_layout_hotkey_operator(cls.layout, "Align Exterior", "S_X", "")
-        add_layout_hotkey_operator(cls.layout, "Align Centerline", "S_C", "")
-        add_layout_hotkey_operator(cls.layout, "Align Interior", "S_V", "")
-        add_layout_hotkey_operator(cls.layout, "Mirror", "S_M", bpy.ops.bim.mirror_elements.__doc__)
+        if ui_context == "TOOL_HEADER":
+            cls.layout.separator()
+        else:
+            cls.layout.row(align=True).label(text="Align")

-        cls.layout.row(align=True).label(text="Mode")
-        add_layout_hotkey_operator(cls.layout, "Void", "A_O", "Toggle openings")
-        add_layout_hotkey_operator(cls.layout, "Decomposition", "A_D", "Select decomposition")
+        add_layout_hotkey_operator(cls.layout, "Exterior", "S_X", "", ui_context)
+        add_layout_hotkey_operator(cls.layout, "Centerline", "S_C", "", ui_context)
+        add_layout_hotkey_operator(cls.layout, "Interior", "S_V", "", ui_context)
+        add_layout_hotkey_operator(cls.layout, "Mirror", "S_M", bpy.ops.bim.mirror_elements.__doc__, ui_context)

-        cls.layout.row(align=True).label(text="Aggregation")
-        add_layout_hotkey_operator(cls.layout, "Assign", "C_P", bpy.ops.bim.aggregate_assign_object.__doc__)
-        add_layout_hotkey_operator(cls.layout, "Unassign", "A_P", bpy.ops.bim.aggregate_unassign_object.__doc__)
+        if ui_context == "TOOL_HEADER":
+            cls.layout.separator()
+        else:
+            cls.layout.row(align=True).label(text="Mode")

-        cls.layout.separator()
+        add_layout_hotkey_operator(cls.layout, "Void", "A_O", "Toggle openings", ui_context)
+        add_layout_hotkey_operator(cls.layout, "Decomposition", "A_D", "Select decomposition", ui_context)
+
+        if ui_context == "TOOL_HEADER":
+            cls.layout.separator()
+        else:
+            cls.layout.row(align=True).label(text="Aggregation")
+
+        add_layout_hotkey_operator(cls.layout, "Assign", "C_P", bpy.ops.bim.aggregate_assign_object.__doc__, ui_context)
+        add_layout_hotkey_operator(cls.layout, "Unassign", "A_P", bpy.ops.bim.aggregate_unassign_object.__doc__, ui_context)
+
+        if ui_context == "TOOL_HEADER":
+            cls.layout.separator()
+        else:
+            cls.layout.row(align=True).label(text="Qto")
        add_layout_hotkey_operator(
-            cls.layout, "Perform Quantity Take-off", "S_Q", bpy.ops.bim.perform_quantity_take_off.__doc__
+            cls.layout, "Perform Quantity Take-off", "S_Q", bpy.ops.bim.perform_quantity_take_off.__doc__, ui_context
        )

-    @classmethod
-    def draw_header_interface(cls):
-        cls.draw_type_selection_interface()
-
-        if AuthoringData.data["ifc_classes"]:
-            row = cls.layout.row(align=True)
-            row.label(text="", icon="EVENT_SHIFT")
-            row.label(text="", icon="EVENT_A")
-            op = row.operator("bim.add_constr_type_instance", text="Add")
-            op.from_invoke = True
-            if cls.props.relating_type_id.isnumeric():
-                op.relating_type_id = int(cls.props.relating_type_id)

    @classmethod
-    def draw_type_selection_interface(cls):
+    def draw_container(cls, context):
+        text = AuthoringData.data['default_container']
+        if context.region.type == "UI":
+            text = f"Container: {text}"
+
+        cls.layout.row(align=True).label(text=text, icon="OUTLINER_COLLECTION")
+
+
+    @classmethod
+    def draw_type_selection_interface(cls, context):
        # shared by both sidebar and header
+        ui_context = str(context.region.type)
        row = cls.layout.row(align=True)
-        row.label(text=f"Container: {AuthoringData.data['default_container']}", icon="OUTLINER_COLLECTION")
        if AuthoringData.data["ifc_classes"]:
+            if ui_context == "UI":
+                text = "Add"
+            else:
+                text = ""
            if not AuthoringData.data["ifc_element_type"]:
-                row.label(text="", icon="FILE_VOLUME")
+                
                prop_with_search(row, cls.props, "ifc_class", text="")
+                row.operator("bim.add_constr_type_instance", text=text, icon_value=custom_icon_previews["ADD"].icon_id)

            row = cls.layout.row(align=True)
            if AuthoringData.data["relating_type_id"]:
-                row.label(text="", icon="FILE_3D")
                prop_with_search(row, cls.props, "relating_type_id", text="")
+                row.operator("bim.add_constr_type_instance", text=text, icon_value=custom_icon_previews["ADD"].icon_id)
+
            else:
                row.label(text="No Construction Type", icon="FILE_3D")
            row.operator("bim.launch_type_manager", icon=tool.Blender.TYPE_MANAGER_ICON, text="")
@@ -524,7 +628,7 @@ class BimToolUI:
                row.prop(cls.props, "type_name")
                row = cls.layout.row(align=True)
                op = row.operator(
-                    "bim.add_default_type", icon="ADD", text=f"Add {AuthoringData.data['ifc_element_type']}"
+                    "bim.add_default_type", icon_value=custom_icon_previews["ADD_TYPE"].icon_id, text=f"Create {AuthoringData.data['ifc_element_type']}"
                )
                op.ifc_element_type = AuthoringData.data["ifc_element_type"]
                row.operator("bim.launch_type_manager", icon=tool.Blender.TYPE_MANAGER_ICON, text="")
@@ -533,10 +637,8 @@ class BimToolUI:
                row.operator("bim.launch_type_manager", icon=tool.Blender.TYPE_MANAGER_ICON, text="Launch Type Manager")

    @classmethod
-    def draw_basic_bim_tool_interface(cls):
-        cls.draw_type_selection_interface()
-
-        if AuthoringData.data["ifc_classes"]:
+    def draw_thumbnail(cls):
+        if AuthoringData.data["ifc_classes"]:         
            if cls.props.ifc_class:
                box = cls.layout.box()
                if AuthoringData.data["type_thumbnail"]:
@@ -545,14 +647,6 @@ class BimToolUI:
                    op = box.operator("bim.load_type_thumbnails", text="Load Thumbnails", icon="FILE_REFRESH")
                    op.ifc_class = cls.props.ifc_class

-            row = cls.layout.row(align=True)
-            row.label(text="", icon="EVENT_SHIFT")
-            row.label(text="", icon="EVENT_A")
-            op = row.operator("bim.add_constr_type_instance", text="Add")
-            op.from_invoke = True
-            if cls.props.relating_type_id.isnumeric():
-                op.relating_type_id = int(cls.props.relating_type_id)
-

 class Hotkey(bpy.types.Operator, tool.Ifc.Operator):
    bl_idname = "bim.hotkey"
@@ -842,9 +936,6 @@ class Hotkey(bpy.types.Operator, tool.Ifc.Operator):
            self.props.y = self.y
            self.props.z = self.z

-    def hotkey_S_P(self):
-        bpy.ops.bim.draw_polyline_wall("INVOKE_DEFAULT")
-
    def hotkey_S_L(self):
        if AuthoringData.data["active_class"] in ("IfcOpeningElement",):
            if len(bpy.context.selected_objects) == 2: