Cycles: svn merge -r41467:41531 ^/trunk/blender
[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         sub.prop(cscene, "seed")
66
67         sub = col.column(align=True)
68         sub.label("Transparency:")
69         sub.prop(cscene, "transparent_max_bounces", text="Max")
70         sub.prop(cscene, "transparent_min_bounces", text="Min")
71         sub.prop(cscene, "use_transparent_shadows", text="Shadows")
72
73         col = split.column()
74
75         sub = col.column(align=True)
76         sub.label(text="Bounces:")
77         sub.prop(cscene, "max_bounces", text="Max")
78         sub.prop(cscene, "min_bounces", text="Min")
79
80         sub = col.column(align=True)
81         sub.label(text="Light Paths:")
82         sub.prop(cscene, "diffuse_bounces", text="Diffuse")
83         sub.prop(cscene, "glossy_bounces", text="Glossy")
84         sub.prop(cscene, "transmission_bounces", text="Transmission")
85         sub.prop(cscene, "no_caustics")
86
87         #row = col.row()
88         #row.prop(cscene, "blur_caustics")
89         #row.active = not cscene.no_caustics
90         
91 class CyclesRender_PT_film(CyclesButtonsPanel, Panel):
92     bl_label = "Film"
93
94     def draw(self, context):
95         layout = self.layout
96
97         scene = context.scene
98         cscene = scene.cycles
99
100         split = layout.split()
101
102         col = split.column();
103         col.prop(cscene, "film_exposure")
104         col.prop(cscene, "film_transparent")
105
106         col = split.column()
107         sub = col.column(align=True)
108         sub.prop(cscene, "filter_type", text="")
109         if cscene.filter_type != 'BOX':
110             sub.prop(cscene, "filter_width", text="Width")
111
112 class CyclesRender_PT_performance(CyclesButtonsPanel, Panel):
113     bl_label = "Performance"
114     bl_options = {'DEFAULT_CLOSED'}
115
116     def draw(self, context):
117         layout = self.layout
118
119         scene = context.scene
120         rd = scene.render
121         cscene = scene.cycles
122
123         split = layout.split()
124
125         col = split.column(align=True)
126
127         col.label(text="Threads:")
128         col.row().prop(rd, "threads_mode", expand=True)
129         sub = col.column()
130         sub.enabled = rd.threads_mode == 'FIXED'
131         sub.prop(rd, "threads")
132
133         sub = col.column(align=True)
134         sub.label(text="Tiles:")
135         sub.prop(cscene, "debug_tile_size")
136         sub.prop(cscene, "debug_min_size")
137
138         col = split.column()
139
140         sub = col.column(align=True)
141         sub.label(text="Acceleration structure:")
142         sub.prop(cscene, "debug_bvh_type", text="")
143         sub.prop(cscene, "debug_use_spatial_splits")
144
145 class CyclesRender_PT_layers(CyclesButtonsPanel, Panel):
146     bl_label = "Layers"
147     bl_options = {'DEFAULT_CLOSED'}
148     COMPAT_ENGINES = {'BLENDER_RENDER'}
149
150     def draw(self, context):
151         layout = self.layout
152
153         scene = context.scene
154         rd = scene.render
155
156         # row = layout.row()
157         # row.template_list(rd, "layers", rd.layers, "active_index", rows=2)
158
159         # col = row.column(align=True)
160         # col.operator("scene.render_layer_add", icon='ZOOMIN', text="")
161         # col.operator("scene.render_layer_remove", icon='ZOOMOUT', text="")
162
163         row = layout.row()
164         # rl = rd.layers.active
165         rl = rd.layers[0]
166         row.prop(rl, "name")
167         #row.prop(rd, "use_single_layer", text="", icon_only=True)
168
169         split = layout.split()
170
171         col = split.column()
172         col.prop(scene, "layers", text="Scene")
173
174         col = split.column()
175         col.prop(rl, "layers", text="Layer")
176
177         layout.separator()
178
179         layout.prop(rl, "material_override", text="Material")
180
181 class Cycles_PT_post_processing(CyclesButtonsPanel, Panel):
182     bl_label = "Post Processing"
183     bl_options = {'DEFAULT_CLOSED'}
184
185     def draw(self, context):
186         layout = self.layout
187
188         rd = context.scene.render
189
190         split = layout.split()
191
192         col = split.column()
193         col.prop(rd, "use_compositing")
194         col.prop(rd, "use_sequencer")
195
196         col = split.column()
197         col.prop(rd, "dither_intensity", text="Dither", slider=True)
198
199 class CyclesCamera_PT_dof(CyclesButtonsPanel, Panel):
200     bl_label = "Depth of Field"
201     bl_context = "data"
202
203     @classmethod
204     def poll(cls, context):
205         return context.camera and CyclesButtonsPanel.poll(context)
206
207     def draw(self, context):
208         layout = self.layout
209
210         cam = context.camera
211         ccam = cam.cycles
212
213         split = layout.split()
214
215         col = split.column()
216         col.label("Focus:")
217         col.prop(cam, "dof_object", text="")
218
219         sub = col.row()
220         sub.active = cam.dof_object is None
221         sub.prop(cam, "dof_distance", text="Distance")
222
223         col = split.column()
224
225         col.label("Aperture:")
226         col.prop(ccam, "aperture_size", text="Size")
227
228         sub = col.column(align=True)
229         sub.prop(ccam, "aperture_blades", text="Blades")
230         sub.prop(ccam, "aperture_rotation", text="Rotation")
231
232 class Cycles_PT_context_material(CyclesButtonsPanel, Panel):
233     bl_label = "Surface"
234     bl_context = "material"
235     bl_options = {'HIDE_HEADER'}
236
237     @classmethod
238     def poll(cls, context):
239         return (context.material or context.object) and CyclesButtonsPanel.poll(context)
240
241     def draw(self, context):
242         layout = self.layout
243
244         mat = context.material
245         ob = context.object
246         slot = context.material_slot
247         space = context.space_data
248
249         if ob:
250             row = layout.row()
251
252             row.template_list(ob, "material_slots", ob, "active_material_index", rows=2)
253
254             col = row.column(align=True)
255             col.operator("object.material_slot_add", icon='ZOOMIN', text="")
256             col.operator("object.material_slot_remove", icon='ZOOMOUT', text="")
257
258             col.menu("MATERIAL_MT_specials", icon='DOWNARROW_HLT', text="")
259
260             if ob.mode == 'EDIT':
261                 row = layout.row(align=True)
262                 row.operator("object.material_slot_assign", text="Assign")
263                 row.operator("object.material_slot_select", text="Select")
264                 row.operator("object.material_slot_deselect", text="Deselect")
265
266         split = layout.split(percentage=0.65)
267
268         if ob:
269             split.template_ID(ob, "active_material", new="material.new")
270             row = split.row()
271
272             if slot:
273                 row.prop(slot, "link", text="")
274             else:
275                 row.label()
276         elif mat:
277             split.template_ID(space, "pin_id")
278             split.separator()
279
280 class Cycles_PT_mesh_displacement(CyclesButtonsPanel, Panel):
281     bl_label = "Displacement"
282     bl_context = "data"
283
284     @classmethod
285     def poll(cls, context):
286         return context.mesh or context.curve or context.meta_ball
287
288     def draw(self, context):
289         layout = self.layout
290
291         mesh = context.mesh
292         curve = context.curve
293         mball = context.meta_ball
294
295         if mesh:
296             cdata = mesh.cycles
297         elif curve:
298             cdata = curve.cycles
299         elif mball:
300             cdata = mball.cycles
301
302         layout.prop(cdata, "displacement_method", text="Method")
303         layout.prop(cdata, "use_subdivision");
304         layout.prop(cdata, "dicing_rate");
305
306 class CyclesObject_PT_ray_visibility(CyclesButtonsPanel, Panel):
307     bl_label = "Ray Visibility"
308     bl_context = "object"
309     bl_options = {'DEFAULT_CLOSED'}
310
311     @classmethod
312     def poll(cls, context):
313         ob = context.object
314         return ob and ob.type in ('MESH', 'CURVE', 'CURVE', 'SURFACE', 'FONT', 'META') # todo: 'LAMP'
315
316     def draw(self, context):
317         layout = self.layout
318
319         ob = context.object
320         visibility = ob.cycles_visibility
321
322         split = layout.split()
323
324         col = split.column()
325         col.prop(visibility, "camera")
326         col.prop(visibility, "diffuse")
327         col.prop(visibility, "glossy")
328
329         col = split.column()
330         col.prop(visibility, "transmission")
331         col.prop(visibility, "shadow")
332
333 def find_node(material, nodetype):
334     if material and material.node_tree:
335         ntree = material.node_tree
336
337         for node in ntree.nodes:
338             if hasattr(node, 'type') and node.type == nodetype:
339                 return node
340     
341     return None
342
343 def find_node_input(node, name):
344     for input in node.inputs:
345         if input.name == name:
346             return input
347     
348     return None
349
350 def panel_node_draw(layout, id, output_type, input_name):
351     if not id.node_tree:
352         layout.prop(id, "use_nodes", icon='NODETREE')
353         return
354
355     ntree = id.node_tree
356
357     node = find_node(id, output_type)
358     if not node:
359         layout.label(text="No output node.")
360     else:
361         input = find_node_input(node, input_name)
362         layout.template_node_view(ntree, node, input);
363
364 class CyclesLamp_PT_lamp(CyclesButtonsPanel, Panel):
365     bl_label = "Lamp"
366     bl_context = "data"
367
368     @classmethod
369     def poll(cls, context):
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     bl_options = {'DEFAULT_CLOSED'}
435
436     @classmethod
437     def poll(cls, context):
438         world = context.world
439         return world and world.node_tree and CyclesButtonsPanel.poll(context)
440
441     def draw(self, context):
442         layout = self.layout
443         layout.active = False
444
445         world = context.world
446         panel_node_draw(layout, world, 'OUTPUT_WORLD', 'Volume')
447
448 class CyclesMaterial_PT_surface(CyclesButtonsPanel, Panel):
449     bl_label = "Surface"
450     bl_context = "material"
451
452     @classmethod
453     def poll(cls, context):
454         return context.material and CyclesButtonsPanel.poll(context)
455
456     def draw(self, context):
457         layout = self.layout
458
459         mat = context.material
460         panel_node_draw(layout, mat, 'OUTPUT_MATERIAL', 'Surface')
461
462 class CyclesMaterial_PT_volume(CyclesButtonsPanel, Panel):
463     bl_label = "Volume"
464     bl_context = "material"
465     bl_options = {'DEFAULT_CLOSED'}
466
467     @classmethod
468     def poll(cls, context):
469         mat = context.material
470         return mat and mat.node_tree and CyclesButtonsPanel.poll(context)
471
472     def draw(self, context):
473         layout = self.layout
474         layout.active = False
475
476         mat = context.material
477         cmat = mat.cycles
478
479         panel_node_draw(layout, mat, 'OUTPUT_MATERIAL', 'Volume')
480
481         layout.prop(cmat, "homogeneous_volume")
482
483 class CyclesMaterial_PT_displacement(CyclesButtonsPanel, Panel):
484     bl_label = "Displacement"
485     bl_context = "material"
486
487     @classmethod
488     def poll(cls, context):
489         mat = context.material
490         return mat and mat.node_tree and CyclesButtonsPanel.poll(context)
491
492     def draw(self, context):
493         layout = self.layout
494
495         mat = context.material
496         panel_node_draw(layout, mat, 'OUTPUT_MATERIAL', 'Displacement')
497
498 class CyclesMaterial_PT_settings(CyclesButtonsPanel, Panel):
499     bl_label = "Settings"
500     bl_context = "material"
501     bl_options = {'DEFAULT_CLOSED'}
502
503     @classmethod
504     def poll(cls, context):
505         return context.material and CyclesButtonsPanel.poll(context)
506
507     def draw(self, context):
508         layout = self.layout
509
510         mat = context.material
511         cmat = mat.cycles
512
513         split = layout.split()
514
515         col = split.column()
516         col.prop(mat, "diffuse_color", text="Viewport Color")
517
518         col = split.column()
519         col.prop(cmat, "sample_as_light")
520
521 class CyclesTexture_PT_context(CyclesButtonsPanel, Panel):
522     bl_label = ""
523     bl_context = "texture"
524     bl_options = {'HIDE_HEADER'}
525     COMPAT_ENGINES = {'CYCLES'}
526
527     def draw(self, context):
528         layout = self.layout
529
530         tex = context.texture
531         space = context.space_data
532         pin_id = space.pin_id
533         use_pin_id = space.use_pin_id;
534         user = context.texture_user
535         node = context.texture_node
536
537         if not use_pin_id or not isinstance(pin_id, bpy.types.Texture):
538             pin_id = None
539
540         if not pin_id:
541             layout.template_texture_user()
542
543         if user:
544             layout.separator()
545
546             split = layout.split(percentage=0.65)
547             col = split.column()
548
549             if pin_id:
550                 col.template_ID(space, "pin_id")
551             elif user:
552                 col.template_ID(user, "texture", new="texture.new")
553             
554             if tex:
555                 row = split.row()
556                 row.prop(tex, "use_nodes", icon="NODETREE", text="")
557                 row.label()
558
559                 if not tex.use_nodes:
560                     split = layout.split(percentage=0.2)
561                     split.label(text="Type:")
562                     split.prop(tex, "type", text="")
563
564 class CyclesTexture_PT_nodes(CyclesButtonsPanel, Panel):
565     bl_label = "Nodes"
566     bl_context = "texture"
567
568     @classmethod
569     def poll(cls, context):
570         tex = context.texture
571         return (tex and tex.use_nodes) and CyclesButtonsPanel.poll(context)
572
573     def draw(self, context):
574         layout = self.layout
575
576         tex = context.texture
577         panel_node_draw(layout, tex, 'OUTPUT_TEXTURE', 'Color')
578
579 class CyclesTexture_PT_node(CyclesButtonsPanel, Panel):
580     bl_label = "Node"
581     bl_context = "texture"
582
583     @classmethod
584     def poll(cls, context):
585         node = context.texture_node
586         return node and CyclesButtonsPanel.poll(context)
587
588     def draw(self, context):
589         layout = self.layout
590
591         node = context.texture_node
592         ntree = node.id_data
593         layout.template_node_view(ntree, node, None)
594
595 class CyclesTexture_PT_mapping(CyclesButtonsPanel, Panel):
596     bl_label = "Mapping"
597     bl_context = "texture"
598
599     @classmethod
600     def poll(cls, context):
601         tex = context.texture
602         node = context.texture_node
603         return (node or (tex and tex.use_nodes)) and CyclesButtonsPanel.poll(context)
604
605     def draw(self, context):
606         layout = self.layout
607         layout.label("Texture coordinate mapping goes here.");
608         layout.label("Translate, rotate, scale, projection, XYZ.")
609
610 class CyclesTexture_PT_color(CyclesButtonsPanel, Panel):
611     bl_label = "Color"
612     bl_context = "texture"
613
614     @classmethod
615     def poll(cls, context):
616         tex = context.texture
617         node = context.texture_node
618         return (node or (tex and tex.use_nodes)) and CyclesButtonsPanel.poll(context)
619
620     def draw(self, context):
621         layout = self.layout
622         layout.label("Color modification options go here.");
623         layout.label("Ramp, brightness, contrast, saturation.")
624
625 def draw_device(self, context):
626     scene = context.scene
627     layout = self.layout
628
629     if scene.render.engine == "CYCLES":
630         cscene = scene.cycles
631
632         available_devices = engine.available_devices()
633         available_cuda = 'cuda' in available_devices
634         available_opencl = 'opencl' in available_devices
635
636         if available_cuda or available_opencl:
637             layout.prop(cscene, "device")
638             if cscene.device == 'GPU' and available_cuda and available_opencl:
639                 layout.prop(cscene, "gpu_type")
640         if cscene.device == 'CPU' and engine.with_osl():
641             layout.prop(cscene, "shading_system")
642
643 def draw_pause(self, context):
644     layout = self.layout
645     scene = context.scene
646
647     if scene.render.engine == "CYCLES":
648         view = context.space_data
649
650         if view.viewport_shade == "RENDERED":
651             cscene = scene.cycles
652             layout.prop(cscene, "preview_pause", icon="PAUSE", text="")
653
654 def get_panels():
655     return [
656         bpy.types.RENDER_PT_render,
657         bpy.types.RENDER_PT_output,
658         bpy.types.RENDER_PT_encoding,
659         bpy.types.RENDER_PT_dimensions,
660         bpy.types.RENDER_PT_stamp,
661         bpy.types.WORLD_PT_context_world,
662         bpy.types.DATA_PT_context_mesh,
663         bpy.types.DATA_PT_context_camera,
664         bpy.types.DATA_PT_context_lamp,
665         bpy.types.DATA_PT_texture_space,
666         bpy.types.DATA_PT_curve_texture_space,
667         bpy.types.DATA_PT_mball_texture_space,
668         bpy.types.DATA_PT_vertex_groups,
669         bpy.types.DATA_PT_shape_keys,
670         bpy.types.DATA_PT_uv_texture,
671         bpy.types.DATA_PT_vertex_colors,
672         bpy.types.DATA_PT_camera,
673         bpy.types.DATA_PT_camera_display,
674         bpy.types.DATA_PT_custom_props_mesh,
675         bpy.types.DATA_PT_custom_props_camera,
676         bpy.types.DATA_PT_custom_props_lamp,
677         bpy.types.TEXTURE_PT_clouds,
678         bpy.types.TEXTURE_PT_wood,
679         bpy.types.TEXTURE_PT_marble,
680         bpy.types.TEXTURE_PT_magic,
681         bpy.types.TEXTURE_PT_blend,
682         bpy.types.TEXTURE_PT_stucci,
683         bpy.types.TEXTURE_PT_image,
684         bpy.types.TEXTURE_PT_image_sampling,
685         bpy.types.TEXTURE_PT_image_mapping,
686         bpy.types.TEXTURE_PT_musgrave,
687         bpy.types.TEXTURE_PT_voronoi,
688         bpy.types.TEXTURE_PT_distortednoise,
689         bpy.types.TEXTURE_PT_voxeldata,
690         bpy.types.TEXTURE_PT_pointdensity,
691         bpy.types.TEXTURE_PT_pointdensity_turbulence]
692
693 def register():
694     bpy.types.RENDER_PT_render.append(draw_device)
695     bpy.types.VIEW3D_HT_header.append(draw_pause)
696
697     for panel in get_panels():
698         panel.COMPAT_ENGINES.add('CYCLES')
699     
700 def unregister():
701     bpy.types.RENDER_PT_render.remove(draw_device)
702     bpy.types.VIEW3D_HT_header.remove(draw_pause)
703
704     for panel in get_panels():
705         panel.COMPAT_ENGINES.remove('CYCLES')
706