feat: implement variables viewport UI and backend logic for smartprop editor

Author: dertwist

src/editors/smartprop_editor/document.py

@@ -1088,9 +1088,26 @@ def _populate_variables(self, data):
             for item in data:
                 var_class = (item.get("_class", "")).replace(variable_prefix, "")
                 var_name = item.get("m_VariableName", None)
-                var_display_name = item.get("m_DisplayName", None)
-                if var_display_name is None:
-                    var_display_name = item.get("m_ParameterName", None)
+                
+                cat_name = item.get("m_Hammer5ToolsCategoryName")
+                import re
+                is_category = False
+                is_start = False
+                if var_name:
+                    if re.match(r"hammer5tools_category_([a-z0-9]+)_(start|end)", var_name) or re.match(r"hammer5tools_category_(.*)_category_(.*)_(start|end)", var_name):
+                        is_category = True
+                        is_start = var_name.endswith('_start')
+                
+                if is_category and cat_name is not None:
+                    if is_start:
+                        var_display_name = f" ----===={cat_name}===------"
+                    else:
+                        var_display_name = "                                             "
+                else:
+                    var_display_name = item.get("m_DisplayName", None)
+                    if var_display_name is None:
+                        var_display_name = item.get("m_ParameterName", None)
+                        
                 var_visible_in_editor = bool(item.get("m_bExposeAsParameter", None))
                 var_value = {
                     "default": item.get("m_DefaultValue", None),
@@ -1120,13 +1137,20 @@ def _populate_variables(self, data):
                         break
 
                 if not variable_exists:
-                    self.add_variable(
-                        name=var_name,
-                        var_value=var_value,
-                        var_visible_in_editor=var_visible_in_editor,
-                        var_class=var_class,
-                        var_display_name=var_display_name
-                    )
+                    if is_category:
+                        self.add_category(
+                            name=var_name,
+                            var_visible_in_editor=var_visible_in_editor,
+                            var_display_name=var_display_name
+                        )
+                    else:
+                        self.add_variable(
+                            name=var_name,
+                            var_value=var_value,
+                            var_visible_in_editor=var_visible_in_editor,
+                            var_class=var_class,
+                            var_display_name=var_display_name
+                        )
 
     def add_an_element(self):
         self.popup_menu = PopupMenu(elements_list, add_once=False, window_name="SPE_elements")
@@ -1310,44 +1334,75 @@ def open_file(self, filename):
 
             # Rebuild variables
             if isinstance(variables, list):
+                import re
                 for item in variables:
                     var_class = (item["_class"]).replace(variable_prefix, "")
                     var_name = item.get("m_VariableName", None)
-                    var_display_name = item.get("m_DisplayName", None)
-                    if var_display_name is None:
-                        var_display_name = item.get("m_ParameterName", None)
                     var_visible_in_editor = bool(item.get("m_bExposeAsParameter", None))
 
-                    var_value = {
-                        "default": item.get("m_DefaultValue", None),
-                        "model": item.get("m_sModelName", None),
-                        "m_nElementID": item.get("m_nElementID", None),
-                        'm_HideExpression': item.get("m_HideExpression", None)
-                    }
-                    element_id = var_value['m_nElementID']
-                    if element_id is not None:
-                        self.element_id_generator.add_id(element_id)
-                    else:
-                        var_value = self.element_id_generator.update_value(var_value)
-                    if var_class == "Float":
-                        var_value.update({
-                            "min": item.get("m_flParamaterMinValue", None),
-                            "max": item.get("m_flParamaterMaxValue", None)
-                        })
-                    elif var_class == "Int":
-                        var_value.update({
-                            "min": item.get("m_nParamaterMinValue", None),
-                            "max": item.get("m_nParamaterMaxValue", None)
-                        })
+                    # Detect category markers
+                    is_category = False
+                    is_start = False
+                    if var_name:
+                        if re.match(r"hammer5tools_category_([a-z0-9]+)_(start|end)", var_name) or re.match(r"hammer5tools_category_(.*)_category_(.*)_(start|end)", var_name):
+                            is_category = True
+                            is_start = var_name.endswith('_start')
+
+                    if is_category:
+                        cat_name = item.get("m_Hammer5ToolsCategoryName")
+                        if cat_name is not None:
+                            if is_start:
+                                var_display_name = f" ----===={cat_name}===------"
+                            else:
+                                var_display_name = "                                             "
+                        else:
+                            var_display_name = item.get("m_ParameterName", None)
+
+                        # Still register element ID
+                        element_id = item.get("m_nElementID", None)
+                        if element_id is not None:
+                            self.element_id_generator.add_id(element_id)
+
+                        self.add_category(
+                            name=var_name,
+                            var_visible_in_editor=var_visible_in_editor,
+                            var_display_name=var_display_name
+                        )
                     else:
-                        var_value.update({"min": None, "max": None})
-                    self.add_variable(
-                        name=var_name,
-                        var_value=var_value,
-                        var_visible_in_editor=var_visible_in_editor,
-                        var_class=var_class,
-                        var_display_name=var_display_name
-                    )
+                        var_display_name = item.get("m_DisplayName", None)
+                        if var_display_name is None:
+                            var_display_name = item.get("m_ParameterName", None)
+
+                        var_value = {
+                            "default": item.get("m_DefaultValue", None),
+                            "model": item.get("m_sModelName", None),
+                            "m_nElementID": item.get("m_nElementID", None),
+                            'm_HideExpression': item.get("m_HideExpression", None)
+                        }
+                        element_id = var_value['m_nElementID']
+                        if element_id is not None:
+                            self.element_id_generator.add_id(element_id)
+                        else:
+                            var_value = self.element_id_generator.update_value(var_value)
+                        if var_class == "Float":
+                            var_value.update({
+                                "min": item.get("m_flParamaterMinValue", None),
+                                "max": item.get("m_flParamaterMaxValue", None)
+                            })
+                        elif var_class == "Int":
+                            var_value.update({
+                                "min": item.get("m_nParamaterMinValue", None),
+                                "max": item.get("m_nParamaterMaxValue", None)
+                            })
+                        else:
+                            var_value.update({"min": None, "max": None})
+                        self.add_variable(
+                            name=var_name,
+                            var_value=var_value,
+                            var_visible_in_editor=var_visible_in_editor,
+                            var_class=var_class,
+                            var_display_name=var_display_name
+                        )
 
             self._modified = False
         finally:
@@ -1488,6 +1543,12 @@ def add_variable(
             self._modified = True
             self._edited.emit()
 
+    def add_category(self, name, var_visible_in_editor, var_display_name, index: int = None, expanded: bool = True):
+        self.variable_viewport.add_category(name, var_visible_in_editor, var_display_name, index, expanded)
+        if not self._restoring_state:
+            self._modified = True
+            self._edited.emit()
+
     def duplicate_variable(self, __data, __index):
         self.variable_viewport.duplicate_variable(__data, __index)
 
@@ -2115,14 +2176,29 @@ def _restore_variables(self, state):
         self._restoring_state = True
         try:
             for var_data in state:
-                self.add_variable(
-                    name=var_data['name'],
-                    var_class=var_data['var_class'],
-                    var_value=var_data['var_value'],
-                    var_visible_in_editor=var_data['var_visible_in_editor'],
-                    var_display_name=var_data['var_display_name'],
-                    expanded=var_data.get('expanded', False),
-                )
+                name = var_data['name']
+                import re
+                is_category = False
+                if name:
+                    if re.match(r"hammer5tools_category_([a-z0-9]+)_(start|end)", name) or re.match(r"hammer5tools_category_(.*)_category_(.*)_(start|end)", name):
+                        is_category = True
+                        
+                if is_category:
+                    self.add_category(
+                        name=name,
+                        var_visible_in_editor=var_data['var_visible_in_editor'],
+                        var_display_name=var_data['var_display_name'],
+                        expanded=var_data.get('expanded', True)
+                    )
+                else:
+                    self.add_variable(
+                        name=name,
+                        var_class=var_data['var_class'],
+                        var_value=var_data['var_value'],
+                        var_visible_in_editor=var_data['var_visible_in_editor'],
+                        var_display_name=var_data['var_display_name'],
+                        expanded=var_data.get('expanded', False),
+                    )
         finally:
             self._restoring_state = False
         self._modified = True

src/editors/smartprop_editor/property_frame.py

@@ -932,27 +932,14 @@ def mousePressEvent(self, event):
             if prefix and name:
                 self.clicked.emit(f"{prefix}_{name}")
 
+    mousePressEvent = PropertyMethods.mousePressEvent
     mouseMoveEvent = PropertyMethods.mouseMoveEvent
     dragEnterEvent = PropertyMethods.dragEnterEvent
     dragMoveEvent = PropertyMethods.dragMoveEvent
     dragLeaveEvent = PropertyMethods.dragLeaveEvent
 
     def dropEvent(self, event):
-        if event.source() == self:
-            return
-
-        mime_data = event.mimeData()
-        if mime_data.hasText():
-            if event.source() != self:
-                source_index = self.widget_list.layout().indexOf(event.source())
-                target_index = self.widget_list.layout().indexOf(self)
-                if source_index != -1 and target_index != -1:
-                    if source_index < self.widget_list.layout().count():
-                        source_widget = self.widget_list.layout().takeAt(source_index).widget()
-                        if source_widget:
-                            self.widget_list.layout().insertWidget(target_index, source_widget)
-        self.edited.emit()
-        event.accept()
+        PropertyMethods.dropEvent(self, event)
 
     def show_context_menu(self):
         context_menu = QMenu()

src/editors/smartprop_editor/ui_variables_viewport.py

@@ -107,6 +107,46 @@ def setupUi(self, Form):
 
         self.horizontalLayout.addWidget(self.paste_variable_button)
 
+        self.add_new_category_button = QToolButton(self.frame)
+        self.add_new_category_button.setObjectName(u"add_new_category_button")
+        self.add_new_category_button.setMaximumSize(QSize(28, 28))
+        self.add_new_category_button.setStyleSheet(u"\n"
+"    /* QPushButton default and hover styles */\n"
+"    QToolButton {\n"
+"\n"
+"        font: 580 9pt \"Segoe UI\";\n"
+"\n"
+"\n"
+"        border: 2px solid black;\n"
+"        border-radius: 2px;\n"
+"        border-color: rgba(80, 80, 80, 255);\n"
+"        height:22px;\n"
+"        padding-top: 2px;\n"
+"        padding-bottom:2px;\n"
+"        padding-left: 4px;\n"
+"        padding-right: 4px;\n"
+"        color: #E3E3E3;\n"
+"        background-color: #1C1C1C;\n"
+"    }\n"
+"    QToolButton:hover {\n"
+"        background-color: #414956;\n"
+"        color: white;\n"
+"    }\n"
+"    QToolButton:pressed {\n"
+"        background-color: red;\n"
+"        background-color: #1C1C1C;\n"
+"        margin: 1 px;\n"
+"        margin-left: 2px;\n"
+"        margin-right: 2px;\n"
+"\n"
+"    }")
+        icon1 = QIcon()
+        icon1.addFile(u":/icons/create_new_folder_24dp_9D9D9D_FILL0_wght400_GRAD0_opsz24.svg", QSize(), QIcon.Mode.Normal, QIcon.State.Off)
+        self.add_new_category_button.setIcon(icon1)
+        self.add_new_category_button.setIconSize(QSize(20, 20))
+
+        self.horizontalLayout.addWidget(self.add_new_category_button)
+
         self.add_new_variable_button = QToolButton(self.frame)
         self.add_new_variable_button.setObjectName(u"add_new_variable_button")
         self.add_new_variable_button.setMaximumSize(QSize(28, 28))
@@ -140,9 +180,9 @@ def setupUi(self, Form):
 "        margin-right: 2px;\n"
 "\n"
 "    }")
-        icon1 = QIcon()
-        icon1.addFile(u":/icons/add_24dp_9D9D9D_FILL0_wght400_GRAD0_opsz24.svg", QSize(), QIcon.Mode.Normal, QIcon.State.Off)
-        self.add_new_variable_button.setIcon(icon1)
+        icon2 = QIcon()
+        icon2.addFile(u":/icons/add_24dp_9D9D9D_FILL0_wght400_GRAD0_opsz24.svg", QSize(), QIcon.Mode.Normal, QIcon.State.Off)
+        self.add_new_variable_button.setIcon(icon2)
         self.add_new_variable_button.setIconSize(QSize(20, 20))
 
         self.horizontalLayout.addWidget(self.add_new_variable_button)
@@ -329,6 +369,10 @@ def retranslateUi(self, Form):
         self.paste_variable_button.setToolTip(QCoreApplication.translate("Form", u"<html><head/><body><p>Paste variable</p></body></html>", None))
 #endif // QT_CONFIG(tooltip)
         self.paste_variable_button.setText(QCoreApplication.translate("Form", u"...", None))
+#if QT_CONFIG(tooltip)
+        self.add_new_category_button.setToolTip(QCoreApplication.translate("Form", u"<html><head/><body><p>Create category</p></body></html>", None))
+#endif // QT_CONFIG(tooltip)
+        self.add_new_category_button.setText(QCoreApplication.translate("Form", u"...", None))
 #if QT_CONFIG(tooltip)
         self.add_new_variable_button.setToolTip(QCoreApplication.translate("Form", u"<html><head/><body><p>Create variable</p></body></html>", None))
 #endif // QT_CONFIG(tooltip)