Differences

This shows you the differences between two versions of the page.

--- graphic:python:blender [2024/01/24 10:01] – [Blender variable naming standards] ying
+++ graphic:python:blender [2024/02/01 09:13] – [Blender UI code] ying
@@ Line 393: / Line 393: @@
 ref:
   * https://wiki.blender.org/wiki/Reference/Release_Notes/2.80/Python_API/Addons
+  * https://developer.blender.org/docs/release_notes/2.80/python_api/addons/
   * https://s-nako.work/2020/12/blender-addon-naming-rules/
+  * https://b3d.interplanety.org/en/class-naming-conventions-in-blender-2-8-python-api/
-  * Class name convention is: UPPER_CASE_{SEPARATOR}_mixed_case
+  * **Class name convention**: UPPER_CASE_{SEPARATOR}_mixed_case
     * UPPER_CASE: normally the ADDON_NAME, or a Unique ID_WORD that make it not crashing into other existing class names
     * {SEPARATOR}
@@ Line 407: / Line 409: @@
       * _Check_Selection
       * _check_selection
-  * like  [A-Z][A-Z0-9_]*_MT_[A-Za-z0-9_]+
+    * like  [A-Z][A-Z0-9_]*_MT_[A-Za-z0-9_]+
-  * if not follow above: you get warning "doesn't contain '_PT_' with prefix & suffix"
+    * if not follow above: you get warning "doesn't contain '_PT_' with prefix & suffix"
+  * **operator ID name convention** (feel like a username for your operator inside blender )
-  * operator ID name convention (feel like a username for your operator inside blender )
     * category_name.operator_task_like_name
       * custom.addon_name_task_name (snake_case like PEP function)
@@ Line 416: / Line 417: @@
       * class: ADDON_NAME_OT_check_selection
       * bl_idname: addon_name.check_selection
+  * **other same as PEP**
-  * other same as PEP
     * obj = "BigBox"
     * obj_max_count = 2
@@ Line 423: / Line 423: @@
     * class ClassName()
+Example of class name, balancing between Python PEP
+  * example addon, <code python>
+class BUILDMAKER_OT_CreateAsset(bpy.types.Operator):
+    bl_idname = "custom.buildmaker_create_asset"
+class CreateAsset(bpy.types.Operator):
+    bl_idname = "BUILDMAKER_OT_CreateAsset"
+class BUILDMAKER_OT_createAsset(bpy.types.Operator):
+# 2.8x onwards, property
+class MyOperator(bpy.types.Operator):
+    value: IntProperty()
+class ToolProperties(bpy.types.PropertyGroup):
+    commandLineMode: bpy.props.BoolProperty(
+        name = "Command line mode",
+        description = "The option specifies if the addon is used in the command line mode",
+        default = False
+    )
+class ToolProps(bpy.types.PropertyGroup):
+    email : StringProperty(
+        name="email",
+        description="User email",
+        default=""
+    )
+class TOOL_PROPS(bpy.types.PropertyGroup):
+    lon: FloatProperty()
+    lat: FloatProperty()
+class BUILDMAKER_PG_color(PropertyGroup):
+    color: FloatVectorProperty(subtype='COLOR', min=0, max=1, update=updColor, size=4)
+</code>
 ===== common blender api commands =====
@@ Line 542: / Line 575: @@
 **UI**
   * bpy.types.Panel
+    * the panel display order is determined by the order bpy.utils.register_class processes
   * bpy.types.UIList
   * bpy.types.Operator
@@ Line 600: / Line 634: @@
 ...
 layout.template_list(type_name, list_id, ptr, propname, active, rows, maxrows, ..) # a list widget
+</code>
+  * long label solution and auto wrap <code python>
+import bpy
+import textwrap
+long_text = """
+        a long text  long text  long text
+        b test
+        c long text  long text  long text  long text  long text  long
+        d text  long text  long text  long text """
+def get_max_label_width():
+    # Get the 3D View area
+    for area in bpy.context.screen.areas:
+        if area.type == 'VIEW_3D':
+            break
+    # Calculate the width of the panel
+    panel_width = 280 # default value
+    for region in area.regions:
+        if region.type == 'UI':
+            panel_width = region.width
+            return panel_width
+            break
+    # Calculate the maximum width of the label
+    uifontscale = 9 * context.preferences.view.ui_scale
+    max_label_width = int(panel_width // uifontscale)
+    return max_label_width
+def create_long_label(layout, long_text, icon='',indent=''):
+    max_label_width = get_max_label_width()
+    first_icon_line_done = False
+    rest_line_indent = indent
+    if icon == '':
+        first_icon_line_done = True
+        rest_line_indent = ''
+    # Split the text into lines and format each line
+    for line in long_text.splitlines():
+        # Remove leading and trailing whitespace
+        line = line.strip()
+        # Split the line into chunks that fit within the maximum label width
+        for chunk in textwrap.wrap(line, width=max_label_width):
+            if not first_icon_line_done:
+                layout.label(text=chunk, icon=icon)
+                first_icon_line_done = True
+            else:
+                layout.label(text=rest_line_indent+chunk)
+class MyPanel(bpy.types.Panel):
+    bl_idname = "OBJECT_PT_my_panel"
+    bl_label = "My Panel"
+    bl_space_type = "VIEW_3D"
+    bl_region_type = "UI"
+    def draw(self, context):
+        layout = self.layout
+        create_long_label(layout, long_text, "KEYTYPE_JITTER_VEC", '    ')
+# Register the panel
+bpy.utils.register_class(MyPanel)
 </code>
 ===== Blender preference =====