image format arg parsing for creator.c
[blender.git] / intern / cycles / blender / addon / properties.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 # <pep8 compliant>
20
21 import bpy
22 from bpy.props import *
23
24 import math
25
26 from cycles import enums
27
28
29 class CyclesRenderSettings(bpy.types.PropertyGroup):
30     @classmethod
31     def register(cls):
32         bpy.types.Scene.cycles = PointerProperty(type=cls, name="Cycles Render Settings", description="Cycles render settings")
33
34         cls.device = EnumProperty(name="Device", description="Device to use for rendering",
35             items=enums.devices, default="CPU")
36
37         cls.gpu_type = EnumProperty(name="GPU Type", description="Processing system to use on the GPU",
38             items=enums.gpu_type, default="CUDA")
39
40         cls.shading_system = EnumProperty(name="Shading System", description="Shading system to use for rendering",
41             items=enums.shading_systems, default="GPU_COMPATIBLE")
42
43         cls.samples = IntProperty(name="Samples", description="Number of samples to render for each pixel",
44             default=10, min=1, max=2147483647)
45         cls.preview_samples = IntProperty(name="Preview Samples", description="Number of samples to render in the viewport, unlimited if 0",
46             default=10, min=0, max=2147483647)
47         cls.preview_pause = BoolProperty(name="Pause Preview", description="Pause all viewport preview renders",
48             default=False)
49
50         cls.no_caustics = BoolProperty(name="No Caustics", description="Leave out caustics, resulting in a darker image with less noise",
51             default=False)
52         cls.blur_caustics = FloatProperty(name="Blur Caustics", description="Blur caustics to reduce noise",
53             default=0.0, min=0.0, max=1.0)
54
55         cls.min_bounces = IntProperty(name="Min Bounces", description="Minimum number of bounces, setting this lower than the maximum enables probalistic path termination (faster but noisier)",
56             default=3, min=0, max=1024)
57         cls.max_bounces = IntProperty(name="Max Bounces", description="Total maximum number of bounces",
58             default=8, min=0, max=1024)
59
60         cls.diffuse_bounces = IntProperty(name="Diffuse Bounces", description="Maximum number of diffuse reflection bounces, bounded by total maximum",
61             default=128, min=0, max=1024)
62         cls.glossy_bounces = IntProperty(name="Glossy Bounces", description="Maximum number of glossy reflection bounces, bounded by total maximum",
63             default=128, min=0, max=1024)
64         cls.transmission_bounces = IntProperty(name="Transmission Bounces", description="Maximum number of transmission bounces, bounded by total maximum",
65             default=128, min=0, max=1024)
66
67         cls.transparent_min_bounces = IntProperty(name="Transparent Min Bounces", description="Minimum number of transparent bounces, setting this lower than the maximum enables probalistic path termination (faster but noisier)",
68             default=8, min=0, max=1024)
69         cls.transparent_max_bounces = IntProperty(name="Transparent Max Bounces", description="Maximum number of transparent bounces",
70             default=8, min=0, max=1024)
71         cls.use_transparent_shadows = BoolProperty(name="Transparent Shadows", description="Use transparency of surfaces for rendering shadows",
72             default=True)
73
74         cls.film_exposure = FloatProperty(name="Exposure", description="Image brightness scale",
75             default=1.0, min=0.0, max=10.0)
76         cls.film_transparent = BoolProperty(name="Transparent", description="World background is transparent",
77             default=False)
78
79         cls.filter_type = EnumProperty(name="Filter Type", description="Pixel filter type",
80             items=enums.filter_types, default="GAUSSIAN")
81         cls.filter_width = FloatProperty(name="Filter Width", description="Pixel filter width",
82             default=1.5, min=0.01, max=10.0)
83
84         cls.seed = IntProperty(name="Seed", description="Seed value for integrator to get different noise patterns",
85             default=0, min=0, max=2147483647)
86
87         cls.debug_tile_size = IntProperty(name="Tile Size", description="",
88             default=1024, min=1, max=4096)
89         cls.debug_min_size = IntProperty(name="Min Size", description="",
90             default=64, min=1, max=4096)
91         cls.debug_reset_timeout = FloatProperty(name="Reset timeout", description="",
92             default=0.1, min=0.01, max=10.0)
93         cls.debug_cancel_timeout = FloatProperty(name="Cancel timeout", description="",
94             default=0.1, min=0.01, max=10.0)
95         cls.debug_text_timeout = FloatProperty(name="Text timeout", description="",
96             default=1.0, min=0.01, max=10.0)
97
98         cls.debug_bvh_type = EnumProperty(name="Viewport BVH Type", description="Choose between faster updates, or faster render",
99             items=enums.bvh_types, default="DYNAMIC_BVH")
100         cls.debug_use_spatial_splits = BoolProperty(name="Use Spatial Splits", description="Use BVH spatial splits: longer builder time, faster render",
101             default=False)
102
103     @classmethod
104     def unregister(cls):
105         del bpy.types.Scene.cycles
106
107
108 class CyclesCameraSettings(bpy.types.PropertyGroup):
109     @classmethod
110     def register(cls):
111         bpy.types.Camera.cycles = PointerProperty(type=cls, name="Cycles Camera Settings", description="Cycles camera settings")
112
113         cls.aperture_size = FloatProperty(name="Aperture Size", description="Radius of the aperture for depth of field",
114             default=0.0, min=0.0, max=10.0)
115         cls.aperture_blades = IntProperty(name="Aperture Blades", description="Number of blades in aperture for polygonal bokeh (at least 3)",
116             default=0, min=0, max=100)
117         cls.aperture_rotation = FloatProperty(name="Aperture Rotation", description="Rotation of blades in aperture",
118             default=0, soft_min=-math.pi, soft_max=math.pi, subtype='ANGLE')
119
120     @classmethod
121     def unregister(cls):
122         del bpy.types.Camera.cycles
123
124
125 class CyclesMaterialSettings(bpy.types.PropertyGroup):
126     @classmethod
127     def register(cls):
128         bpy.types.Material.cycles = PointerProperty(type=cls, name="Cycles Material Settings", description="Cycles material settings")
129         cls.sample_as_light = BoolProperty(name="Sample as Lamp", description="Use direct light sampling for this material, disabling may reduce overall noise for large objects that emit little light compared to other light sources", default=True)
130         cls.homogeneous_volume = BoolProperty(name="Homogeneous Volume", description="When using volume rendering, assume volume has the same density everywhere, for faster rendering", default=False)
131
132     @classmethod
133     def unregister(cls):
134         del bpy.types.Material.cycles
135
136
137 class CyclesLampSettings(bpy.types.PropertyGroup):
138     @classmethod
139     def register(cls):
140         bpy.types.Lamp.cycles = PointerProperty(type=cls, name="Cycles Lamp Settings", description="Cycles lamp settings")
141         cls.cast_shadow = BoolProperty(name="Cast Shadow", description="Lamp casts shadows", default=True)
142
143     @classmethod
144     def unregister(cls):
145         del bpy.types.Lamp.cycles
146
147
148 class CyclesWorldSettings(bpy.types.PropertyGroup):
149     @classmethod
150     def register(cls):
151         bpy.types.World.cycles = PointerProperty(type=cls, name="Cycles World Settings", description="Cycles world settings")
152
153     @classmethod
154     def unregister(cls):
155         del bpy.types.World.cycles
156
157
158 class CyclesVisibilitySettings(bpy.types.PropertyGroup):
159     @classmethod
160     def register(cls):
161         bpy.types.Object.cycles_visibility = PointerProperty(type=cls, name="Cycles Visibility Settings", description="Cycles visibility settings")
162
163         cls.camera = BoolProperty(name="Camera", description="Object visibility for camera rays", default=True)
164         cls.diffuse = BoolProperty(name="Diffuse", description="Object visibility for diffuse reflection rays", default=True)
165         cls.glossy = BoolProperty(name="Glossy", description="Object visibility for glossy reflection rays", default=True)
166         cls.transmission = BoolProperty(name="Transmission", description="Object visibility for transmission rays", default=True)
167         cls.shadow = BoolProperty(name="Shadow", description="Object visibility for shadow rays", default=True)
168
169     @classmethod
170     def unregister(cls):
171         del bpy.types.Object.cycles_visibility
172
173
174 class CyclesMeshSettings(bpy.types.PropertyGroup):
175     @classmethod
176     def register(cls):
177         bpy.types.Mesh.cycles = PointerProperty(type=cls, name="Cycles Mesh Settings", description="Cycles mesh settings")
178         bpy.types.Curve.cycles = PointerProperty(type=cls, name="Cycles Mesh Settings", description="Cycles mesh settings")
179         bpy.types.MetaBall.cycles = PointerProperty(type=cls, name="Cycles Mesh Settings", description="Cycles mesh settings")
180
181         cls.displacement_method = EnumProperty(name="Displacement Method", description="Method to use for the displacement",
182             items=enums.displacement_methods, default="BUMP")
183         cls.use_subdivision = BoolProperty(name="Use Subdivision", description="Subdivide mesh for rendering",
184             default=False)
185         cls.dicing_rate = FloatProperty(name="Dicing Rate", description="", default=1.0, min=0.001, max=1000.0)
186
187     @classmethod
188     def unregister(cls):
189         del bpy.types.Mesh.cycles
190         del bpy.types.Curve.cycles
191         del bpy.types.MetaBall.cycles
192
193
194 def register():
195     bpy.utils.register_class(CyclesRenderSettings)
196     bpy.utils.register_class(CyclesCameraSettings)
197     bpy.utils.register_class(CyclesMaterialSettings)
198     bpy.utils.register_class(CyclesLampSettings)
199     bpy.utils.register_class(CyclesWorldSettings)
200     bpy.utils.register_class(CyclesVisibilitySettings)
201     bpy.utils.register_class(CyclesMeshSettings)
202
203
204 def unregister():
205     bpy.utils.unregister_class(CyclesRenderSettings)
206     bpy.utils.unregister_class(CyclesCameraSettings)
207     bpy.utils.unregister_class(CyclesMaterialSettings)
208     bpy.utils.unregister_class(CyclesLampSettings)
209     bpy.utils.unregister_class(CyclesWorldSettings)
210     bpy.utils.unregister_class(CyclesMeshSettings)
211     bpy.utils.unregister_class(CyclesVisibilitySettings)