Scene2D

class Scene2D extends GeneratorSceneView2Dimplements Inspectable

Constructors​

constructor​

public override new Scene2Ddescription: FullSceneDescriptionThreadGeneratorFactoryView2D: Scene2D

Parameters

• description: FullSceneDescriptionThreadGeneratorFactoryView2D

Properties​

creationStack​

creationStack?: string

experimentalFeatures​

readonly experimentalFeatures: boolean

Whether experimental features are enabled.

lifecycleEvents​

readonly lifecycleEvents: LifecycleEvents

The scenes.LifecycleEvents of this scene.

logger​

readonly logger: Logger

meta​

readonly meta: ObjectMetaField

name​

readonly name: string

Name of the scene.

Will be passed as the second argument to the constructor.

playback​

readonly playback: PlaybackStatus

Reference to the project.

previousOnTop​

previousOnTop: SignalValueboolean

Should this scene be rendered below the previous scene during a transition?

random​

random: Random

shaders​

readonly shaders: Shaders

slides​

readonly slides: Slides

sounds​

readonly sounds: Sounds

timeEvents​

readonly timeEvents: TimeEvents

variables​

readonly variables: Variables

Accessors​

firstFrame​

public get firstFrame(): number

The frame at which this scene starts.

lastFrame​

public get lastFrame(): number

The frame at which this scene ends.

LifecycleEvents​

public get LifecycleEvents(): LifecycleEvents

The scenes.LifecycleEvents of this scene.

Deprecated

Use lifecycleEvents instead.

previous​

public get previous(): nullSceneunknown

The scene directly before this scene, or null if omitted for performance.

transitionDuration​

public get transitionDuration(): number

Scene transition duration in frames.

Methods​

canTransitionOut​

public canTransitionOut(): boolean

Is this scene in the SceneState.CanTransitionOut state?

draw​

public override drawcontext: CanvasRenderingContext2D: void

Parameters

• context: CanvasRenderingContext2D

drawOverlay​

public drawOverlayelement: unknownmatrix: DOMMatrixcontext: CanvasRenderingContext2D: void

Draw an overlay for the inspected element.

This method can be used to overlay additional information about an element on top of the animation.

Parameters

• element: unknown

  The element for which to draw an overlay.

• matrix: DOMMatrix

  A local-to-screen matrix.

• context: CanvasRenderingContext2D

  The context to draw with.

enterAfterTransitionIn​

public enterAfterTransitionIn(): void

Enter the SceneState.AfterTransitionIn state.

enterCanTransitionOut​

public enterCanTransitionOut(): void

Enter the SceneState.CanTransitionOut state.

enterInitial​

public enterInitial(): void

Enter the SceneState.Initial state.

getDetachedNodes​

public getDetachedNodes(): GeneratorNodevoidunknown

getNode​

public getNodekey: any: nullNode

Parameters

• key: any

getRealSize​

public getRealSize(): Vector2

Get the real size of this scene.

Returns the size of the scene multiplied by the resolution scale. This is the actual size of the canvas onto which the scene is rendered.

getSize​

public getSize(): Vector2

Get the size of this scene.

Usually returns this.project.getSize().

getView​

public override getView(): View2D

inspectAttributes​

public inspectAttributeselement: unknown: nullInspectedAttributes

Return the attributes of the inspected element.

This information will be displayed in the "Properties" panel.

Parameters

• element: unknown

  The element to inspect.

inspectPosition​

public inspectPositionx: numbery: number: unknown

Get a possible element to inspect at a given position.

Parameters

• x: number

  The x coordinate.

• y: number

  The y coordinate.

isAfterTransitionIn​

public isAfterTransitionIn(): boolean

Is this scene in the SceneState.AfterTransitionIn state?

isCached​

public isCached(): boolean

Is this scene cached?

Used only by GeneratorScene. Seeking through a project that contains at least one uncached scene will log a warning to the console.

Should always return true.

isFinished​

public isFinished(): boolean

Is this scene in the SceneState.Finished state?

next​

public override next(): Promisevoid

recalculate​

public recalculatesetFrame: frame: number => void: Promisevoid

Recalculate the scene.

The task of this method is to calculate new timings stored in the cache. When this method is invoked, this.project.frame is set to the frame at which this scene should start (firstFrame).

At the end of execution, this method should set this.project.frame to the frame at which this scene ends (lastFrame).

Should trigger onRecalculated.

Parameters

• setFrame: frame: number => void

registerNode​

public registerNodenode: Nodekey?: string: string() => void

Parameters

• node: Node
• key?: string

reload​

public reloaddescription?: SceneDescriptionReloadThreadGeneratorFactoryView2D: void

Reload the scene.

This method is called whenever something related to this scene has changed: time events, source code, metadata, etc.

Should trigger onReloaded.

Parameters

• description?: SceneDescriptionReloadThreadGeneratorFactoryView2D

  If present, an updated version of the description.

render​

public rendercontext: CanvasRenderingContext2D: Promisevoid

Render the scene onto a canvas.

Parameters

• context: CanvasRenderingContext2D

  The context to used when rendering.

reset​

public override resetpreviousScene?: Sceneunknown: Promisevoid

Parameters

• previousScene?: Sceneunknown

transformMousePosition​

public transformMousePositionx: numbery: number: nullVector2

Transform the absolute mouse coordinates into the scene's coordinate system.

Parameters

• x: number

  The x coordinate.

• y: number

  The y coordinate.

update​

public update(): void

Update the view.

Invoked after each step of the main generator. Can be used for calculating layout.

Can modify the state of the view.

validateInspection​

public validateInspectionelement: unknown: unknown

Check if the inspected element is still valid.

If a scene destroys and recreates its components upon every reset, the reference may no longer be valid. Even though the component is still present. This method should check that and return a new reference.

Parameters

• element: unknown

  The element to validate.

Events​

onCacheChanged​

public get onCacheChanged(): SubscribableValueEventCachedSceneData

Triggered when the cached data changes.

onRecalculated​

public get onRecalculated(): SubscribablevoidEventHandlervoid

Triggered after scene is recalculated.

onReloaded​

public get onReloaded(): SubscribablevoidEventHandlervoid

Triggered when the scene is reloaded.

onRenderLifecycle​

public get onRenderLifecycle(): SubscribableSceneRenderEventCanvasRenderingContext2DEventHandlerSceneRenderEventCanvasRenderingContext2D

Triggered at various stages of the render lifecycle with an event title and a Context2D.

onReset​

public get onReset(): SubscribablevoidEventHandlervoid

Triggered when the scene is reset.

onThreadChanged​

public get onThreadChanged(): SubscribableValueEventnullThread

Triggered when the main thread changes.