eradiate.scenes.bsdfs.CheckerboardBSDF

eradiate.scenes.bsdfs.CheckerboardBSDF#

class eradiate.scenes.bsdfs.CheckerboardBSDF(id=None, reflectance_a=0.2, reflectance_b=0.8, scale_pattern=None)[source]#

Bases: BSDF

Checkerboard BSDF [checkerboard].

This class defines a Lambertian BSDF textured with a checkerboard pattern.

Parameters:

id (str, optional) – Identifier of the current scene element.
reflectance_a (Spectrum or dict or float, default: 0.2) – Reflectance spectrum. Can be initialized with a dictionary processed by spectrum_factory.
reflectance_b (Spectrum or dict or float, default: 0.8) – Reflectance spectrum. Can be initialized with a dictionary processed by spectrum_factory.
scale_pattern (float, optional) – Scaling factor for the checkerboard pattern. The higher the value, the more checkerboard patterns will fit on the surface to which this reflection model is attached.

Fields:

id (str or None) – Identifier of the current scene element.
reflectance_a (Spectrum) – Reflectance spectrum.
reflectance_b (Spectrum) – Reflectance spectrum.
scale_pattern (float or None) – Scaling factor for the checkerboard pattern.

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.