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