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