Adding some example for new UIList...
[blender.git] / release / scripts / templates_py / ui_list.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     def draw_item(self, context, layout, data, item, icon, active_data, active_propname, index):
15         ob = data
16         slot = item
17         ma = slot.material
18         # draw_item must handle the three layout types... Usually 'DEFAULT' and 'COMPACT' can share the same code.
19         if self.layout_type in {'DEFAULT', 'COMPACT'}:
20             # You should always start your row layout by a label (icon + text), this will also make the row easily
21             # selectable in the list!
22             # We use icon_value of label, as our given icon is an integer value, not an enum ID.
23             layout.label(ma.name if ma else "", icon_value=icon)
24             # And now we can add other UI stuff...
25             # Here, we add nodes info if this material uses (old!) shading nodes.
26             if ma and not context.scene.render.use_shading_nodes:
27                 manode = ma.active_node_material
28                 if manode:
29                     # The static method UILayout.icon returns the integer value of the icon ID "computed" for the given
30                     # RNA object.
31                     layout.label("Node %s" % manode.name, icon_value=layout.icon(manode))
32                 elif ma.use_nodes:
33                     layout.label("Node <none>")
34                 else:
35                     layout.label("")
36         # 'GRID' layout type should be as compact as possible (typically a single icon!).
37         elif self.layout_type in {'GRID'}:
38             layout.alignment = 'CENTER'
39             layout.label("", icon_value=icon)
40
41
42 # And now we can use this list everywhere in Blender. Here is a small example panel.
43 class UIListPanelExample(bpy.types.Panel):
44     """Creates a Panel in the Object properties window"""
45     bl_label = "UIList Panel"
46     bl_idname = "OBJECT_PT_ui_list_example"
47     bl_space_type = 'PROPERTIES'
48     bl_region_type = 'WINDOW'
49     bl_context = "object"
50
51     def draw(self, context):
52         layout = self.layout
53
54         obj = context.object
55
56         # template_list now takes two new args.
57         # The first one is the identifier of the registered UIList to use (if you want only the default list,
58         # with no custom draw code, use "UI_UL_list").
59         layout.template_list("MATERIAL_UL_matslots_example", "", obj, "material_slots", obj, "active_material_index")
60
61         # The second one can usually be left as an empty string. It's an additional ID used to distinguish lists in case you
62         # use the same list several times in a given area.
63         layout.template_list("MATERIAL_UL_matslots_example", "compact", obj, "material_slots",
64                              obj, "active_material_index", type='COMPACT')
65
66
67 def register():
68     bpy.utils.register_class(MATERIAL_UL_matslots_example)
69     bpy.utils.register_class(UIListPanelExample)
70
71
72 def unregister():
73     bpy.utils.unregister_class(MATERIAL_UL_matslots_example)
74     bpy.utils.unregister_class(UIListPanelExample)
75
76
77 if __name__ == "__main__":
78     register()