render_povray/shading_properties.py

   1 # SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 """Declare shading properties exported to POV textures."""
   4 import bpy
   5 from bpy.utils import register_class, unregister_class
   6 from bpy.types import PropertyGroup
   7 from bpy.props import (
   8     FloatVectorProperty,
   9     StringProperty,
  10     BoolProperty,
  11     IntProperty,
  12     FloatProperty,
  13     EnumProperty,
  14     PointerProperty,
  15 )
  16
  17
  18 def check_material(mat):
  19     """Check that material node tree is not empty if use node button is on"""
  20     if mat is not None:
  21         return not mat.node_tree if mat.use_nodes else True
  22     return False
  23
  24
  25 def pov_context_tex_datablock(context):
  26     """Texture context type recreated as deprecated in blender 2.8"""
  27
  28     idblock = context.brush
  29     if idblock and context.scene.texture_context == "OTHER":
  30         return idblock
  31
  32     # idblock = bpy.context.active_object.active_material
  33     idblock = context.view_layer.objects.active.active_material
  34     if idblock and context.scene.texture_context == "MATERIAL":
  35         return idblock
  36
  37     idblock = context.scene.world
  38     if idblock and context.scene.texture_context == "WORLD":
  39         return idblock
  40
  41     idblock = context.light
  42     if idblock and context.scene.texture_context == "LIGHT":
  43         return idblock
  44
  45     if context.particle_system and context.scene.texture_context == "PARTICLES":
  46         idblock = context.particle_system.settings
  47
  48     idblock = context.line_style
  49     if idblock and context.scene.texture_context == "LINESTYLE":
  50         return idblock
  51
  52     return idblock
  53
  54
  55 def active_texture_name_from_uilist(self, context):
  56     """Name created texture slots the same as created texture"""
  57     idblock = pov_context_tex_datablock(context)
  58     # mat = context.view_layer.objects.active.active_material
  59     if idblock is not None:
  60         index = idblock.pov.active_texture_index
  61         name = idblock.pov_texture_slots[index].name
  62         newname = idblock.pov_texture_slots[index].texture
  63         tex = bpy.data.textures[name]
  64         tex.name = newname
  65         idblock.pov_texture_slots[index].name = newname
  66
  67
  68 def active_texture_name_from_search(self, context):
  69     """Texture rolldown to change the data linked by an existing texture"""
  70     idblock = pov_context_tex_datablock(context)
  71     # mat = context.view_layer.objects.active.active_material
  72     if idblock is not None:
  73         index = idblock.pov.active_texture_index
  74         slot = idblock.pov_texture_slots[index]
  75         name = slot.texture_search
  76
  77     try:
  78         # tex = bpy.data.textures[name]
  79         slot.name = name
  80         slot.texture = name
  81         # Switch paint brush to this texture so settings remain contextual
  82         # bpy.context.tool_settings.image_paint.brush.texture = tex
  83         # bpy.context.tool_settings.image_paint.brush.mask_texture = tex
  84     except BaseException as e:
  85         print(e.__doc__)
  86         print("An exception occurred: {}".format(e))
  87
  88
  89 def brush_texture_update(self, context):
  90
  91     """Brush texture rolldown must show active slot texture props"""
  92     idblock = pov_context_tex_datablock(context)
  93     if idblock is not None:
  94         # mat = context.view_layer.objects.active.active_material
  95         idblock = pov_context_tex_datablock(context)
  96         slot = idblock.pov_texture_slots[idblock.pov.active_texture_index]
  97         if tex := slot.texture:
  98             # Switch paint brush to active texture so slot and settings remain contextual
  99             # bpy.ops.pov.textureslotupdate()
 100             bpy.context.tool_settings.image_paint.brush.texture = bpy.data.textures[tex]
 101             bpy.context.tool_settings.image_paint.brush.mask_texture = bpy.data.textures[tex]
 102
 103
 104 class RenderPovSettingsMaterial(PropertyGroup):
 105     """Declare material level properties controllable in UI and translated to POV."""
 106
 107     # --------------------------- Begin Old Blender Internal Props --------------------------- #
 108     # former Space properties from  removed Blender Internal
 109     use_limited_texture_context: BoolProperty(
 110         name="",
 111         description="Use the limited version of texture user (for ‘old shading’ mode)",
 112         default=True,
 113     )
 114     texture_context: EnumProperty(
 115         name="Texture context",
 116         description="Type of texture data to display and edit",
 117         items=(
 118             ("MATERIAL", "", "Show material textures", "MATERIAL", 0),  # "Show material textures"
 119             ("WORLD", "", "Show world textures", "WORLD", 1),  # "Show world textures"
 120             ("LAMP", "", "Show lamp textures", "LIGHT", 2),  # "Show lamp textures"
 121             (
 122                 "PARTICLES",
 123                 "",
 124                 "Show particles textures",
 125                 "PARTICLES",
 126                 3,
 127             ),  # "Show particles textures"
 128             (
 129                 "LINESTYLE",
 130                 "",
 131                 "Show linestyle textures",
 132                 "LINE_DATA",
 133                 4,
 134             ),  # "Show linestyle textures"
 135             (
 136                 "OTHER",
 137                 "",
 138                 "Show other data textures",
 139                 "TEXTURE_DATA",
 140                 5,
 141             ),  # "Show other data textures"
 142         ),
 143         default="MATERIAL",
 144     )
 145
 146     active_texture_index: IntProperty(
 147         name="Index for texture_slots", default=0, update=brush_texture_update
 148     )
 149
 150     transparency_method: EnumProperty(
 151         name="Specular Shader Model",
 152         description="Method to use for rendering transparency",
 153         items=(
 154             ("MASK", "Mask", "Mask the background"),
 155             ("Z_TRANSPARENCY", "Z Transparency", "Use alpha buffer for transparent faces"),
 156             ("RAYTRACE", "Raytrace", "Use raytracing for transparent refraction rendering"),
 157         ),
 158         default="MASK",
 159     )
 160
 161     use_transparency: BoolProperty(
 162         name="Transparency", description="Render material as transparent", default=False
 163     )
 164
 165     alpha: FloatProperty(
 166         name="Alpha",
 167         description="Alpha transparency of the material",
 168         min=0.0,
 169         max=1.0,
 170         soft_min=0.0,
 171         soft_max=1.0,
 172         default=1.0,
 173         precision=3,
 174     )
 175
 176     specular_alpha: FloatProperty(
 177         name="Specular alpha",
 178         description="Alpha transparency for specular areas",
 179         min=0.0,
 180         max=1.0,
 181         soft_min=0.0,
 182         soft_max=1.0,
 183         default=1.0,
 184         precision=3,
 185     )
 186
 187     ambient: FloatProperty(
 188         name="Ambient",
 189         description="Amount of global ambient color the material receives",
 190         min=0.0,
 191         max=1.0,
 192         soft_min=0.0,
 193         soft_max=1.0,
 194         default=1.0,
 195         precision=3,
 196     )
 197     # TODO: replace by newer agnostic Material.diffuse_color and remove from pov panel
 198     diffuse_color: FloatVectorProperty(
 199         name="Diffuse color",
 200         description="Diffuse color of the material",
 201         precision=4,
 202         step=0.01,
 203         min=0,  # max=inf, soft_max=1,
 204         default=(0.6, 0.6, 0.6),
 205         options={"ANIMATABLE"},
 206         subtype="COLOR",
 207     )
 208
 209     darkness: FloatProperty(
 210         name="Darkness",
 211         description="Minnaert darkness",
 212         min=0.0,
 213         max=2.0,
 214         soft_min=0.0,
 215         soft_max=2.0,
 216         default=1.0,
 217         precision=3,
 218     )
 219
 220     diffuse_fresnel: FloatProperty(
 221         name="Diffuse fresnel",
 222         description="Power of Fresnel",
 223         min=0.0,
 224         max=5.0,
 225         soft_min=0.0,
 226         soft_max=5.0,
 227         default=1.0,
 228         precision=3,
 229     )
 230
 231     diffuse_fresnel_factor: FloatProperty(
 232         name="Diffuse fresnel factor",
 233         description="Blending factor of Fresnel",
 234         min=0.0,
 235         max=5.0,
 236         soft_min=0.0,
 237         soft_max=5.0,
 238         default=0.5,
 239         precision=3,
 240     )
 241
 242     diffuse_intensity: FloatProperty(
 243         name="Diffuse intensity",
 244         description="Amount of diffuse reflection multiplying color",
 245         min=0.0,
 246         max=1.0,
 247         soft_min=0.0,
 248         soft_max=1.0,
 249         default=0.8,
 250         precision=3,
 251     )
 252
 253     diffuse_ramp_blend: EnumProperty(
 254         name="Diffuse ramp blend",
 255         description="Blending method of the ramp and the diffuse color",
 256         items=(
 257             ("MIX", "Mix", ""),
 258             ("ADD", "Add", ""),
 259             ("MULTIPLY", "Multiply", ""),
 260             ("SUBTRACT", "Subtract", ""),
 261             ("SCREEN", "Screen", ""),
 262             ("DIVIDE", "Divide", ""),
 263             ("DIFFERENCE", "Difference", ""),
 264             ("DARKEN", "Darken", ""),
 265             ("LIGHTEN", "Lighten", ""),
 266             ("OVERLAY", "Overlay", ""),
 267             ("DODGE", "Dodge", ""),
 268             ("BURN", "Burn", ""),
 269             ("HUE", "Hue", ""),
 270             ("SATURATION", "Saturation", ""),
 271             ("VALUE", "Value", ""),
 272             ("COLOR", "Color", ""),
 273             ("SOFT_LIGHT", "Soft light", ""),
 274             ("LINEAR_LIGHT", "Linear light", ""),
 275         ),
 276         default="MIX",
 277     )
 278
 279     diffuse_ramp_factor: FloatProperty(
 280         name="Factor",
 281         description="Blending factor (also uses alpha in Colorband)",
 282         min=0.0,
 283         max=1.0,
 284         soft_min=0.0,
 285         soft_max=1.0,
 286         default=1.0,
 287         precision=3,
 288     )
 289
 290     diffuse_ramp_input: EnumProperty(
 291         name="Input",
 292         description="How the ramp maps on the surface",
 293         items=(
 294             ("SHADER", "Shader", ""),
 295             ("ENERGY", "Energy", ""),
 296             ("NORMAL", "Normal", ""),
 297             ("RESULT", "Result", ""),
 298         ),
 299         default="SHADER",
 300     )
 301
 302     diffuse_shader: EnumProperty(
 303         name="Diffuse Shader Model",
 304         description="How the ramp maps on the surface",
 305         items=(
 306             ("LAMBERT", "Lambert", "Use a Lambertian shader"),
 307             ("OREN_NAYAR", "Oren-Nayar", "Use an Oren-Nayar shader"),
 308             ("MINNAERT", "Minnaert", "Use a Minnaert shader"),
 309             ("FRESNEL", "Fresnel", "Use a Fresnel shader"),
 310         ),
 311         default="LAMBERT",
 312     )
 313
 314     diffuse_toon_size: FloatProperty(
 315         name="Size",
 316         description="Size of diffuse toon area",
 317         min=0.0,
 318         max=3.14,
 319         soft_min=0.0,
 320         soft_max=3.14,
 321         default=0.5,
 322         precision=3,
 323     )
 324
 325     diffuse_toon_smooth: FloatProperty(
 326         name="Smooth",
 327         description="Smoothness of diffuse toon area",
 328         min=0.0,
 329         max=1.0,
 330         soft_min=0.0,
 331         soft_max=1.0,
 332         default=0.1,
 333         precision=3,
 334     )
 335
 336     emit: FloatProperty(
 337         name="Emit",
 338         description="Amount of light to emit",
 339         min=0.0,
 340         soft_min=0.0,  # max=inf, soft_max=inf,
 341         default=0.0,
 342         precision=3,
 343     )
 344
 345     mirror_color: FloatVectorProperty(
 346         name="Mirror color",
 347         description="Mirror color of the material",
 348         precision=4,
 349         step=0.01,
 350         min=0,  # max=inf, soft_max=1,
 351         default=(0.6, 0.6, 0.6),
 352         options={"ANIMATABLE"},
 353         subtype="COLOR",
 354     )
 355
 356     roughness: FloatProperty(
 357         name="Roughness",
 358         description="Oren-Nayar Roughness",
 359         min=0.0,
 360         max=3.14,
 361         soft_min=0.0,
 362         soft_max=3.14,
 363         precision=3,
 364         default=0.5,
 365     )
 366
 367     halo: BoolProperty(name="Halo", description=" Halo settings for the material", default=False)
 368     # (was readonly in Blender2.79, never None)
 369
 370     line_color: FloatVectorProperty(
 371         name="Line color",
 372         description="Line color used for Freestyle line rendering",
 373         precision=4,
 374         step=0.01,
 375         min=0,  # max=inf, soft_max=1,
 376         default=(0.0, 0.0, 0.0),
 377         options={"ANIMATABLE"},
 378         subtype="COLOR",
 379     )
 380
 381     # diffuse_ramp:
 382     ## Color ramp used to affect diffuse shading
 383     ## Type:    ColorRamp, (readonly)
 384
 385     # cr_node = bpy.data.materials['Material'].node_tree.nodes['ColorRamp']
 386     # layout.template_color_ramp(cr_node, "color_ramp", expand=True)
 387
 388     # ou
 389
 390     # class bpy.types.ColorRamp(bpy_struct)
 391
 392     line_priority: IntProperty(
 393         name="Recursion Limit",
 394         description="The line color of a higher priority is used at material boundaries",
 395         min=0,
 396         max=32767,
 397         default=0,
 398     )
 399
 400     specular_color: FloatVectorProperty(
 401         name="Specular color",
 402         description="Specular color of the material ",
 403         precision=4,
 404         step=0.01,
 405         min=0.0,
 406         soft_max=1.0,
 407         default=(1.0, 1.0, 1.0),
 408         options={"ANIMATABLE"},
 409         subtype="COLOR",
 410     )
 411     specular_hardness: IntProperty(
 412         name="Hardness",
 413         description="How hard (sharp) the specular reflection is",
 414         min=1,
 415         max=511,
 416         default=30,
 417     )
 418     # TODO: replace by newer agnostic Material.specular_intensity and remove from pov panel
 419     specular_intensity: FloatProperty(
 420         name="Intensity",
 421         description="How intense (bright) the specular reflection is",
 422         min=0.0,
 423         max=1.0,
 424         soft_min=0.0,
 425         soft_max=1.0,
 426         default=0.1,
 427         precision=3,
 428     )
 429
 430     specular_ior: FloatProperty(
 431         name="IOR",
 432         description="Specular index of refraction",
 433         min=-10.0,
 434         max=10.0,
 435         soft_min=0.0,
 436         soft_max=10.0,
 437         default=1.0,
 438         precision=3,
 439     )
 440
 441     ior: FloatProperty(
 442         name="IOR",
 443         description="Index of refraction",
 444         min=-10.0,
 445         max=10.0,
 446         soft_min=0.0,
 447         soft_max=10.0,
 448         default=1.0,
 449         precision=3,
 450     )
 451
 452     specular_shader: EnumProperty(
 453         name="Specular Shader Model",
 454         description="How the ramp maps on the surface",
 455         items=(
 456             ("COOKTORR", "CookTorr", "Use a Cook-Torrance shader"),
 457             ("PHONG", "Phong", "Use a Phong shader"),
 458             ("BLINN", "Blinn", "Use a Blinn shader"),
 459             ("TOON", "Toon", "Use a Toon shader"),
 460             ("WARDISO", "WardIso", "Use a Ward anisotropic shader"),
 461         ),
 462         default="COOKTORR",
 463     )
 464
 465     specular_slope: FloatProperty(
 466         name="Slope",
 467         description="The standard deviation of surface slope",
 468         min=0.0,
 469         max=0.4,
 470         soft_min=0.0,
 471         soft_max=0.4,
 472         default=0.1,
 473         precision=3,
 474     )
 475
 476     specular_toon_size: FloatProperty(
 477         name="Size",
 478         description="Size of specular toon area",
 479         min=0.0,
 480         max=0.53,
 481         soft_min=0.0,
 482         soft_max=0.53,
 483         default=0.5,
 484         precision=3,
 485     )
 486
 487     specular_toon_smooth: FloatProperty(
 488         name="Smooth",
 489         description="Smoothness of specular toon area",
 490         min=0.0,
 491         max=1.0,
 492         soft_min=0.0,
 493         soft_max=1.0,
 494         default=0.1,
 495         precision=3,
 496     )
 497
 498     translucency: FloatProperty(
 499         name="Translucency",
 500         description="Amount of diffuse shading on the back side",
 501         min=0.0,
 502         max=1.0,
 503         soft_min=0.0,
 504         soft_max=1.0,
 505         default=0.0,
 506         precision=3,
 507     )
 508
 509     transparency_method: EnumProperty(
 510         name="Specular Shader Model",
 511         description="Method to use for rendering transparency",
 512         items=(
 513             ("MASK", "Mask", "Mask the background"),
 514             ("Z_TRANSPARENCY", "Z Transparency", "Use an ior of 1 for transparent faces"),
 515             ("RAYTRACE", "Raytrace", "Use raytracing for transparent refraction rendering"),
 516         ),
 517         default="MASK",
 518     )
 519
 520     type: EnumProperty(
 521         name="Type",
 522         description="Material type defining how the object is rendered",
 523         items=(
 524             ("SURFACE", "Surface", "Render object as a surface"),
 525             # TO UPDATE > USE wire MACRO AND CHANGE DESCRIPTION
 526             ("WIRE", "Wire", "Render the edges of faces as wires (not supported in raytracing)"),
 527             ("VOLUME", "Volume", "Render object as a volume"),
 528             # TO UPDATE > USE halo MACRO AND CHANGE DESCRIPTION
 529             ("HALO", "Halo", "Render object as halo particles"),
 530         ),
 531         default="SURFACE",
 532     )
 533
 534     use_cast_shadows: BoolProperty(
 535         name="Cast", description="Allow this material to cast shadows", default=True
 536     )
 537
 538     use_cast_shadows_only: BoolProperty(
 539         name="Cast Only",
 540         description="Make objects with this material "
 541         "appear invisible (not rendered), only "
 542         "casting shadows",
 543         default=False,
 544     )
 545
 546     use_cubic: BoolProperty(
 547         name="Cubic Interpolation",
 548         description="Use cubic interpolation for diffuse " "values, for smoother transitions",
 549         default=False,
 550     )
 551
 552     use_diffuse_ramp: BoolProperty(
 553         name="Ramp", description="Toggle diffuse ramp operations", default=False
 554     )
 555
 556     use_light_group_exclusive: BoolProperty(
 557         name="Exclusive",
 558         description="Material uses the light group exclusively"
 559         "- these lamps are excluded from other "
 560         "scene lighting",
 561         default=False,
 562     )
 563
 564     use_light_group_local: BoolProperty(
 565         name="Local",
 566         description="When linked in, material uses local light" " group with the same name",
 567         default=False,
 568     )
 569
 570     use_mist: BoolProperty(
 571         name="Use Mist",
 572         description="Use mist with this material " "(in world settings)",
 573         default=True,
 574     )
 575
 576     use_nodes: BoolProperty(
 577         name="Nodes",
 578         # Add Icon in UI or here? icon='NODES'
 579         description="Use shader nodes to render the material",
 580         default=False,
 581     )
 582
 583     use_object_color: BoolProperty(
 584         name="Object Color",
 585         description="Modulate the result with a per-object color",
 586         default=False,
 587     )
 588
 589     use_only_shadow: BoolProperty(
 590         name="Shadows Only",
 591         description="Render shadows as the material’s alpha "
 592         "value, making the material transparent "
 593         "except for shadowed areas",
 594         default=False,
 595     )
 596
 597     use_shadeless: BoolProperty(
 598         name="Shadeless",
 599         description="Make this material insensitive to " "light or shadow",
 600         default=False,
 601     )
 602
 603     use_shadows: BoolProperty(
 604         name="Receive", description="Allow this material to receive shadows", default=True
 605     )
 606
 607     use_sky: BoolProperty(
 608         name="Sky",
 609         description="Render this material with zero alpha, "
 610         "with sky background in place (scanline only)",
 611         default=False,
 612     )
 613
 614     use_specular_ramp: BoolProperty(
 615         name="Ramp", description="Toggle specular ramp operations", default=False
 616     )
 617
 618     use_tangent_shading: BoolProperty(
 619         name="Tangent Shading",
 620         description="Use the material’s tangent vector instead"
 621         "of the normal for shading - for "
 622         "anisotropic shading effects",
 623         default=False,
 624     )
 625
 626     use_transparent_shadows: BoolProperty(
 627         name="Receive Transparent",
 628         description="Allow this object to receive transparent " "shadows cast through other object",
 629         default=False,
 630     )  # linked to fake caustics
 631
 632     use_vertex_color_light: BoolProperty(
 633         name="Vertex Color Light",
 634         description="Add vertex colors as additional lighting",
 635         default=False,
 636     )
 637
 638     # TODO create interface:
 639     use_vertex_color_paint: BoolProperty(
 640         name="Vertex Color Paint",
 641         description="Replace object base color with vertex "
 642         "colors (multiply with ‘texture face’ "
 643         "face assigned textures)",
 644         default=False,
 645     )
 646
 647     specular_ramp_blend: EnumProperty(
 648         name="Specular ramp blend",
 649         description="Blending method of the ramp and the specular color",
 650         items=(
 651             ("MIX", "Mix", ""),
 652             ("ADD", "Add", ""),
 653             ("MULTIPLY", "Multiply", ""),
 654             ("SUBTRACT", "Subtract", ""),
 655             ("SCREEN", "Screen", ""),
 656             ("DIVIDE", "Divide", ""),
 657             ("DIFFERENCE", "Difference", ""),
 658             ("DARKEN", "Darken", ""),
 659             ("LIGHTEN", "Lighten", ""),
 660             ("OVERLAY", "Overlay", ""),
 661             ("DODGE", "Dodge", ""),
 662             ("BURN", "Burn", ""),
 663             ("HUE", "Hue", ""),
 664             ("SATURATION", "Saturation", ""),
 665             ("VALUE", "Value", ""),
 666             ("COLOR", "Color", ""),
 667             ("SOFT_LIGHT", "Soft light", ""),
 668             ("LINEAR_LIGHT", "Linear light", ""),
 669         ),
 670         default="MIX",
 671     )
 672
 673     specular_ramp_factor: FloatProperty(
 674         name="Factor",
 675         description="Blending factor (also uses alpha in Colorband)",
 676         min=0.0,
 677         max=1.0,
 678         soft_min=0.0,
 679         soft_max=1.0,
 680         default=1.0,
 681         precision=3,
 682     )
 683
 684     specular_ramp_input: EnumProperty(
 685         name="Input",
 686         description="How the ramp maps on the surface",
 687         items=(
 688             ("SHADER", "Shader", ""),
 689             ("ENERGY", "Energy", ""),
 690             ("NORMAL", "Normal", ""),
 691             ("RESULT", "Result", ""),
 692         ),
 693         default="SHADER",
 694     )
 695
 696     irid_enable: BoolProperty(
 697         name="Iridescence coating",
 698         description="Newton's thin film interference (like an oil slick on a puddle of "
 699         "water or the rainbow hues of a soap bubble.)",
 700         default=False,
 701     )
 702
 703     mirror_use_IOR: BoolProperty(
 704         name="Correct Reflection",
 705         description="Use same IOR as raytrace transparency to calculate mirror reflections. "
 706         "More physically correct",
 707         default=False,
 708     )
 709
 710     conserve_energy: BoolProperty(
 711         name="Conserve Energy",
 712         description="Light transmitted is more correctly reduced by mirror reflections, "
 713         "also the sum of diffuse and translucency gets reduced below one ",
 714         default=True,
 715     )
 716
 717     irid_amount: FloatProperty(
 718         name="amount",
 719         description="Contribution of the iridescence effect to the overall surface color. "
 720         "As a rule of thumb keep to around 0.25 (25% contribution) or less, "
 721         "but experiment. If the surface is coming out too white, try lowering "
 722         "the diffuse and possibly the ambient values of the surface",
 723         min=0.0,
 724         max=1.0,
 725         soft_min=0.01,
 726         soft_max=1.0,
 727         default=0.25,
 728     )
 729
 730     irid_thickness: FloatProperty(
 731         name="thickness",
 732         description="A very thin film will have a high frequency of color changes while a "
 733         "thick film will have large areas of color",
 734         min=0.0,
 735         max=1000.0,
 736         soft_min=0.1,
 737         soft_max=10.0,
 738         default=1,
 739     )
 740
 741     irid_turbulence: FloatProperty(
 742         name="turbulence",
 743         description="This parameter varies the thickness",
 744         min=0.0,
 745         max=10.0,
 746         soft_min=0.000,
 747         soft_max=1.0,
 748         default=0,
 749     )
 750
 751     interior_fade_color: FloatVectorProperty(
 752         name="Interior Fade Color",
 753         description="Color of filtered attenuation for transparent " "materials",
 754         precision=4,
 755         step=0.01,
 756         min=0.0,
 757         soft_max=1.0,
 758         default=(0, 0, 0),
 759         options={"ANIMATABLE"},
 760         subtype="COLOR",
 761     )
 762
 763     caustics_enable: BoolProperty(
 764         name="Caustics",
 765         description="use only fake refractive caustics (default) or photon based "
 766         "reflective/refractive caustics",
 767         default=True,
 768     )
 769
 770     fake_caustics: BoolProperty(
 771         name="Fake Caustics",
 772         description="use only (Fast) fake refractive caustics based on transparent shadows",
 773         default=True
 774     )
 775
 776     fake_caustics_power: FloatProperty(
 777         name="Fake caustics power",
 778         description="Values typically range from 0.0 to 1.0 or higher. Zero is no caustics. "
 779         "Low, non-zero values give broad hot-spots while higher values give "
 780         "tighter, smaller simulated focal points",
 781         min=0.00,
 782         max=10.0,
 783         soft_min=0.00,
 784         soft_max=5.0,
 785         default=0.15,
 786     )
 787
 788     refraction_caustics: BoolProperty(
 789         name="Refractive Caustics",
 790         description="hotspots of light focused when going through the material",
 791         default=True,
 792     )
 793
 794     photons_dispersion: FloatProperty(
 795         name="Chromatic Dispersion",
 796         description="Light passing through will be separated according to wavelength. "
 797         "This ratio of refractive indices for violet to red controls how much "
 798         "the colors are spread out 1 = no dispersion, good values are 1.01 to 1.1",
 799         min=1.0000,
 800         max=10.000,
 801         soft_min=1.0000,
 802         soft_max=1.1000,
 803         precision=4,
 804         default=1.0000,
 805     )
 806
 807     photons_dispersion_samples: IntProperty(
 808         name="Dispersion Samples",
 809         description="Number of color-steps for dispersion",
 810         min=2,
 811         max=128,
 812         default=7,
 813     )
 814
 815     photons_reflection: BoolProperty(
 816         name="Reflective Photon Caustics",
 817         description="Use this to make your Sauron's ring ;-P",
 818         default=False,
 819     )
 820
 821     refraction_type: EnumProperty(
 822         items=[
 823             ("1", "Z Transparency Fake Caustics", "use fake caustics"),
 824             ("2", "Raytrace Photons Caustics", "use photons for refractive caustics"),
 825         ],
 826         name="Refraction Type:",
 827         description="use fake caustics (fast) or true photons for refractive Caustics",
 828         default="1",
 829     )
 830
 831     # ------------------------------ CustomPOV Code ------------------------------ #
 832     replacement_text: StringProperty(
 833         name="Declared name:",
 834         description="Type the variable name as declared either directly inlined "
 835         "in your custom POV code from the text editor datablock (checked as a "
 836         "source to render in it's side property panel), or this declaration can be "
 837         "from an external .inc it points at. Here, name = texture {} expected",
 838         default="",
 839     )
 840
 841     # NODES
 842
 843     def use_material_nodes_callback(self, context):
 844         """Identify if node has been added and if it is used yet or default"""
 845
 846         if hasattr(context.space_data, "tree_type"):
 847             context.space_data.tree_type = "ObjectNodeTree"
 848         mat = context.object.active_material
 849         if mat.pov.material_use_nodes:
 850             mat.use_nodes = True
 851             tree = mat.node_tree
 852             # tree.name = mat.name # XXX READONLY
 853             links = tree.links
 854             default = True
 855             if len(tree.nodes) == 2:
 856                 o = 0
 857                 m = 0
 858                 for node in tree.nodes:
 859                     if node.type in {"OUTPUT", "MATERIAL"}:
 860                         tree.nodes.remove(node)
 861                         default = True
 862                 for node in tree.nodes:
 863                     if node.bl_idname == "PovrayOutputNode":
 864                         o += 1
 865                     elif node.bl_idname == "PovrayTextureNode":
 866                         m += 1
 867                 if o == 1 and m == 1:
 868                     default = False
 869             elif len(tree.nodes) == 0:
 870                 default = True
 871             else:
 872                 default = False
 873             if default:
 874                 output = tree.nodes.new("PovrayOutputNode")
 875                 output.location = 200, 200
 876                 tmap = tree.nodes.new("PovrayTextureNode")
 877                 tmap.location = 0, 200
 878                 links.new(tmap.outputs[0], output.inputs[0])
 879                 tmap.select = True
 880                 tree.nodes.active = tmap
 881         else:
 882             mat.use_nodes = False
 883
 884     def use_texture_nodes_callback(self, context):
 885         """Identify texture nodes by filtering out output and composite ones"""
 886
 887         tex = context.object.active_material.active_texture
 888         if tex.pov.texture_use_nodes:
 889             tex.use_nodes = True
 890             if len(tex.node_tree.nodes) == 2:
 891                 for node in tex.node_tree.nodes:
 892                     if node.type in {"OUTPUT", "CHECKER"}:
 893                         tex.node_tree.nodes.remove(node)
 894         else:
 895             tex.use_nodes = False
 896
 897     def node_active_callback(self, context):
 898         """Synchronize active node with material before getting it"""
 899
 900         items = []  # XXX comment out > remove?
 901         mat = context.material
 902         mat.node_tree.nodes  # XXX comment out > remove?
 903         for node in mat.node_tree.nodes:
 904             node.select = False
 905         for node in mat.node_tree.nodes:
 906             if node.name == mat.pov.material_active_node:
 907                 node.select = True
 908                 mat.node_tree.nodes.active = node
 909
 910                 return node
 911
 912     def node_enum_callback(self, context):
 913         mat = context.material
 914         nodes = mat.node_tree.nodes
 915         return [("%s" % node.name, "%s" % node.name, "") for node in nodes]
 916
 917     def pigment_normal_callback(self, context):
 918         render = context.scene.pov.render  # XXX comment out > remove?
 919         return (
 920             [("pigment", "Pigment", ""), ("normal", "Normal", "")]
 921             # XXX Find any other such traces of hgpovray experiment > remove or deploy ?
 922             if render != "hgpovray"
 923             else [
 924                 ("pigment", "Pigment", ""),
 925                 ("normal", "Normal", ""),
 926                 ("modulation", "Modulation", ""),
 927             ]
 928         )
 929
 930     def glow_callback(self, context):
 931         scene = context.scene
 932         ob = context.object
 933         ob.pov.mesh_write_as_old = ob.pov.mesh_write_as
 934         if scene.pov.render == "uberpov" and ob.pov.glow:
 935             ob.pov.mesh_write_as = "NONE"
 936         else:
 937             ob.pov.mesh_write_as = ob.pov.mesh_write_as_old
 938
 939     material_use_nodes: BoolProperty(
 940         name="Use nodes", description="", update=use_material_nodes_callback, default=False
 941     )
 942
 943     material_active_node: EnumProperty(
 944         name="Active node", description="", items=node_enum_callback, update=node_active_callback
 945     )
 946
 947     preview_settings: BoolProperty(name="Preview Settings", description="", default=False)
 948
 949     object_preview_transform: BoolProperty(name="Transform object", description="", default=False)
 950
 951     object_preview_scale: FloatProperty(name="XYZ", min=0.5, max=2.0, default=1.0)
 952
 953     object_preview_rotate: FloatVectorProperty(
 954         name="Rotate", description="", min=-180.0, max=180.0, default=(0.0, 0.0, 0.0), subtype="XYZ"
 955     )
 956
 957     object_preview_bgcontrast: FloatProperty(name="Contrast", min=0.0, max=1.0, default=0.5)
 958
 959
 960
 961 # ------------------------------ End Old Blender Internal Props ------------------------------ #
 962
 963
 964 classes = (
 965     RenderPovSettingsMaterial,
 966 )
 967
 968
 969 def register():
 970     for cls in classes:
 971         register_class(cls)
 972
 973     bpy.types.Material.pov = PointerProperty(type=RenderPovSettingsMaterial)
 974
 975
 976 def unregister():
 977     del bpy.types.Material.pov
 978
 979     for cls in reversed(classes):
 980         unregister_class(cls)