PBRMaterial

class PBRMaterial

Bases: MaterialBase

PBRMaterial defines a physically based rendering (PBR) material.

Example

>>> PBRMaterial(color=(180, 180, 255), roughness=0.3)

Attributes

color: tuple[int, int, int]

Basic diffuse color of the material (base color)

Default:

[255, 255, 255]

opacity: float

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

Default:

1

roughness: float

Material roughness, controls the fuzziness of reflections

Default:

0.5

f0: Vector

Fresnel reflection coeff. at 0 incidence angle, controls reflectivity

Default:

(0.03, 0.03, 0.03)

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

classmethod metal(shine=0.5, opacity=1.0)

Create a metallic PBR material.

Example

>>> PBRMaterial.metal(shine=0.8)

classmethod plastic(shine=0.5, opacity=1.0)

Create a plastic PBR material.

Example

>>> PBRMaterial.plastic(shine=0.2)

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')