- class eradiate.scenes.surface.CentralPatchSurface(id='surface', shape=None, bsdf=_Nothing.NOTHING, patch_edges=None, patch_bsdf=_Nothing.NOTHING)#
Central patch surface [
This surface consists of a rectangular patch, described by its field parameter, with a composite reflection model composed of a background uniform component, and a central patch.
This class creates a square surface to which two BSDFs will be attached.
The two constituent surfaces
background_surfacedefine the properties of the two sections of this surface.
The size of the central surface is controlled by setting the
widthparameter of the
central_patchsurface, while the
background_surfacemust be set to
AUTOand the total width of the surface is set by the
widthof the main surface object. Note that the
widthof a surface defaults to
AUTO, which means, omitting the parameter in the
background_surfacewill yield the correct behaviour.
central_patchwidth is set to
AUTOas well it defaults to one third of the overall surface size, unless a contextual constraint (e.g. to match the size of an atmosphere or canopy) is applied.
str, optional, default:
"surface") – Identifier of the current scene element.
dict, optional, default:
None) – Shape describing the surface. This parameter may be left unset for situations in which setting its value is delegated to another component (e.g. an
Experimentinstance owning the surface object); however, if it is still unset upon kernel dictionary generation, the call to
quantityor array-like, optional) – Length of the central patch’s edges. If unset, the central patch edges will be 1/3 of the surface’s edges. Unit-enabled field (default:
BSDF) – The reflection model attached to the surface.
BSDF) – The reflection model attached to the central patch.
Traverse this scene element and collect kernel dictionary template and parameter update map contributions.
SceneTraversal) – Callback data structure storing the collected data.
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.
dict– A dictionary mapping object names to a corresponding object to be inserted in the Eradiate scene graph.
- property params#
- property template#
Kernel dictionary template contents associated with this scene element.