LumensalisCP.Scenes.Scene

Module Contents

Classes

Functions

API

class LumensalisCP.Scenes.Scene.Setter

Bases: object

class LumensalisCP.Scenes.Scene.SceneTaskKwargs

Bases: LumensalisCP.IOContext.TypedDict

period : LumensalisCP.IOContext.TimeInSeconds = None

name : LumensalisCP.IOContext.Optional[str] = None

class LumensalisCP.Scenes.Scene.SceneTask(task: LumensalisCP.IOContext.Callable, period: LumensalisCP.IOContext.TimeInSeconds = 0.02, name: LumensalisCP.IOContext.Optional[str] = None)

Bases: LumensalisCP.IOContext.NamedLocalIdentifiable

Initialization

property period : LumensalisCP.IOContext.TimeInSeconds

run(scene: LumensalisCP.Scenes.Scene.Scene, context: LumensalisCP.IOContext.EvaluationContext, frame: LumensalisCP.Main.Profiler.ProfileFrameBase)

class LumensalisCP.Scenes.Scene.SceneRule(target: LumensalisCP.IOContext.OutputTarget, term: LumensalisCP.IOContext.ExpressionTerm, name: LumensalisCP.IOContext.Optional[str] = None)

Bases: LumensalisCP.IOContext.NamedLocalIdentifiable, LumensalisCP.IOContext.Expression

Initialization

run(context: LumensalisCP.IOContext.EvaluationContext, frame: LumensalisCP.Main.Profiler.ProfileFrameBase)

class LumensalisCP.Scenes.Scene.Scene(*args, **kwargs)

Bases: LumensalisCP.Main.Dependents.MainChild

Initialization

nliGetContainers() → list[LumensalisCP.IOContext.NamedLocalIdentifiableContainerMixin] | None

property patterns : LumensalisCP.util.bags.NamedList[LumensalisCP.Lights.Patterns.Pattern]

addPatterns(*patterns: LumensalisCP.Lights.Patterns.Pattern)

add patterns to a scene

• Parameters: patternRefresh (float , optional) – _description_, defaults to None

addRule(target: LumensalisCP.IOContext.OutputTarget, term: LumensalisCP.IOContext.ExpressionTerm, name: LumensalisCP.IOContext.Optional[str] = None) → LumensalisCP.Scenes.Scene.SceneRule

findOutput(tag: str) → LumensalisCP.IOContext.OutputTarget

addRules(**kwargs: LumensalisCP.IOContext.ExpressionTerm)

sources() → LumensalisCP.IOContext.Mapping[str, LumensalisCP.IOContext.InputSource]

addTask(*args, **kwds: LumensalisCP.IOContext.Unpack[LumensalisCP.Scenes.Scene.SceneTaskKwargs]) → LumensalisCP.Scenes.Scene.SceneTask

addTaskDef(**kwds: LumensalisCP.Scenes.Scene.SceneTaskKwargs) → LumensalisCP.IOContext.Callable[…, LumensalisCP.IOContext.Any]

runTasks(context: LumensalisCP.IOContext.EvaluationContext)

LumensalisCP.Scenes.Scene.addSceneTask(scene: LumensalisCP.Scenes.Scene.Scene, **kwds: LumensalisCP.Scenes.Scene.SceneTaskKwargs)