Cycles: internal changes that should have no effect on user level yet, added
[blender.git] / intern / cycles / blender / addon / ui.py
1 #
2 # Copyright 2011, Blender Foundation.
3 #
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software Foundation,
16 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 #
18
19 import bpy
20
21 from bpy.types import Panel, Menu
22
23 from cycles import enums
24 from cycles import engine
25
26 class CYCLES_MT_integrator_presets(Menu):
27     bl_label = "Integrator Presets"
28     preset_subdir = "cycles/integrator"
29     preset_operator = "script.execute_preset"
30     COMPAT_ENGINES = {'CYCLES'}
31     draw = Menu.draw_preset
32
33 class CyclesButtonsPanel():
34     bl_space_type = "PROPERTIES"
35     bl_region_type = "WINDOW"
36     bl_context = "render"
37     
38     @classmethod
39     def poll(cls, context):
40         rd = context.scene.render
41         return rd.engine == 'CYCLES'
42
43 class CyclesRender_PT_integrator(CyclesButtonsPanel, Panel):
44     bl_label = "Integrator"
45     bl_options = {'DEFAULT_CLOSED'}
46
47     def draw(self, context):
48         layout = self.layout
49
50         scene = context.scene
51         cscene = scene.cycles
52         
53         row = layout.row(align=True)
54         row.menu("CYCLES_MT_integrator_presets", text=bpy.types.CYCLES_MT_integrator_presets.bl_label)
55         row.operator("render.cycles_integrator_preset_add", text="", icon="ZOOMIN")
56         row.operator("render.cycles_integrator_preset_add", text="", icon="ZOOMOUT").remove_active = True
57
58         split = layout.split()
59
60         col = split.column()
61         sub = col.column(align=True)
62         sub.label(text="Samples:")
63         sub.prop(cscene, "samples", text="Render")
64         sub.prop(cscene, "preview_samples", text="Preview")
65
66         sub = col.column(align=True)
67         sub.label("Tranparency:")
68         sub.prop(cscene, "transparent_max_bounces", text="Max")
69         sub.prop(cscene, "transparent_min_bounces", text="Min")
70         sub.prop(cscene, "no_caustics")
71
72         col = split.column()
73
74         sub = col.column(align=True)
75         sub.label(text="Bounces:")
76         sub.prop(cscene, "max_bounces", text="Max")
77         sub.prop(cscene, "min_bounces", text="Min")
78
79         sub = col.column(align=True)
80         sub.label(text="Light Paths:")
81         sub.prop(cscene, "diffuse_bounces", text="Diffuse")
82         sub.prop(cscene, "glossy_bounces", text="Glossy")
83         sub.prop(cscene, "transmission_bounces", text="Transmission")
84
85         #row = col.row()
86         #row.prop(cscene, "blur_caustics")
87         #row.active = not cscene.no_caustics
88         
89 class CyclesRender_PT_film(CyclesButtonsPanel, Panel):
90     bl_label = "Film"
91
92     def draw(self, context):
93         layout = self.layout
94
95         scene = context.scene
96         cscene = scene.cycles
97
98         split = layout.split()
99
100         col = split.column();
101         col.prop(cscene, "film_exposure")
102         col.prop(cscene, "film_transparent")
103
104         col = split.column()
105         sub = col.column(align=True)
106         sub.prop(cscene, "filter_type", text="")
107         if cscene.filter_type != 'BOX':
108             sub.prop(cscene, "filter_width", text="Width")
109
110 class CyclesRender_PT_performance(CyclesButtonsPanel, Panel):
111     bl_label = "Performance"
112     bl_options = {'DEFAULT_CLOSED'}
113
114     def draw(self, context):
115         layout = self.layout
116
117         scene = context.scene
118         rd = scene.render
119         cscene = scene.cycles
120
121         split = layout.split()
122
123         col = split.column(align=True)
124
125         col.label(text="Threads:")
126         col.row().prop(rd, "threads_mode", expand=True)
127         sub = col.column()
128         sub.enabled = rd.threads_mode == 'FIXED'
129         sub.prop(rd, "threads")
130
131         sub = col.column(align=True)
132         sub.label(text="Tiles:")
133         sub.prop(cscene, "debug_tile_size")
134         sub.prop(cscene, "debug_min_size")
135
136         col = split.column()
137
138         sub = col.column(align=True)
139         sub.label(text="Acceleration structure:")
140         sub.prop(cscene, "debug_bvh_type", text="")
141         sub.prop(cscene, "debug_use_spatial_splits")
142
143 class CyclesRender_PT_layers(CyclesButtonsPanel, Panel):
144     bl_label = "Layers"
145     bl_options = {'DEFAULT_CLOSED'}
146     COMPAT_ENGINES = {'BLENDER_RENDER'}
147
148     def draw(self, context):
149         layout = self.layout
150
151         scene = context.scene
152         rd = scene.render
153
154         # row = layout.row()
155         # row.template_list(rd, "layers", rd.layers, "active_index", rows=2)
156
157         # col = row.column(align=True)
158         # col.operator("scene.render_layer_add", icon='ZOOMIN', text="")
159         # col.operator("scene.render_layer_remove", icon='ZOOMOUT', text="")
160
161         row = layout.row()
162         # rl = rd.layers.active
163         rl = rd.layers[0]
164         row.prop(rl, "name")
165         #row.prop(rd, "use_single_layer", text="", icon_only=True)
166
167         split = layout.split()
168
169         col = split.column()
170         col.prop(scene, "layers", text="Scene")
171
172         col = split.column()
173         col.prop(rl, "layers", text="Layer")
174
175         layout.separator()
176
177         layout.prop(rl, "material_override", text="Material")
178
179 class Cycles_PT_post_processing(CyclesButtonsPanel, Panel):
180     bl_label = "Post Processing"
181     bl_options = {'DEFAULT_CLOSED'}
182
183     def draw(self, context):
184         layout = self.layout
185
186         rd = context.scene.render
187
188         split = layout.split()
189
190         col = split.column()
191         col.prop(rd, "use_compositing")
192         col.prop(rd, "use_sequencer")
193
194         col = split.column()
195         col.prop(rd, "dither_intensity", text="Dither", slider=True)
196
197 class CyclesCamera_PT_dof(CyclesButtonsPanel, Panel):
198     bl_label = "Depth of Field"
199     bl_context = "data"
200
201     @classmethod
202     def poll(cls, context):
203         return context.camera and CyclesButtonsPanel.poll(context)
204
205     def draw(self, context):
206         layout = self.layout
207
208         cam = context.camera
209         ccam = cam.cycles
210
211         split = layout.split()
212
213         col = split.column()
214         col.label("Focus:")
215         col.prop(cam, "dof_object", text="")
216
217         sub = col.row()
218         sub.active = cam.dof_object is None
219         sub.prop(cam, "dof_distance", text="Distance")
220
221         col = split.column()
222
223         col.label("Aperture:")
224         col.prop(ccam, "aperture_size", text="Size")
225
226         sub = col.column(align=True)
227         sub.prop(ccam, "aperture_blades", text="Blades")
228         sub.prop(ccam, "aperture_rotation", text="Rotation")
229
230 class Cycles_PT_context_material(CyclesButtonsPanel, Panel):
231     bl_label = "Surface"
232     bl_context = "material"
233     bl_options = {'HIDE_HEADER'}
234
235     @classmethod
236     def poll(cls, context):
237         return (context.material or context.object) and CyclesButtonsPanel.poll(context)
238
239     def draw(self, context):
240         layout = self.layout
241
242         mat = context.material
243         ob = context.object
244         slot = context.material_slot
245         space = context.space_data
246
247         if ob:
248             row = layout.row()
249
250             row.template_list(ob, "material_slots", ob, "active_material_index", rows=2)
251
252             col = row.column(align=True)
253             col.operator("object.material_slot_add", icon='ZOOMIN', text="")
254             col.operator("object.material_slot_remove", icon='ZOOMOUT', text="")
255
256             col.menu("MATERIAL_MT_specials", icon='DOWNARROW_HLT', text="")
257
258             if ob.mode == 'EDIT':
259                 row = layout.row(align=True)
260                 row.operator("object.material_slot_assign", text="Assign")
261                 row.operator("object.material_slot_select", text="Select")
262                 row.operator("object.material_slot_deselect", text="Deselect")
263
264         split = layout.split(percentage=0.65)
265
266         if ob:
267             split.template_ID(ob, "active_material", new="material.new")
268             row = split.row()
269
270             if slot:
271                 row.prop(slot, "link", text="")
272             else:
273                 row.label()
274         elif mat:
275             split.template_ID(space, "pin_id")
276             split.separator()
277
278 class Cycles_PT_mesh_displacement(CyclesButtonsPanel, Panel):
279     bl_label = "Displacement"
280     bl_context = "data"
281
282     @classmethod
283     def poll(cls, context):
284         return context.mesh or context.curve or context.meta_ball
285
286     def draw(self, context):
287         layout = self.layout
288
289         mesh = context.mesh
290         curve = context.curve
291         mball = context.meta_ball
292
293         if mesh:
294             cdata = mesh.cycles
295         elif curve:
296             cdata = curve.cycles
297         elif mball:
298             cdata = mball.cycles
299
300         layout.prop(cdata, "displacement_method", text="Method")
301         layout.prop(cdata, "use_subdivision");
302         layout.prop(cdata, "dicing_rate");
303
304 class CyclesObject_PT_ray_visibility(CyclesButtonsPanel, Panel):
305     bl_label = "Ray Visibility"
306     bl_context = "object"
307     bl_options = {'DEFAULT_CLOSED'}
308
309     @classmethod
310     def poll(cls, context):
311         ob = context.object
312         return ob and ob.type in ('MESH', 'CURVE', 'CURVE', 'SURFACE', 'FONT', 'META') # todo: 'LAMP'
313
314     def draw(self, context):
315         layout = self.layout
316
317         ob = context.object
318         visibility = ob.cycles_visibility
319
320         split = layout.split()
321
322         col = split.column()
323         col.prop(visibility, "camera")
324         col.prop(visibility, "diffuse")
325         col.prop(visibility, "glossy")
326
327         col = split.column()
328         col.prop(visibility, "transmission")
329         col.prop(visibility, "shadow")
330
331 def find_node(material, nodetype):
332     if material and material.node_tree:
333         ntree = material.node_tree
334
335         for node in ntree.nodes:
336             if hasattr(node, 'type') and node.type == nodetype:
337                 return node
338     
339     return None
340
341 def find_node_input(node, name):
342     for input in node.inputs:
343         if input.name == name:
344             return input
345     
346     return None
347
348 def panel_node_draw(layout, id, output_type, input_name):
349     if not id.node_tree:
350         layout.prop(id, "use_nodes")
351         return
352
353     ntree = id.node_tree
354
355     node = find_node(id, output_type)
356     if not node:
357         layout.label(text="No output node.")
358     else:
359         input = find_node_input(node, input_name)
360         layout.template_node_view(ntree, node, input);
361
362 class CyclesLamp_PT_lamp(CyclesButtonsPanel, Panel):
363     bl_label = "Lamp"
364     bl_context = "data"
365     bl_options = {'DEFAULT_CLOSED'}
366
367     @classmethod
368     def poll(cls, context):
369         return False
370         #return context.lamp and CyclesButtonsPanel.poll(context)
371
372     def draw(self, context):
373         layout = self.layout
374
375         lamp = context.lamp
376         clamp = lamp.cycles
377
378         layout.prop(lamp, "type", expand=True)
379
380         split = layout.split()
381         col = split.column(align=True)
382
383         if lamp.type in ('POINT', 'SUN', 'SPOT'):
384             col.prop(lamp, "shadow_soft_size", text="Size")
385         elif lamp.type == 'AREA':
386             col.prop(lamp, "shape", text="")
387             sub = col.column(align=True)
388
389             if lamp.shape == 'SQUARE':
390                 sub.prop(lamp, "size")
391             elif lamp.shape == 'RECTANGLE':
392                 sub.prop(lamp, "size", text="Size X")
393                 sub.prop(lamp, "size_y", text="Size Y")
394
395         col = split.column()
396         col.prop(clamp, "cast_shadow")
397
398         if lamp.type == 'SPOT':
399             layout.label(text="Not supported, interpreted as point lamp.")
400         elif lamp.type == 'HEMI':
401             layout.label(text="Not supported, interpreted as sun lamp.")
402    
403 class CyclesLamp_PT_nodes(CyclesButtonsPanel, Panel):
404     bl_label = "Nodes"
405     bl_context = "data"
406
407     @classmethod
408     def poll(cls, context):
409         return context.lamp and CyclesButtonsPanel.poll(context)
410
411     def draw(self, context):
412         layout = self.layout
413
414         mat = context.lamp
415         panel_node_draw(layout, mat, 'OUTPUT_LAMP', 'Surface')
416
417 class CyclesWorld_PT_surface(CyclesButtonsPanel, Panel):
418     bl_label = "Surface"
419     bl_context = "world"
420
421     @classmethod
422     def poll(cls, context):
423         return context.world and CyclesButtonsPanel.poll(context)
424
425     def draw(self, context):
426         layout = self.layout
427
428         mat = context.world
429         panel_node_draw(layout, mat, 'OUTPUT_WORLD', 'Surface')
430
431 class CyclesWorld_PT_volume(CyclesButtonsPanel, Panel):
432     bl_label = "Volume"
433     bl_context = "world"
434
435     @classmethod
436     def poll(cls, context):
437         return context.world and CyclesButtonsPanel.poll(context)
438
439     def draw(self, context):
440         layout = self.layout
441         layout.active = False
442
443         world = context.world
444         panel_node_draw(layout, world, 'OUTPUT_WORLD', 'Volume')
445
446 class CyclesMaterial_PT_surface(CyclesButtonsPanel, Panel):
447     bl_label = "Surface"
448     bl_context = "material"
449
450     @classmethod
451     def poll(cls, context):
452         return context.material and CyclesButtonsPanel.poll(context)
453
454     def draw(self, context):
455         layout = self.layout
456
457         mat = context.material
458         panel_node_draw(layout, mat, 'OUTPUT_MATERIAL', 'Surface')
459
460 class CyclesMaterial_PT_volume(CyclesButtonsPanel, Panel):
461     bl_label = "Volume"
462     bl_context = "material"
463
464     @classmethod
465     def poll(cls, context):
466         return context.material and CyclesButtonsPanel.poll(context)
467
468     def draw(self, context):
469         layout = self.layout
470         layout.active = False
471
472         mat = context.material
473         cmat = mat.cycles
474
475         panel_node_draw(layout, mat, 'OUTPUT_MATERIAL', 'Volume')
476
477         layout.prop(cmat, "homogeneous_volume")
478
479 class CyclesMaterial_PT_displacement(CyclesButtonsPanel, Panel):
480     bl_label = "Displacement"
481     bl_context = "material"
482
483     @classmethod
484     def poll(cls, context):
485         return context.material and CyclesButtonsPanel.poll(context)
486
487     def draw(self, context):
488         layout = self.layout
489
490         mat = context.material
491         panel_node_draw(layout, mat, 'OUTPUT_MATERIAL', 'Displacement')
492
493 class CyclesMaterial_PT_settings(CyclesButtonsPanel, Panel):
494     bl_label = "Settings"
495     bl_context = "material"
496     bl_options = {'DEFAULT_CLOSED'}
497
498     @classmethod
499     def poll(cls, context):
500         return False
501         #return context.material and CyclesButtonsPanel.poll(context)
502
503     def draw(self, context):
504         layout = self.layout
505
506         mat = context.material
507         cmat = mat.cycles
508
509         split = layout.split()
510     
511         col = split.column()
512         col.prop(cmat, "sample_as_light")
513
514         col = split.column()
515         col.prop(cmat, "homogeneous_volume")
516
517 class CyclesTexture_PT_context(CyclesButtonsPanel, Panel):
518     bl_label = ""
519     bl_context = "texture"
520     bl_options = {'HIDE_HEADER'}
521     COMPAT_ENGINES = {'CYCLES'}
522
523     def draw(self, context):
524         layout = self.layout
525
526         tex = context.texture
527         space = context.space_data
528         pin_id = space.pin_id
529         use_pin_id = space.use_pin_id;
530         user = context.texture_user
531         node = context.texture_node
532
533         if not use_pin_id or not isinstance(pin_id, bpy.types.Texture):
534             pin_id = None
535
536         if not pin_id:
537             layout.template_texture_user()
538
539         if user:
540             layout.separator()
541
542             split = layout.split(percentage=0.65)
543             col = split.column()
544
545             if pin_id:
546                 col.template_ID(space, "pin_id")
547             elif user:
548                 col.template_ID(user, "texture", new="texture.new")
549             
550             if tex:
551                 row = split.row()
552                 row.prop(tex, "use_nodes", icon="NODETREE", text="")
553                 row.label()
554
555                 if not tex.use_nodes:
556                     split = layout.split(percentage=0.2)
557                     split.label(text="Type:")
558                     split.prop(tex, "type", text="")
559
560 class CyclesTexture_PT_nodes(CyclesButtonsPanel, Panel):
561     bl_label = "Nodes"
562     bl_context = "texture"
563
564     @classmethod
565     def poll(cls, context):
566         tex = context.texture
567         return (tex and tex.use_nodes) and CyclesButtonsPanel.poll(context)
568
569     def draw(self, context):
570         layout = self.layout
571
572         tex = context.texture
573         panel_node_draw(layout, tex, 'OUTPUT_TEXTURE', 'Color')
574
575 class CyclesTexture_PT_node(CyclesButtonsPanel, Panel):
576     bl_label = "Node"
577     bl_context = "texture"
578
579     @classmethod
580     def poll(cls, context):
581         node = context.texture_node
582         return node and CyclesButtonsPanel.poll(context)
583
584     def draw(self, context):
585         layout = self.layout
586
587         node = context.texture_node
588         ntree = node.id_data
589         layout.template_node_view(ntree, node, None)
590
591 class CyclesTexture_PT_mapping(CyclesButtonsPanel, Panel):
592     bl_label = "Mapping"
593     bl_context = "texture"
594
595     @classmethod
596     def poll(cls, context):
597         tex = context.texture
598         node = context.texture_node
599         return (node or (tex and tex.use_nodes)) and CyclesButtonsPanel.poll(context)
600
601     def draw(self, context):
602         layout = self.layout
603         layout.label("Texture coordinate mapping goes here.");
604         layout.label("Translate, rotate, scale, projection, XYZ.")
605
606 class CyclesTexture_PT_color(CyclesButtonsPanel, Panel):
607     bl_label = "Color"
608     bl_context = "texture"
609
610     @classmethod
611     def poll(cls, context):
612         tex = context.texture
613         node = context.texture_node
614         return (node or (tex and tex.use_nodes)) and CyclesButtonsPanel.poll(context)
615
616     def draw(self, context):
617         layout = self.layout
618         layout.label("Color modification options go here.");
619         layout.label("Ramp, brightness, contrast, saturation.")
620
621 def draw_device(self, context):
622     scene = context.scene
623     layout = self.layout
624
625     if scene.render.engine == "CYCLES":
626         cscene = scene.cycles
627
628         available_devices = engine.available_devices()
629         available_cuda = 'cuda' in available_devices
630         available_opencl = 'opencl' in available_devices
631
632         if available_cuda or available_opencl:
633             layout.prop(cscene, "device")
634             if cscene.device == 'GPU' and available_cuda and available_opencl:
635                 layout.prop(cscene, "gpu_type")
636         if cscene.device == 'CPU' and engine.with_osl():
637             layout.prop(cscene, "shading_system")
638
639 def draw_pause(self, context):
640     layout = self.layout
641     scene = context.scene
642
643     if scene.render.engine == "CYCLES":
644         view = context.space_data
645
646         if view.viewport_shade == "RENDERED":
647             cscene = scene.cycles
648             layout.prop(cscene, "preview_pause", icon="PAUSE", text="")
649
650 def get_panels():
651     return [
652         bpy.types.RENDER_PT_render,
653         bpy.types.RENDER_PT_output,
654         bpy.types.RENDER_PT_encoding,
655         bpy.types.RENDER_PT_dimensions,
656         bpy.types.RENDER_PT_stamp,
657         bpy.types.WORLD_PT_context_world,
658         bpy.types.DATA_PT_context_mesh,
659         bpy.types.DATA_PT_context_camera,
660         bpy.types.DATA_PT_context_lamp,
661         bpy.types.DATA_PT_texture_space,
662         bpy.types.DATA_PT_curve_texture_space,
663         bpy.types.DATA_PT_mball_texture_space,
664         bpy.types.DATA_PT_vertex_groups,
665         bpy.types.DATA_PT_shape_keys,
666         bpy.types.DATA_PT_uv_texture,
667         bpy.types.DATA_PT_vertex_colors,
668         bpy.types.DATA_PT_camera,
669         bpy.types.DATA_PT_camera_display,
670         bpy.types.DATA_PT_custom_props_mesh,
671         bpy.types.DATA_PT_custom_props_camera,
672         bpy.types.DATA_PT_custom_props_lamp,
673         bpy.types.TEXTURE_PT_clouds,
674         bpy.types.TEXTURE_PT_wood,
675         bpy.types.TEXTURE_PT_marble,
676         bpy.types.TEXTURE_PT_magic,
677         bpy.types.TEXTURE_PT_blend,
678         bpy.types.TEXTURE_PT_stucci,
679         bpy.types.TEXTURE_PT_image,
680         bpy.types.TEXTURE_PT_image_sampling,
681         bpy.types.TEXTURE_PT_image_mapping,
682         bpy.types.TEXTURE_PT_musgrave,
683         bpy.types.TEXTURE_PT_voronoi,
684         bpy.types.TEXTURE_PT_distortednoise,
685         bpy.types.TEXTURE_PT_voxeldata,
686         bpy.types.TEXTURE_PT_pointdensity,
687         bpy.types.TEXTURE_PT_pointdensity_turbulence]
688
689 def register():
690     bpy.types.RENDER_PT_render.append(draw_device)
691     bpy.types.VIEW3D_HT_header.append(draw_pause)
692
693     for panel in get_panels():
694         panel.COMPAT_ENGINES.add('CYCLES')
695     
696 def unregister():
697     bpy.types.RENDER_PT_render.remove(draw_device)
698     bpy.types.VIEW3D_HT_header.remove(draw_pause)
699
700     for panel in get_panels():
701         panel.COMPAT_ENGINES.remove('CYCLES')
702