Interface IEffectDrawer<TParticle>

Effect drawer lifecycle callbacks.

interface IEffectDrawer<TParticle extends Particle = Particle> {
    destroy?: (container: Container) => void;
    drawAfter?: (data: IShapeDrawData<TParticle>) => void;
    drawBefore?: (data: IShapeDrawData<TParticle>) => void;
    init?: (container: Container) => Promise<void>;
    isInsideCanvas?: (
        data: IParticleCanvasBoundsData<TParticle>,
    ) => boolean | IParticleCanvasBoundsResult;
    loadEffect?: (particle: TParticle) => void;
    particleInit?: (container: Container, particle: TParticle) => void;
}

Type Parameters

TParticle extends Particle = Particle

Index

Properties

destroy? drawAfter? drawBefore? init? isInsideCanvas? loadEffect? particleInit?

Properties

`Optional`destroy

destroy?: (container: Container) => void

Shape destroy function

Type Declaration

- (container: Container): void
- Parameters
  - container: Container
    the container initializing the shape
  Returns void

`Optional`drawAfter

drawAfter?: (data: IShapeDrawData<TParticle>) => void

Shape draw after function

Type Declaration

- (data: IShapeDrawData<TParticle>): void
- Parameters
  - data: IShapeDrawData<TParticle>
    the data used for drawing
  Returns void

`Optional`drawBefore

drawBefore?: (data: IShapeDrawData<TParticle>) => void

Shape draw before function

Type Declaration

- (data: IShapeDrawData<TParticle>): void
- Parameters
  - data: IShapeDrawData<TParticle>
    the data used for drawing
  Returns void

`Optional`init

init?: (container: Container) => Promise<void>

Shape init function

Type Declaration

- (container: Container): Promise<void>
- Parameters
  - container: Container
    the container initializing the shape
  Returns Promise<void>

`Optional`isInsideCanvas

isInsideCanvas?: (
data: IParticleCanvasBoundsData<TParticle>,
) => boolean | IParticleCanvasBoundsResult

Optional effect-owned canvas bounds check.

Type Declaration

- (
  data: IParticleCanvasBoundsData<TParticle>,
  ): boolean | IParticleCanvasBoundsResult
- Parameters
  - data: IParticleCanvasBoundsData<TParticle>
    the data used for bounds evaluation
  Returns boolean | IParticleCanvasBoundsResult

`Optional`loadEffect

loadEffect?: (particle: TParticle) => void

Effect load function

Type Declaration

- (particle: TParticle): void
- Parameters
  - particle: TParticle
    the particle using the shape
  Returns void

`Optional`particleInit

particleInit?: (container: Container, particle: TParticle) => void

Shape particle init function

Type Declaration

- (container: Container, particle: TParticle): void
- Parameters
  - container: Container
    the container containing the shape
  - particle: TParticle
    the particle using the shape
  Returns void