Workspace: Move engines to workspace and Properties Editor cleanup
[blender.git] / release / scripts / templates_py / ui_list_simple.py
1 import bpy
2
3
4 class MATERIAL_UL_matslots_example(bpy.types.UIList):
5     # The draw_item function is called for each item of the collection that is visible in the list.
6     #   data is the RNA object containing the collection,
7     #   item is the current drawn item of the collection,
8     #   icon is the "computed" icon for the item (as an integer, because some objects like materials or textures
9     #   have custom icons ID, which are not available as enum items).
10     #   active_data is the RNA object containing the active property for the collection (i.e. integer pointing to the
11     #   active item of the collection).
12     #   active_propname is the name of the active property (use 'getattr(active_data, active_propname)').
13     #   index is index of the current item in the collection.
14     #   flt_flag is the result of the filtering process for this item.
15     #   Note: as index and flt_flag are optional arguments, you do not have to use/declare them here if you don't
16     #         need them.
17     def draw_item(self, context, layout, data, item, icon, active_data, active_propname):
18         ob = data
19         slot = item
20         ma = slot.material
21         # draw_item must handle the three layout types... Usually 'DEFAULT' and 'COMPACT' can share the same code.
22         if self.layout_type in {'DEFAULT', 'COMPACT'}:
23             # You should always start your row layout by a label (icon + text), or a non-embossed text field,
24             # this will also make the row easily selectable in the list! The later also enables ctrl-click rename.
25             # We use icon_value of label, as our given icon is an integer value, not an enum ID.
26             # Note "data" names should never be translated!
27             if ma:
28                 layout.prop(ma, "name", text="", emboss=False, icon_value=icon)
29             else:
30                 layout.label(text="", translate=False, icon_value=icon)
31             # And now we can add other UI stuff...
32             # Here, we add nodes info if this material uses (old!) shading nodes.
33             if ma and not context.scene.render.use_shading_nodes:
34                 manode = ma.active_node_material
35                 if manode:
36                     # The static method UILayout.icon returns the integer value of the icon ID "computed" for the given
37                     # RNA object.
38                     layout.label(text="Node %s" % manode.name, translate=False, icon_value=layout.icon(manode))
39                 elif ma.use_nodes:
40                     layout.label(text="Node <none>", translate=False)
41                 else:
42                     layout.label(text="")
43         # 'GRID' layout type should be as compact as possible (typically a single icon!).
44         elif self.layout_type in {'GRID'}:
45             layout.alignment = 'CENTER'
46             layout.label(text="", icon_value=icon)
47
48
49 # And now we can use this list everywhere in Blender. Here is a small example panel.
50 class UIListPanelExample(bpy.types.Panel):
51     """Creates a Panel in the Object properties window"""
52     bl_label = "UIList Panel"
53     bl_idname = "OBJECT_PT_ui_list_example"
54     bl_space_type = 'PROPERTIES'
55     bl_region_type = 'WINDOW'
56     bl_context = "object"
57
58     def draw(self, context):
59         layout = self.layout
60
61         obj = context.object
62
63         # template_list now takes two new args.
64         # The first one is the identifier of the registered UIList to use (if you want only the default list,
65         # with no custom draw code, use "UI_UL_list").
66         layout.template_list("MATERIAL_UL_matslots_example", "", obj, "material_slots", obj, "active_material_index")
67
68         # The second one can usually be left as an empty string. It's an additional ID used to distinguish lists in case you
69         # use the same list several times in a given area.
70         layout.template_list("MATERIAL_UL_matslots_example", "compact", obj, "material_slots",
71                              obj, "active_material_index", type='COMPACT')
72
73
74 def register():
75     bpy.utils.register_class(MATERIAL_UL_matslots_example)
76     bpy.utils.register_class(UIListPanelExample)
77
78
79 def unregister():
80     bpy.utils.unregister_class(MATERIAL_UL_matslots_example)
81     bpy.utils.unregister_class(UIListPanelExample)
82
83
84 if __name__ == "__main__":
85     register()