eradiate.kernel.scene_parameter

eradiate.kernel.scene_parameter(maybe_fn=None, *, flags=<KernelSceneParameterFlags.ALL: 3>, node_type, node_id, parameter_relpath)[source]

This function wraps another one into a SceneParameter instance. It is primarily meant to be used as a decorator.

Parameters:

  • maybe_fn (callable(), optional) – A callable that takes as an argument a KernelContext instance.

  • flags (KernelSceneParameterFlags, optional) – Scene parameter flags used for filtering during a scene parameter loop.

  • node_type (type) – Type of the node that is expected to hold the parameter updated by the wrapped callable.

  • node_id (str) – ID of the node that is expected to hold the parameter updated by the wrapped callable.

  • parameter_relpath (str) – Relative path (from the looked up node) of the parameter updated by the wrapped callable.

Returns:

callable()