render_povray/particles_properties.py

   1 # SPDX-FileCopyrightText: 2022 Blender Foundation
   2 #
   3 # SPDX-License-Identifier: GPL-2.0-or-later
   4
   5 """Declare shading properties exported to POV textures."""
   6 import bpy
   7 from bpy.utils import register_class, unregister_class
   8 from bpy.types import PropertyGroup
   9 from bpy.props import (
  10     StringProperty,
  11     BoolProperty,
  12     FloatProperty,
  13     PointerProperty,
  14 )
  15
  16
  17 class MaterialStrandSettings(PropertyGroup):
  18     """Declare strand properties controllable in UI and translated to POV."""
  19
  20     bl_description = ("Strand settings for the material",)
  21
  22     blend_distance: FloatProperty(
  23         name="Distance",
  24         description="Worldspace distance over which to blend in the surface normal",
  25         min=0.0,
  26         max=10.0,
  27         soft_min=0.0,
  28         soft_max=10.0,
  29         default=0.0,
  30         precision=3,
  31     )
  32
  33     root_size: FloatProperty(
  34         name="Root",
  35         description="Start size of strands in pixels or Blender units",
  36         min=0.25,
  37         default=1.0,
  38         precision=5,
  39     )
  40
  41     shape: FloatProperty(
  42         name="Shape",
  43         description="Positive values make strands rounder, negative ones make strands spiky",
  44         min=-0.9,
  45         max=0.9,
  46         default=0.0,
  47         precision=3,
  48     )
  49
  50     size_min: FloatProperty(
  51         name="Minimum",
  52         description="Minimum size of strands in pixels",
  53         min=0.001,
  54         max=10.0,
  55         default=1.0,
  56         precision=3,
  57     )
  58
  59     tip_size: FloatProperty(
  60         name="Tip",
  61         description="End size of strands in pixels or Blender units",
  62         min=0.0,
  63         default=1.0,
  64         precision=5,
  65     )
  66
  67     use_blender_units: BoolProperty(
  68         name="Blender Units",
  69         description="Use Blender units for widths instead of pixels",
  70         default=False,
  71     )
  72
  73     use_surface_diffuse: BoolProperty(
  74         name="Surface diffuse",
  75         description="Make diffuse shading more similar to shading the surface",
  76         default=False,
  77     )
  78
  79     use_tangent_shading: BoolProperty(
  80         name="Tangent Shading",
  81         description="Use direction of strands as normal for tangent-shading",
  82         default=True,
  83     )
  84
  85     uv_layer: StringProperty(
  86         name="UV Layer",
  87         # icon="GROUP_UVS",
  88         description="Name of UV map to override",
  89         default="",
  90     )
  91
  92     width_fade: FloatProperty(
  93         name="Width Fade",
  94         description="Transparency along the width of the strand",
  95         min=0.0,
  96         max=2.0,
  97         default=0.0,
  98         precision=3,
  99     )
 100
 101     # halo
 102
 103     # Halo settings for the material
 104     # Type: MaterialHalo, (readonly, never None)
 105
 106
 107     # darkness
 108
 109     # Minnaert darkness
 110     # Type: float in [0, 2], default 0.0
 111
 112     # diffuse_color
 113
 114     # Diffuse color of the material
 115     # Type: float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
 116
 117     # diffuse_fresnel
 118
 119     # Power of Fresnel
 120     # Type: float in [0, 5], default 0.0
 121
 122     # diffuse_fresnel_factor
 123
 124     # Blending factor of Fresnel
 125     # Type: float in [0, 5], default 0.0
 126
 127     # diffuse_intensity
 128
 129     # Amount of diffuse reflection
 130     # Type: float in [0, 1], default 0.0
 131
 132     # diffuse_ramp
 133
 134     # Color ramp used to affect diffuse shading
 135     # Type: ColorRamp, (readonly)
 136
 137     # diffuse_ramp_blend
 138
 139     # Blending method of the ramp and the diffuse color
 140     # Type: enum in [‘MIX’, ‘ADD’, ‘MULTIPLY’, ‘SUBTRACT’, ‘SCREEN’, ‘DIVIDE’, ‘DIFFERENCE’, ‘DARKEN’, ‘LIGHTEN’, ‘OVERLAY’, ‘DODGE’, ‘BURN’, ‘HUE’, ‘SATURATION’, ‘VALUE’, ‘COLOR’, ‘SOFT_LIGHT’, ‘LINEAR_LIGHT’], default ‘MIX’
 141
 142     # diffuse_ramp_factor
 143
 144     # Blending factor (also uses alpha in Colorband)
 145     # Type: float in [0, 1], default 0.0
 146
 147     # diffuse_ramp_input
 148
 149     # How the ramp maps on the surface
 150     # Type: enum in [‘SHADER’, ‘ENERGY’, ‘NORMAL’, ‘RESULT’], default ‘SHADER’
 151
 152     # diffuse_shader
 153
 154     # LAMBERT Lambert, Use a Lambertian shader.
 155     # OREN_NAYAR Oren-Nayar, Use an Oren-Nayar shader.
 156     # TOON Toon, Use a toon shader.
 157     # MINNAERT Minnaert, Use a Minnaert shader.
 158     # FRESNEL Fresnel, Use a Fresnel shader.
 159
 160     # Type: enum in [‘LAMBERT’, ‘OREN_NAYAR’, ‘TOON’, ‘MINNAERT’, ‘FRESNEL’], default ‘LAMBERT’
 161
 162     # diffuse_toon_size
 163
 164     # Size of diffuse toon area
 165     # Type: float in [0, 3.14], default 0.0
 166
 167     # diffuse_toon_smooth
 168
 169     # Smoothness of diffuse toon area
 170     # Type: float in [0, 1], default 0.0
 171
 172     # emit
 173
 174     # Amount of light to emit
 175     # Type: float in [0, inf], default 0.0
 176
 177     # halo
 178
 179     # Halo settings for the material
 180     # Type: MaterialHalo, (readonly, never None)
 181
 182     # invert_z
 183
 184     # Render material’s faces with an inverted Z buffer (scanline only)
 185     # Type: boolean, default False
 186
 187     # light_group
 188
 189     # Limit lighting to lamps in this Group
 190     # Type: Group
 191
 192     # line_color
 193
 194     # Line color used for Freestyle line rendering
 195     # Type: float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)
 196
 197     # line_priority
 198
 199     # The line color of a higher priority is used at material boundaries
 200     # Type: int in [0, 32767], default 0
 201
 202     # mirror_color
 203
 204     # Mirror color of the material
 205     # Type: float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
 206
 207     # node_tree
 208
 209     # Node tree for node based materials
 210     # Type: NodeTree, (readonly)
 211
 212     # offset_z
 213
 214     # Give faces an artificial offset in the Z buffer for Z transparency
 215     # Type: float in [-inf, inf], default 0.0
 216
 217     # paint_active_slot
 218
 219     # Index of active texture paint slot
 220     # Type: int in [0, 32767], default 0
 221
 222     # paint_clone_slot
 223
 224     # Index of clone texture paint slot
 225     # Type: int in [0, 32767], default 0
 226
 227     # pass_index
 228
 229     # Index number for the “Material Index” render pass
 230     # Type: int in [0, 32767], default 0
 231
 232     # physics
 233
 234     # Game physics settings
 235     # Type: MaterialPhysics, (readonly, never None)
 236
 237     # preview_render_type
 238
 239     # Type of preview render
 240
 241     # FLAT Flat, Flat XY plane.
 242     # SPHERE Sphere, Sphere.
 243     # CUBE Cube, Cube.
 244     # MONKEY Monkey, Monkey.
 245     # HAIR Hair, Hair strands.
 246     # SPHERE_A World Sphere, Large sphere with sky.
 247
 248     # Type: enum in [‘FLAT’, ‘SPHERE’, ‘CUBE’, ‘MONKEY’, ‘HAIR’, ‘SPHERE_A’], default ‘FLAT’
 249
 250     # roughness
 251
 252     # Oren-Nayar Roughness
 253     # Type: float in [0, 3.14], default 0.0
 254
 255     # shadow_buffer_bias
 256
 257     # Factor to multiply shadow buffer bias with (0 is ignore)
 258     # Type: float in [0, 10], default 0.0
 259
 260     # shadow_cast_alpha
 261
 262     # Shadow casting alpha, in use for Irregular and Deep shadow buffer
 263     # Type: float in [0.001, 1], default 0.0
 264
 265     # shadow_only_type
 266
 267     # How to draw shadows
 268
 269     # SHADOW_ONLY_OLD Shadow and Distance, Old shadow only method.
 270     # SHADOW_ONLY Shadow Only, Improved shadow only method.
 271     # SHADOW_ONLY_SHADED Shadow and Shading, Improved shadow only method which also renders lightless areas as shadows.
 272
 273     # Type: enum in [‘SHADOW_ONLY_OLD’, ‘SHADOW_ONLY’, ‘SHADOW_ONLY_SHADED’], default ‘SHADOW_ONLY_OLD’
 274
 275     # shadow_ray_bias
 276
 277     # Shadow raytracing bias to prevent terminator problems on shadow boundary
 278     # Type: float in [0, 0.25], default 0.0
 279
 280     # specular_color
 281
 282     # Specular color of the material
 283     # Type: float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
 284
 285     # specular_hardness
 286
 287     # How hard (sharp) the specular reflection is
 288     # Type: int in [1, 511], default 0
 289
 290     # specular_intensity
 291
 292     # How intense (bright) the specular reflection is
 293     # Type: float in [0, 1], default 0.0
 294
 295     # specular_ior
 296
 297     # Specular index of refraction
 298     # Type: float in [1, 10], default 0.0
 299
 300     # specular_ramp
 301
 302     # Color ramp used to affect specular shading
 303     # Type: ColorRamp, (readonly)
 304
 305     # specular_ramp_blend
 306
 307     # Blending method of the ramp and the specular color
 308     # Type: enum in [‘MIX’, ‘ADD’, ‘MULTIPLY’, ‘SUBTRACT’, ‘SCREEN’, ‘DIVIDE’, ‘DIFFERENCE’, ‘DARKEN’, ‘LIGHTEN’, ‘OVERLAY’, ‘DODGE’, ‘BURN’, ‘HUE’, ‘SATURATION’, ‘VALUE’, ‘COLOR’, ‘SOFT_LIGHT’, ‘LINEAR_LIGHT’], default ‘MIX’
 309
 310     # specular_ramp_factor
 311
 312     # Blending factor (also uses alpha in Colorband)
 313     # Type: float in [0, 1], default 0.0
 314
 315     # specular_ramp_input
 316
 317     # How the ramp maps on the surface
 318     # Type: enum in [‘SHADER’, ‘ENERGY’, ‘NORMAL’, ‘RESULT’], default ‘SHADER’
 319     # specular_shader
 320
 321     # COOKTORR CookTorr, Use a Cook-Torrance shader.
 322     # PHONG Phong, Use a Phong shader.
 323     # BLINN Blinn, Use a Blinn shader.
 324     # TOON Toon, Use a toon shader.
 325     # WARDISO WardIso, Use a Ward anisotropic shader.
 326
 327     # Type: enum in [‘COOKTORR’, ‘PHONG’, ‘BLINN’, ‘TOON’, ‘WARDISO’], default ‘COOKTORR’
 328
 329     # specular_slope
 330
 331     # The standard deviation of surface slope
 332     # Type: float in [0, 0.4], default 0.0
 333
 334     # specular_toon_size
 335
 336     # Size of specular toon area
 337     # Type: float in [0, 1.53], default 0.0
 338
 339     # specular_toon_smooth
 340
 341     # Smoothness of specular toon area
 342     # Type: float in [0, 1], default 0.0
 343
 344     # strand
 345
 346     # Strand settings for the material
 347     # Type: MaterialStrand, (readonly, never None)
 348
 349     # subsurface_scattering
 350
 351     # Subsurface scattering settings for the material
 352     # Type: MaterialSubsurfaceScattering, (readonly, never None)
 353
 354     # texture_paint_images
 355
 356     # Texture images used for texture painting
 357     # Type: bpy_prop_collection of Image, (readonly)
 358
 359     # texture_paint_slots
 360
 361     # Texture slots defining the mapping and influence of textures
 362     # Type: bpy_prop_collection of TexPaintSlot, (readonly)
 363
 364     # texture_slots
 365
 366     # Texture slots defining the mapping and influence of textures
 367     # Type: MaterialTextureSlots bpy_prop_collection of MaterialTextureSlot, (readonly)
 368
 369     # type
 370
 371     # Material type defining how the object is rendered
 372
 373     # SURFACE Surface, Render object as a surface.
 374     # WIRE Wire, Render the edges of faces as wires (not supported in raytracing).
 375     # VOLUME Volume, Render object as a volume.
 376     # HALO Halo, Render object as halo particles.
 377
 378     # Type: enum in [‘SURFACE’, ‘WIRE’, ‘VOLUME’, ‘HALO’], default ‘SURFACE’
 379
 380     # use_cast_shadows
 381
 382     # Allow this material to cast shadows
 383     # Type: boolean, default False
 384
 385     # use_cast_shadows_only
 386
 387     # Make objects with this material appear invisible (not rendered), only casting shadows
 388     # Type: boolean, default False
 389
 390     # use_cubic
 391
 392     # Use cubic interpolation for diffuse values, for smoother transitions
 393     # Type: boolean, default False
 394
 395     # use_diffuse_ramp
 396
 397     # Toggle diffuse ramp operations
 398     # Type: boolean, default False
 399
 400     # use_face_texture
 401
 402     # Replace the object’s base color with color from UV map image textures
 403     # Type: boolean, default False
 404
 405     # use_face_texture_alpha
 406
 407     # Replace the object’s base alpha value with alpha from UV map image textures
 408     # Type: boolean, default False
 409
 410     # use_full_oversampling
 411
 412     # Force this material to render full shading/textures for all anti-aliasing samples
 413     # Type: boolean, default False
 414
 415     # use_light_group_exclusive
 416
 417     # Material uses the light group exclusively - these lamps are excluded from other scene lighting
 418     # Type: boolean, default False
 419
 420     # use_light_group_local
 421
 422     # When linked in, material uses local light group with the same name
 423     # Type: boolean, default False
 424
 425     # use_mist
 426
 427     # Use mist with this material (in world settings)
 428     # Type: boolean, default False
 429
 430     # use_nodes
 431
 432     # Use shader nodes to render the material
 433     # Type: boolean, default False
 434
 435     # use_object_color
 436
 437     # Modulate the result with a per-object color
 438     # Type: boolean, default False
 439
 440     # use_only_shadow
 441
 442     # Render shadows as the material’s alpha value, making the material transparent except for shadowed areas
 443     # Type: boolean, default False
 444
 445     # use_ray_shadow_bias
 446
 447     # Prevent raytraced shadow errors on surfaces with smooth shaded normals (terminator problem)
 448     # Type: boolean, default False
 449
 450     # use_raytrace
 451
 452     # Include this material and geometry that uses it in raytracing calculations
 453     # Type: boolean, default False
 454
 455     # use_shadeless
 456
 457     # Make this material insensitive to light or shadow
 458     # Type: boolean, default False
 459
 460     # use_shadows
 461
 462     # Allow this material to receive shadows
 463     # Type: boolean, default False
 464
 465     # use_sky
 466
 467     # Render this material with zero alpha, with sky background in place (scanline only)
 468     # Type: boolean, default False
 469
 470     # use_specular_ramp
 471
 472     # Toggle specular ramp operations
 473     # Type: boolean, default False
 474
 475     # use_tangent_shading
 476
 477     # Use the material’s tangent vector instead of the normal for shading - for anisotropic shading effects
 478     # Type: boolean, default False
 479
 480     # use_textures
 481
 482     # Enable/Disable each texture
 483     # Type: boolean array of 18 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False)
 484
 485     # use_transparency
 486
 487     # Render material as transparent
 488     # Type: boolean, default False
 489
 490     # use_transparent_shadows
 491
 492     # Allow this object to receive transparent shadows cast through other objects
 493     # Type: boolean, default False
 494
 495     # use_uv_project
 496
 497     # Use to ensure UV interpolation is correct for camera projections (use with UV project modifier)
 498     # Type: boolean, default False
 499
 500     # use_vertex_color_light
 501
 502     # Add vertex colors as additional lighting
 503     # Type: boolean, default False
 504
 505     # use_vertex_color_paint
 506
 507     # Replace object base color with vertex colors (multiply with ‘texture face’ face assigned textures)
 508     # Type: boolean, default False
 509
 510     # volume
 511
 512     # Volume settings for the material
 513     # Type: MaterialVolume, (readonly, never None)
 514     """
 515     (mat.type in {'SURFACE', 'WIRE', 'VOLUME'})
 516      "use_transparency")
 517
 518
 519
 520     mat.use_transparency and mat.pov.transparency_method == 'Z_TRANSPARENCY'
 521
 522
 523
 524
 525             col.prop(mat, "use_raytrace")
 526             col.prop(mat, "use_full_oversampling")
 527
 528             sub.prop(mat, "use_sky")
 529
 530
 531             col.prop(mat, "use_cast_shadows", text="Cast")
 532             col.prop(mat, "use_cast_shadows_only", text="Cast Only")
 533             col.prop(mat, "use_cast_buffer_shadows")
 534
 535             sub.active = mat.use_cast_buffer_shadows
 536             sub.prop(mat, "shadow_cast_alpha", text="Casting Alpha")
 537             col.prop(mat, "use_cast_approximate")
 538
 539
 540
 541             col.prop(mat, "diffuse_color", text="")
 542
 543             sub.active = (not mat.use_shadeless)
 544
 545             sub.prop(mat, "diffuse_intensity", text="Intensity")
 546
 547
 548             col.prop(mat, "diffuse_shader", text="")
 549             col.prop(mat, "use_diffuse_ramp", text="Ramp")
 550
 551
 552             if mat.diffuse_shader == 'OREN_NAYAR':
 553                 col.prop(mat, "roughness")
 554             elif mat.diffuse_shader == 'MINNAERT':
 555                 col.prop(mat, "darkness")
 556             elif mat.diffuse_shader == 'TOON':
 557
 558                 row.prop(mat, "diffuse_toon_size", text="Size")
 559                 row.prop(mat, "diffuse_toon_smooth", text="Smooth")
 560             elif mat.diffuse_shader == 'FRESNEL':
 561
 562                 row.prop(mat, "diffuse_fresnel", text="Fresnel")
 563                 row.prop(mat, "diffuse_fresnel_factor", text="Factor")
 564
 565             if mat.use_diffuse_ramp:
 566
 567                 col.template_color_ramp(mat, "diffuse_ramp", expand=True)
 568
 569
 570
 571                 row.prop(mat, "diffuse_ramp_input", text="Input")
 572                 row.prop(mat, "diffuse_ramp_blend", text="Blend")
 573
 574                 col.prop(mat, "diffuse_ramp_factor", text="Factor")
 575
 576
 577
 578
 579             col.prop(mat, "specular_color", text="")
 580             col.prop(mat, "specular_intensity", text="Intensity")
 581
 582             col.prop(mat, "specular_shader", text="")
 583             col.prop(mat, "use_specular_ramp", text="Ramp")
 584
 585             if mat.pov.specular_shader in {'COOKTORR', 'PHONG'}:
 586                 col.prop(mat, "specular_hardness", text="Hardness")
 587             elif mat.pov.specular_shader == 'BLINN':
 588
 589                 row.prop(mat, "specular_hardness", text="Hardness")
 590                 row.prop(mat, "specular_ior", text="IOR")
 591             elif mat.pov.specular_shader == 'WARDISO':
 592                 col.prop(mat, "specular_slope", text="Slope")
 593             elif mat.pov.specular_shader == 'TOON':
 594
 595                 row.prop(mat, "specular_toon_size", text="Size")
 596                 row.prop(mat, "specular_toon_smooth", text="Smooth")
 597
 598             if mat.use_specular_ramp:
 599                 layout.separator()
 600                 layout.template_color_ramp(mat, "specular_ramp", expand=True)
 601                 layout.separator()
 602
 603                 row = layout.row()
 604                 row.prop(mat, "specular_ramp_input", text="Input")
 605                 row.prop(mat, "specular_ramp_blend", text="Blend")
 606
 607                 layout.prop(mat, "specular_ramp_factor", text="Factor")
 608
 609
 610     XXX remove unused props and relayout as done for transparent sky
 611
 612
 613     class MATERIAL_PT_halo(MaterialButtonsPanel, Panel):
 614         bl_label = "Halo"
 615         COMPAT_ENGINES = {'BLENDER_RENDER'}
 616
 617         @classmethod
 618         def poll(cls, context):
 619             mat = context.material
 620             engine = context.scene.render.engine
 621             return mat and (mat.type == 'HALO') and (engine in cls.COMPAT_ENGINES)
 622
 623         def draw(self, context):
 624             layout = self.layout
 625
 626             mat = context.material  # don't use node material
 627             halo = mat.pov.halo
 628
 629             def number_but(layout, toggle, number, name, color):
 630                 row = layout.row(align=True)
 631                 row.prop(halo, toggle, text="")
 632                 sub = row.column(align=True)
 633                 sub.active = getattr(halo, toggle)
 634                 sub.prop(halo, number, text=name, translate=False)
 635                 if not color == "":
 636                     sub.prop(mat, color, text="")
 637
 638             split = layout.split()
 639
 640             col = split.column()
 641             col.prop(mat, "alpha")
 642             col.prop(mat, "diffuse_color", text="")
 643             col.prop(halo, "seed")
 644
 645             col = split.column()
 646             col.prop(halo, "size")
 647             col.prop(halo, "hardness")
 648             col.prop(halo, "add")
 649
 650             layout.label(text="Options:")
 651
 652             split = layout.split()
 653             col = split.column()
 654             col.prop(halo, "use_texture")
 655             col.prop(halo, "use_vertex_normal")
 656             col.prop(halo, "use_extreme_alpha")
 657             col.prop(halo, "use_shaded")
 658             col.prop(halo, "use_soft")
 659
 660             col = split.column()
 661             number_but(col, "use_ring", "ring_count", iface_("Rings"), "mirror_color")
 662             number_but(col, "use_lines", "line_count", iface_("Lines"), "specular_color")
 663             number_but(col, "use_star", "star_tip_count", iface_("Star Tips"), "")
 664
 665
 666     class MATERIAL_PT_flare(MaterialButtonsPanel, Panel):
 667         bl_label = "Flare"
 668         COMPAT_ENGINES = {'BLENDER_RENDER'}
 669
 670         @classmethod
 671         def poll(cls, context):
 672             mat = context.material
 673             engine = context.scene.render.engine
 674             return mat and (mat.type == 'HALO') and (engine in cls.COMPAT_ENGINES)
 675
 676         def draw_header(self, context):
 677             halo = context.material.pov.halo
 678
 679             self.layout.prop(halo, "use_flare_mode", text="")
 680
 681         def draw(self, context):
 682             layout = self.layout
 683
 684             mat = context.material  # don't use node material
 685             halo = mat.pov.halo
 686
 687             layout.active = halo.use_flare_mode
 688
 689             split = layout.split()
 690
 691             col = split.column()
 692             col.prop(halo, "flare_size", text="Size")
 693             col.prop(halo, "flare_boost", text="Boost")
 694             col.prop(halo, "flare_seed", text="Seed")
 695
 696             col = split.column()
 697             col.prop(halo, "flare_subflare_count", text="Subflares")
 698             col.prop(halo, "flare_subflare_size", text="Subsize")
 699
 700     """
 701
 702
 703 classes = (
 704     MaterialStrandSettings,
 705 )
 706
 707
 708 def register():
 709     for cls in classes:
 710         register_class(cls)
 711
 712     bpy.types.Material.strand = PointerProperty(type=MaterialStrandSettings)
 713
 714
 715 def unregister():
 716     del bpy.types.Material.strand
 717
 718     for cls in reversed(classes):
 719         unregister_class(cls)