eradiate.scenes.biosphere.MeshTree

eradiate.scenes.biosphere.MeshTree#

class eradiate.scenes.biosphere.MeshTree(id='mesh_tree', mesh_tree_elements=NOTHING)[source]#

Bases: Tree

A container class for mesh based tree-like objects in canopies.

It holds one or more triangulated meshes and corresponding BSDFs, representing the tree.

The mesh will be interpreted in local coordinates and should be used in an InstancedCanopyElement to place at arbitrary positions in a scene.

Parameters:

id (str, optional, default: "mesh_tree") – Identifier of the current scene element.
mesh_tree_elements (list of (.InstancedCanopyElement | dict), default: []) – List of CanopyElement defining the canopy. Can be initialized with a InstancedCanopyElement, which will be automatically wrapped into a list. Dictionary-based specifications are allowed as well.

Fields:

id (str or None) – Identifier of the current scene element.
mesh_tree_elements (list of InstancedCanopyElement) – List of CanopyElement defining the canopy.

traverse(callback)#

Traverse this scene element and collect kernel dictionary template and parameter update map contributions.

Parameters:: callback (SceneTraversal) – Callback data structure storing the collected data.

update()#: Enforce internal state consistency. This method should be called when fields are modified. It is automatically called as a post-init step.

property objects#

Map of child objects associated with this scene element.

Returns:: dict – A dictionary mapping object names to a corresponding object to be inserted in the Eradiate scene graph.

property params#

Returns:: dict[str, UpdateParameter] or None – A dictionary mapping parameter paths, consisting of dot-separated strings, to a corresponding update protocol.