RenderOutputGroup

RenderOutputGroup#

class RenderOutputGroup[source]#

Bases: Flow360BaseModel

RenderOutputGroup for defining a render output group - i.e. a set of entities sharing a common material (display options) settings.

Example

Define two RenderOutputGroup objects, one assigning all boundaries of the uploaded geometry to a flat metallic material, and another assigning a slice and an isosurface to a material which will display a scalar field on the surface of the entity.

>>> fl.RenderOutputGroup(
...     surfaces=geometry["*"],
...     material=fl.PBRMaterial.metal(shine=0.8)
... ),
... fl.RenderOutputGroup(
...     slices=[
...         fl.Slice(name="Example slice", normal=(0, 1, 0), origin=(0, 0, 0))
...     ],
...     isosurfaces=[
...         fl.Isosurface(name="Example isosurface", iso_value=0.1, field="T")
...     ],
...     material=fl.FieldMaterial.rainbow(field="T", min_value=0, max_value=1, alpha=0.4)
... )
====

Attributes

surfaces: EntityList[Surface, MirroredSurface], optional#

List of of Surface entities.

Default:

None

slices: EntityList[Slice], optional#

List of of Slice entities.

Default:

None

isosurfaces: UniqueItemList[Isosurface], optional#

List of Isosurface entities.

Default:

None

volumes: EntityList[VoxelGrid], optional#

List of VoxelGrid entities for direct volume rendering.

Default:

None

material: PBRMaterial | FieldMaterial#

Materials settings (color, surface field, roughness etc..) to be applied to the entire group

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None