17775105c968b08cf91b01b18255762cb484d395
[blender.git] / release / scripts / startup / bl_ui / space_node.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20 import bpy
21 import nodeitems_utils
22 from bpy.types import Header, Menu, Panel
23 from bpy.app.translations import pgettext_iface as iface_
24 from bpy.app.translations import contexts as i18n_contexts
25 from bl_ui.utils import PresetPanel
26 from .properties_grease_pencil_common import (
27     AnnotationDataPanel,
28     GreasePencilToolsPanel,
29 )
30 from .space_toolsystem_common import (
31     ToolActivePanelHelper,
32 )
33 from .properties_material import (
34     EEVEE_MATERIAL_PT_settings,
35     MATERIAL_PT_viewport
36 )
37 from .properties_world import (
38     WORLD_PT_viewport_display
39 )
40 from .properties_data_light import (
41     DATA_PT_light,
42     DATA_PT_EEVEE_light,
43 )
44
45
46 class NODE_HT_header(Header):
47     bl_space_type = 'NODE_EDITOR'
48
49     def draw(self, context):
50         layout = self.layout
51
52         scene = context.scene
53         snode = context.space_data
54         snode_id = snode.id
55         id_from = snode.id_from
56         tool_settings = context.tool_settings
57
58         layout.template_header()
59
60         # Now expanded via the 'ui_type'
61         # layout.prop(snode, "tree_type", text="")
62
63         if snode.tree_type == 'ShaderNodeTree':
64             layout.prop(snode, "shader_type", text="")
65
66             ob = context.object
67             if snode.shader_type == 'OBJECT' and ob:
68                 ob_type = ob.type
69
70                 NODE_MT_editor_menus.draw_collapsible(context, layout)
71
72                 # No shader nodes for Eevee lights
73                 if snode_id and not (context.engine == 'BLENDER_EEVEE' and ob_type == 'LIGHT'):
74                     row = layout.row()
75                     row.prop(snode_id, "use_nodes")
76
77                 layout.separator_spacer()
78
79                 types_that_support_material = {'MESH', 'CURVE', 'SURFACE', 'FONT', 'META', 'GPENCIL'}
80                 # disable material slot buttons when pinned, cannot find correct slot within id_from (#36589)
81                 # disable also when the selected object does not support materials
82                 has_material_slots = not snode.pin and ob_type in types_that_support_material
83
84                 if ob_type != 'LIGHT':
85                     row = layout.row()
86                     row.enabled = has_material_slots
87                     row.ui_units_x = 4
88                     row.popover(panel="NODE_PT_material_slots")
89
90                 row = layout.row()
91                 row.enabled = has_material_slots
92
93                 # Show material.new when no active ID/slot exists
94                 if not id_from and ob_type in types_that_support_material:
95                     row.template_ID(ob, "active_material", new="material.new")
96                 # Material ID, but not for Lights
97                 if id_from and ob_type != 'LIGHT':
98                     row.template_ID(id_from, "active_material", new="material.new")
99
100             if snode.shader_type == 'WORLD':
101                 NODE_MT_editor_menus.draw_collapsible(context, layout)
102
103                 if snode_id:
104                     row = layout.row()
105                     row.prop(snode_id, "use_nodes")
106
107                 layout.separator_spacer()
108
109                 row = layout.row()
110                 row.enabled = not snode.pin
111                 row.template_ID(scene, "world", new="world.new")
112
113             if snode.shader_type == 'LINESTYLE':
114                 view_layer = context.view_layer
115                 lineset = view_layer.freestyle_settings.linesets.active
116
117                 if lineset is not None:
118                     NODE_MT_editor_menus.draw_collapsible(context, layout)
119
120                     if snode_id:
121                         row = layout.row()
122                         row.prop(snode_id, "use_nodes")
123
124                     layout.separator_spacer()
125
126                     row = layout.row()
127                     row.enabled = not snode.pin
128                     row.template_ID(lineset, "linestyle", new="scene.freestyle_linestyle_new")
129
130         elif snode.tree_type == 'TextureNodeTree':
131             layout.prop(snode, "texture_type", text="")
132
133             NODE_MT_editor_menus.draw_collapsible(context, layout)
134
135             if snode_id:
136                 layout.prop(snode_id, "use_nodes")
137
138             layout.separator_spacer()
139
140             if id_from:
141                 if snode.texture_type == 'BRUSH':
142                     layout.template_ID(id_from, "texture", new="texture.new")
143                 else:
144                     layout.template_ID(id_from, "active_texture", new="texture.new")
145
146         elif snode.tree_type == 'CompositorNodeTree':
147
148             NODE_MT_editor_menus.draw_collapsible(context, layout)
149
150             if snode_id:
151                 layout.prop(snode_id, "use_nodes")
152
153             layout.prop(snode, "use_auto_render")
154             layout.prop(snode, "show_backdrop")
155             if snode.show_backdrop:
156                 row = layout.row(align=True)
157                 row.prop(snode, "backdrop_channels", text="", expand=True)
158
159         else:
160             # Custom node tree is edited as independent ID block
161             NODE_MT_editor_menus.draw_collapsible(context, layout)
162
163             layout.separator_spacer()
164
165             layout.template_ID(snode, "node_tree", new="node.new_node_tree")
166
167         layout.prop(snode, "pin", text="")
168         layout.separator_spacer()
169
170         layout.template_running_jobs()
171
172         layout.operator("node.tree_path_parent", text="", icon='FILE_PARENT')
173
174         # Snap
175         row = layout.row(align=True)
176         row.prop(tool_settings, "use_snap", text="")
177         row.prop(tool_settings, "snap_node_element", icon_only=True)
178         if tool_settings.snap_node_element != 'GRID':
179             row.prop(tool_settings, "snap_target", text="")
180
181
182 class NODE_MT_editor_menus(Menu):
183     bl_idname = "NODE_MT_editor_menus"
184     bl_label = ""
185
186     def draw(self, _context):
187         layout = self.layout
188         layout.menu("NODE_MT_view")
189         layout.menu("NODE_MT_select")
190         layout.menu("NODE_MT_add")
191         layout.menu("NODE_MT_node")
192
193
194 class NODE_MT_add(bpy.types.Menu):
195     bl_space_type = 'NODE_EDITOR'
196     bl_label = "Add"
197     bl_translation_context = i18n_contexts.operator_default
198
199     def draw(self, context):
200         layout = self.layout
201
202         layout.operator_context = 'INVOKE_DEFAULT'
203         props = layout.operator("node.add_search", text="Search...", icon='VIEWZOOM')
204         props.use_transform = True
205
206         layout.separator()
207
208         # actual node submenus are defined by draw functions from node categories
209         nodeitems_utils.draw_node_categories_menu(self, context)
210
211
212 class NODE_MT_view(Menu):
213     bl_label = "View"
214
215     def draw(self, context):
216         layout = self.layout
217
218         snode = context.space_data
219
220         layout.prop(snode, "show_region_toolbar")
221         layout.prop(snode, "show_region_ui")
222
223         layout.separator()
224
225         # Auto-offset nodes (called "insert_offset" in code)
226         layout.prop(snode, "use_insert_offset")
227
228         layout.separator()
229
230         layout.operator("view2d.zoom_in")
231         layout.operator("view2d.zoom_out")
232
233         layout.separator()
234
235         layout.operator("node.view_selected")
236         layout.operator("node.view_all")
237
238         if context.space_data.show_backdrop:
239             layout.separator()
240
241             layout.operator("node.backimage_move", text="Backdrop Move")
242             layout.operator("node.backimage_zoom", text="Backdrop Zoom In").factor = 1.2
243             layout.operator("node.backimage_zoom", text="Backdrop Zoom Out").factor = 1.0 / 1.2
244             layout.operator("node.backimage_fit", text="Fit Backdrop to Available Space")
245
246         layout.separator()
247
248         layout.menu("INFO_MT_area")
249
250
251 class NODE_MT_select(Menu):
252     bl_label = "Select"
253
254     def draw(self, _context):
255         layout = self.layout
256
257         layout.operator("node.select_box").tweak = False
258         layout.operator("node.select_circle")
259
260         layout.separator()
261         layout.operator("node.select_all").action = 'TOGGLE'
262         layout.operator("node.select_all", text="Inverse").action = 'INVERT'
263         layout.operator("node.select_linked_from")
264         layout.operator("node.select_linked_to")
265
266         layout.separator()
267
268         layout.operator("node.select_grouped").extend = False
269         layout.operator("node.select_same_type_step", text="Activate Same Type Previous").prev = True
270         layout.operator("node.select_same_type_step", text="Activate Same Type Next").prev = False
271
272         layout.separator()
273
274         layout.operator("node.find_node")
275
276
277 class NODE_MT_node(Menu):
278     bl_label = "Node"
279
280     def draw(self, _context):
281         layout = self.layout
282
283         layout.operator("transform.translate")
284         layout.operator("transform.rotate")
285         layout.operator("transform.resize")
286
287         layout.separator()
288         layout.operator("node.clipboard_copy", text="Copy")
289         layout.operator("node.clipboard_paste", text="Paste")
290         layout.operator("node.duplicate_move")
291         layout.operator("node.delete")
292         layout.operator("node.delete_reconnect")
293
294         layout.separator()
295
296         layout.operator("node.join", text="Join in New Frame")
297         layout.operator("node.detach", text="Remove from Frame")
298
299         layout.separator()
300
301         layout.operator("node.link_make").replace = False
302         layout.operator("node.link_make", text="Make and Replace Links").replace = True
303         layout.operator("node.links_cut")
304         layout.operator("node.links_detach")
305
306         layout.separator()
307
308         layout.operator("node.group_edit").exit = False
309         layout.operator("node.group_ungroup")
310         layout.operator("node.group_make")
311         layout.operator("node.group_insert")
312
313         layout.separator()
314
315         layout.operator("node.hide_toggle")
316         layout.operator("node.mute_toggle")
317         layout.operator("node.preview_toggle")
318         layout.operator("node.hide_socket_toggle")
319         layout.operator("node.options_toggle")
320         layout.operator("node.collapse_hide_unused_toggle")
321
322         layout.separator()
323
324         layout.operator("node.read_viewlayers")
325
326
327 class NODE_PT_active_tool(ToolActivePanelHelper, Panel):
328     bl_space_type = 'NODE_EDITOR'
329     bl_region_type = 'UI'
330     bl_category = "Tool"
331
332
333 class NODE_PT_material_slots(Panel):
334     bl_space_type = "NODE_EDITOR"
335     bl_region_type = 'HEADER'
336     bl_label = "Slot"
337     bl_ui_units_x = 8
338
339     def draw_header(self, context):
340         ob = context.object
341         self.bl_label = (
342             "Slot " + str(ob.active_material_index + 1) if ob.material_slots else
343             "Slot"
344         )
345
346     # Duplicate part of 'EEVEE_MATERIAL_PT_context_material'.
347     def draw(self, context):
348         layout = self.layout
349         row = layout.row()
350         col = row.column()
351
352         ob = context.object
353         col.template_list("MATERIAL_UL_matslots", "", ob, "material_slots", ob, "active_material_index")
354
355         col = row.column(align=True)
356         col.operator("object.material_slot_add", icon='ADD', text="")
357         col.operator("object.material_slot_remove", icon='REMOVE', text="")
358
359         col.separator()
360
361         col.menu("MATERIAL_MT_context_menu", icon='DOWNARROW_HLT', text="")
362
363         if len(ob.material_slots) > 1:
364             col.separator()
365
366             col.operator("object.material_slot_move", icon='TRIA_UP', text="").direction = 'UP'
367             col.operator("object.material_slot_move", icon='TRIA_DOWN', text="").direction = 'DOWN'
368
369
370 class NODE_PT_node_color_presets(PresetPanel, Panel):
371     """Predefined node color"""
372     bl_label = "Color Presets"
373     preset_subdir = "node_color"
374     preset_operator = "script.execute_preset"
375     preset_add_operator = "node.node_color_preset_add"
376
377
378 class NODE_MT_node_color_context_menu(Menu):
379     bl_label = "Node Color Specials"
380
381     def draw(self, _context):
382         layout = self.layout
383
384         layout.operator("node.node_copy_color", icon='COPY_ID')
385
386
387 class NODE_MT_context_menu(Menu):
388     bl_label = "Node Context Menu"
389
390     def draw(self, context):
391         layout = self.layout
392
393         selected_nodes_len = len(context.selected_nodes)
394
395         # If nothing is selected
396         # (disabled for now until it can be made more useful).
397         '''
398         if selected_nodes_len == 0:
399             layout.operator_context = 'INVOKE_DEFAULT'
400             layout.menu("NODE_MT_add")
401             layout.operator("node.clipboard_paste", text="Paste")
402             return
403         '''
404
405         # If something is selected
406         layout.operator_context = 'INVOKE_DEFAULT'
407         layout.operator("node.duplicate_move")
408         layout.operator("node.delete")
409         layout.operator("node.clipboard_copy", text="Copy")
410         layout.operator("node.clipboard_paste", text="Paste")
411         layout.operator_context = 'EXEC_DEFAULT'
412
413         layout.operator("node.delete_reconnect")
414
415         if selected_nodes_len > 1:
416             layout.separator()
417
418             layout.operator("node.link_make").replace = False
419             layout.operator("node.link_make", text="Make and Replace Links").replace = True
420             layout.operator("node.links_detach")
421
422             layout.separator()
423
424             layout.operator("node.group_make", text="Group")
425
426         layout.operator("node.group_ungroup", text="Ungroup")
427         layout.operator("node.group_edit").exit = False
428
429         layout.separator()
430
431         layout.operator("node.hide_toggle")
432         layout.operator("node.mute_toggle")
433         layout.operator("node.preview_toggle")
434         layout.operator("node.hide_socket_toggle")
435         layout.operator("node.options_toggle")
436         layout.operator("node.collapse_hide_unused_toggle")
437
438
439 class NODE_PT_active_node_generic(Panel):
440     bl_space_type = 'NODE_EDITOR'
441     bl_region_type = 'UI'
442     bl_category = "Item"
443     bl_label = "Node"
444
445     @classmethod
446     def poll(cls, context):
447         return context.active_node is not None
448
449     def draw(self, context):
450         layout = self.layout
451         node = context.active_node
452
453         layout.prop(node, "name", icon='NODE')
454         layout.prop(node, "label", icon='NODE')
455
456
457 class NODE_PT_active_node_color(Panel):
458     bl_space_type = 'NODE_EDITOR'
459     bl_region_type = 'UI'
460     bl_category = "Item"
461     bl_label = "Color"
462     bl_options = {'DEFAULT_CLOSED'}
463     bl_parent_id = 'NODE_PT_active_node_generic'
464
465     @classmethod
466     def poll(cls, context):
467         return context.active_node is not None
468
469     def draw_header(self, context):
470         node = context.active_node
471         self.layout.prop(node, "use_custom_color", text="")
472
473     def draw_header_preset(self, _context):
474         NODE_PT_node_color_presets.draw_panel_header(self.layout)
475
476     def draw(self, context):
477         layout = self.layout
478         node = context.active_node
479
480         layout.enabled = node.use_custom_color
481
482         row = layout.row()
483         row.prop(node, "color", text="")
484         row.menu("NODE_MT_node_color_context_menu", text="", icon='DOWNARROW_HLT')
485
486
487 class NODE_PT_active_node_properties(Panel):
488     bl_space_type = 'NODE_EDITOR'
489     bl_region_type = 'UI'
490     bl_category = "Item"
491     bl_label = "Properties"
492     bl_options = {'DEFAULT_CLOSED'}
493
494     @classmethod
495     def poll(cls, context):
496         return context.active_node is not None
497
498     def draw(self, context):
499         layout = self.layout
500         node = context.active_node
501         # set "node" context pointer for the panel layout
502         layout.context_pointer_set("node", node)
503
504         if hasattr(node, "draw_buttons_ext"):
505             node.draw_buttons_ext(context, layout)
506         elif hasattr(node, "draw_buttons"):
507             node.draw_buttons(context, layout)
508
509         # XXX this could be filtered further to exclude socket types
510         # which don't have meaningful input values (e.g. cycles shader)
511         value_inputs = [socket for socket in node.inputs if socket.enabled and not socket.is_linked]
512         if value_inputs:
513             layout.separator()
514             layout.label(text="Inputs:")
515             for socket in value_inputs:
516                 row = layout.row()
517                 socket.draw(context, row, node, iface_(socket.name, socket.bl_rna.translation_context))
518
519
520 class NODE_PT_texture_mapping(Panel):
521     bl_space_type = 'NODE_EDITOR'
522     bl_region_type = 'UI'
523     bl_category = "Item"
524     bl_label = "Texture Mapping"
525     bl_options = {'DEFAULT_CLOSED'}
526     COMPAT_ENGINES = {'BLENDER_RENDER', 'BLENDER_EEVEE', 'BLENDER_WORKBENCH'}
527
528     @classmethod
529     def poll(cls, context):
530         node = context.active_node
531         return node and hasattr(node, "texture_mapping") and (context.engine in cls.COMPAT_ENGINES)
532
533     def draw(self, context):
534         layout = self.layout
535         layout.use_property_split = True
536         layout.use_property_decorate = False  # No animation.
537
538         node = context.active_node
539         mapping = node.texture_mapping
540
541         layout.prop(mapping, "vector_type")
542
543         layout.separator()
544
545         col = layout.column(align=True)
546         col.prop(mapping, "mapping_x", text="Projection X")
547         col.prop(mapping, "mapping_y", text="Y")
548         col.prop(mapping, "mapping_z", text="Z")
549
550         layout.separator()
551
552         layout.prop(mapping, "translation")
553         layout.prop(mapping, "rotation")
554         layout.prop(mapping, "scale")
555
556
557 # Node Backdrop options
558 class NODE_PT_backdrop(Panel):
559     bl_space_type = 'NODE_EDITOR'
560     bl_region_type = 'UI'
561     bl_category = "View"
562     bl_label = "Backdrop"
563
564     @classmethod
565     def poll(cls, context):
566         snode = context.space_data
567         return snode.tree_type == 'CompositorNodeTree'
568
569     def draw_header(self, context):
570         snode = context.space_data
571         self.layout.prop(snode, "show_backdrop", text="")
572
573     def draw(self, context):
574         layout = self.layout
575         layout.use_property_split = True
576
577         snode = context.space_data
578         layout.active = snode.show_backdrop
579
580         col = layout.column()
581
582         col.prop(snode, "backdrop_channels", text="Channels")
583         col.prop(snode, "backdrop_zoom", text="Zoom")
584
585         col.prop(snode, "backdrop_offset", text="Offset")
586
587         col.separator()
588
589         col.operator("node.backimage_move", text="Move")
590         col.operator("node.backimage_fit", text="Fit")
591
592
593 class NODE_PT_quality(bpy.types.Panel):
594     bl_space_type = 'NODE_EDITOR'
595     bl_region_type = 'UI'
596     bl_category = "Options"
597     bl_label = "Performance"
598
599     @classmethod
600     def poll(cls, context):
601         snode = context.space_data
602         return snode.tree_type == 'CompositorNodeTree' and snode.node_tree is not None
603
604     def draw(self, context):
605         layout = self.layout
606         layout.use_property_split = True
607
608         snode = context.space_data
609         tree = snode.node_tree
610
611         col = layout.column()
612         col.prop(tree, "render_quality", text="Render")
613         col.prop(tree, "edit_quality", text="Edit")
614         col.prop(tree, "chunk_size")
615
616         col = layout.column()
617         col.prop(tree, "use_opencl")
618         col.prop(tree, "use_groupnode_buffer")
619         col.prop(tree, "use_two_pass")
620         col.prop(tree, "use_viewer_border")
621
622
623 class NODE_UL_interface_sockets(bpy.types.UIList):
624     def draw_item(self, context, layout, _data, item, icon, _active_data, _active_propname, _index):
625         socket = item
626         color = socket.draw_color(context)
627
628         if self.layout_type in {'DEFAULT', 'COMPACT'}:
629             row = layout.row(align=True)
630
631             # inputs get icon on the left
632             if not socket.is_output:
633                 row.template_node_socket(color=color)
634
635             row.prop(socket, "name", text="", emboss=False, icon_value=icon)
636
637             # outputs get icon on the right
638             if socket.is_output:
639                 row.template_node_socket(color=color)
640
641         elif self.layout_type == 'GRID':
642             layout.alignment = 'CENTER'
643             layout.template_node_socket(color=color)
644
645
646 # Grease Pencil properties
647 class NODE_PT_grease_pencil(AnnotationDataPanel, Panel):
648     bl_space_type = 'NODE_EDITOR'
649     bl_region_type = 'UI'
650     bl_category = "View"
651     bl_options = {'DEFAULT_CLOSED'}
652
653     # NOTE: this is just a wrapper around the generic GP Panel
654
655     @classmethod
656     def poll(cls, context):
657         snode = context.space_data
658         return snode is not None and snode.node_tree is not None
659
660
661 class NODE_PT_grease_pencil_tools(GreasePencilToolsPanel, Panel):
662     bl_space_type = 'NODE_EDITOR'
663     bl_region_type = 'UI'
664     bl_category = "View"
665     bl_options = {'DEFAULT_CLOSED'}
666
667     # NOTE: this is just a wrapper around the generic GP tools panel
668     # It contains access to some essential tools usually found only in
669     # toolbar, but which may not necessarily be open
670
671
672 def node_draw_tree_view(_layout, _context):
673     pass
674
675
676 # Adapt properties editor panel to display in node editor. We have to
677 # copy the class rather than inherit due to the way bpy registration works.
678 def node_panel(cls):
679     node_cls = type('NODE_' + cls.__name__, cls.__bases__, dict(cls.__dict__))
680
681     node_cls.bl_space_type = 'NODE_EDITOR'
682     node_cls.bl_region_type = 'UI'
683     node_cls.bl_category = "Options"
684     if hasattr(node_cls, 'bl_parent_id'):
685         node_cls.bl_parent_id = 'NODE_' + node_cls.bl_parent_id
686
687     return node_cls
688
689
690 classes = (
691     NODE_HT_header,
692     NODE_MT_editor_menus,
693     NODE_MT_add,
694     NODE_MT_view,
695     NODE_MT_select,
696     NODE_MT_node,
697     NODE_MT_node_color_context_menu,
698     NODE_MT_context_menu,
699     NODE_PT_material_slots,
700     NODE_PT_node_color_presets,
701     NODE_PT_active_node_generic,
702     NODE_PT_active_node_color,
703     NODE_PT_active_node_properties,
704     NODE_PT_texture_mapping,
705     NODE_PT_active_tool,
706     NODE_PT_backdrop,
707     NODE_PT_quality,
708     NODE_PT_grease_pencil,
709     NODE_PT_grease_pencil_tools,
710     NODE_UL_interface_sockets,
711
712     node_panel(EEVEE_MATERIAL_PT_settings),
713     node_panel(MATERIAL_PT_viewport),
714     node_panel(WORLD_PT_viewport_display),
715     node_panel(DATA_PT_light),
716     node_panel(DATA_PT_EEVEE_light),
717 )
718
719
720 if __name__ == "__main__":  # only for live edit.
721     from bpy.utils import register_class
722     for cls in classes:
723         register_class(cls)