Interface IShapeDrawer<TParticle>

interface IShapeDrawer<TParticle> {
    afterDraw?: ((data) => void);
    destroy?: ((container) => void);
    draw: ((data) => void);
    getSidesCount?: ((particle) => number);
    init?: ((container) => Promise<void>);
    loadShape?: ((particle) => void);
    particleDestroy?: ((particle) => void);
    particleInit?: ((container, particle) => void);
    validTypes: readonly string[];
}

Type Parameters

Properties

afterDraw? destroy? draw getSidesCount? init? loadShape? particleDestroy? particleInit? validTypes

Properties

Optional afterDraw

afterDraw?: ((data) => void)

Shape after draw effect function

Type declaration

Optional destroy

destroy?: ((container) => void)

Shape destroy function

Type declaration

    • (container): void

    • Parameters

      • container: Container

        the container initializing the shape

      Returns void

draw

draw: ((data) => void)

Shape draw function

Type declaration

Optional getSidesCount

getSidesCount?: ((particle) => number)

Shape sides count function

Type declaration

    • (particle): number

    • Parameters

      • particle: TParticle

        the particle using the shape

      Returns number

Returns

the number of sides for the used shape

Optional init

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

Shape init function

Type declaration

    • (container): Promise<void>

    • Parameters

      • container: Container

        the container initializing the shape

      Returns Promise<void>

Optional loadShape

loadShape?: ((particle) => void)

Shape load function

Type declaration

    • (particle): void

    • Parameters

      • particle: TParticle

        the particle using the shape

      Returns void

Optional particleDestroy

particleDestroy?: ((particle) => void)

Shape particle destroy function

Type declaration

    • (particle): void

    • Parameters

      • particle: TParticle

        the particle being destroyed

      Returns void

Optional particleInit

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

Shape particle init function

Type declaration

    • (container, particle): void

    • Parameters

      • container: Container

        the container containing the shape

      • particle: TParticle

        the particle using the shape

      Returns void

Readonly validTypes

validTypes: readonly string[]

Settings

Member Visibility

Theme

On This Page

afterDrawdestroydrawgetSidesCountinitloadShapeparticleDestroyparticleInitvalidTypes