flow360.component.simulation.outputs.render_config.PBRMaterial#

class PBRMaterial[source]#

Bases: MaterialBase

PBRMaterial defines a physically based rendering (PBR) material.

Example

>>> PBRMaterial(color=(180, 180, 255), roughness=0.3)
type_name: Literal['PBRMaterial'] = 'PBRMaterial'#
color: Tuple[Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=255)])], Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=255)])], Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=255)])]] = [255, 255, 255]#

Basic diffuse color of the material (base color)

opacity: float = 1#

The transparency of the material 1 is fully opaque, 0 is fully transparent

Constraints:
  • ge = 0

  • le = 1

roughness: float = 0.5#

Material roughness, controls the fuzziness of reflections

Constraints:
  • ge = 0

  • le = 1

f0: Vector = (0.03, 0.03, 0.03)#

Fresnel reflection coeff. at 0 incidence angle, controls reflectivity

classmethod metal(shine=0.5, opacity=1.0)[source]#

Create a metallic PBR material.

Example

>>> PBRMaterial.metal(shine=0.8)
classmethod plastic(shine=0.5, opacity=1.0)[source]#

Create a plastic PBR material.

Example

>>> PBRMaterial.plastic(shine=0.2)