Class Canvas2DEntity<T>

constructor

• new Canvas2DEntity<T>(name, props?, action?, startTimeinMs?, durationInMs?, w?, h?): Canvas2DEntity<T>

• Creates a new Entity.

  Type Parameters

  • T

  Parameters

  • name: string

    The key or identifier for the entity.
  • Optionalprops: T

    The properties for the entity.
  • Optionalaction: ((time: number, ctx: CanvasRenderingContext2D, properties: T, sequence?: Sequence, entity?: Canvas2DEntity<T>) => void)

    The action function that defines the entity's behavior.

    • • (time, ctx, properties, sequence?, entity?): void

      • Parameters

        • time: number
        • ctx: CanvasRenderingContext2D
        • properties: T
        • Optionalsequence: Sequence
        • Optionalentity: Canvas2DEntity<T>

        Returns void

  • OptionalstartTimeinMs: number
  • OptionaldurationInMs: number
  • Optionalw: number

    The width of the entity's canvas.
  • Optionalh: number

    The height of the entity's canvas.

  Returns Canvas2DEntity<T>

Optionalaction

OptionalbarListeners

OptionalbeatListeners

canvas

ctx

OptionaldurationInMs

Optionalh

name

Optionalprops

Optionalscene

OptionalstartTimeinMs

OptionaltickListeners

OptionaltransitionIn

OptionaltransitionOut

Optionalw

addPostProcessor

• addPostProcessor(processor): void

• Adds a post-processing function to the entity.

  Parameters

  • processor: ((ctx: CanvasRenderingContext2D, sequence: Sequence) => void)

    The post-processing function to add.

    • • (ctx, sequence): void

      • Parameters

        • ctx: CanvasRenderingContext2D
        • sequence: Sequence

        Returns void

  Returns void

bindToScene

• bindToScene(scene): void

• Parameters

  • scene: Scene

  Returns void

copyToCanvas

• copyToCanvas(targetCanvas, sequence): void

• Copies the entity's canvas to the target canvas and applies post-processors.

  Parameters

  • targetCanvas: HTMLCanvasElement

    The target canvas to copy to.
  • sequence: Sequence

    The Sequence instance.

  Returns void

getScene

• getScene(): undefined | Scene

• Retrieves the Scene instance associated with the entity.

  Returns undefined | Scene

  The Sequence instance if available, otherwise null.

onBar

• onBar<T>(listener): this

• Adds an event listener for when a bar is complete.

  Type Parameters

  • T

  Parameters

  • listener: ((ts: number, count: number, propertyBag?: T) => void)

    The function to call when a bar is complete.

    • • (ts, count, propertyBag?): void

      • Parameters

        • ts: number
        • count: number
        • OptionalpropertyBag: T

        Returns void

  Returns this

  The Entity instance for chaining.

onBeat

• onBeat<T>(listener): this

• Adds an event listener for when a beat occurs.

  Type Parameters

  • T

  Parameters

  • listener: ((time: number, count: number, propertyBag?: T) => void)

    The function to call when a beat occurs.

    • • (time, count, propertyBag?): void

      • Parameters

        • time: number
        • count: number
        • OptionalpropertyBag: T

        Returns void

  Returns this

  The Entity instance for chaining.

onTick

• onTick<T>(listener): this

• Adds an event listener for when a tick occurs.

  Type Parameters

  • T

  Parameters

  • listener: ((time: number, count: number, propertyBag?: T) => void)

    The function to call when a tick occurs.

    • • (time, count, propertyBag?): void

      • Parameters

        • time: number
        • count: number
        • OptionalpropertyBag: T

        Returns void

  Returns this

  The Entity instance for chaining.

update

• update(timeStamp): void

• Updates the entity's state, clears the canvas, and calls the action function.

  Parameters

  • timeStamp: number

    The current timestamp in the animation.

  Returns void