eradiate.kernel.SceneParameter¶

class eradiate.kernel.SceneParameter(func, flags=<KernelSceneParameterFlags.ALL: 3>, search=None, parameter_id=None)[source]¶

This class declares an Eradiate parameter in a Mitsuba scene parameter map. It holds an evaluation protocol depending on context information.

Parameters:

func (callable()) – A callable that returns the value of the parameter for a given context, with signature f(ctx: KernelContext) -> Any.
flags (KernelSceneParameterFlags, default: KernelSceneParameterFlags.ALL) – Flags specifying parameter attributes. By default, the declared parameter will pass all filters.
search (callable(), optional, default: None) – A callable that searches a Mitsuba scene tree node for a desired parameter ID, with signature f(node: mi.Object, node_relpath: str) -> Optional[str]. This is typically done with a SearchSceneParameter instance.
parameter_id (str, optional) – The full ID of the Mitsuba scene parameter to update.

Fields:

func (callable()) – A callable that returns the value of the parameter for a given context, with signature f(ctx: KernelContext) -> Any.
flags (KernelSceneParameterFlags) – Flags specifying parameter attributes.
search (callable() or None) – A callable that searches a Mitsuba scene tree node for a desired parameter ID, with signature f(node: mi.Object, node_relpath: str) -> Optional[str].
parameter_id (str or None) – The full ID of the Mitsuba scene parameter to update.