tsParticles - v4.1.1
    Preparing search index...

    Interface IShapeDrawer<TParticle>

    Shape drawer contract used by particle shape plugins.

    interface IShapeDrawer<TParticle extends Particle = Particle> {
        afterDraw?: (data: IShapeDrawData<TParticle>) => void;
        beforeDraw?: (data: IShapeDrawData<TParticle>) => void;
        destroy?: (container: Container) => void;
        draw: (data: IShapeDrawData<TParticle>) => void;
        getSidesCount?: (particle: TParticle) => number;
        init?: (container: Container) => Promise<void>;
        isInsideCanvas?: (
            data: IParticleCanvasBoundsData<TParticle>,
        ) => boolean | IParticleCanvasBoundsResult;
        loadShape?: (particle: TParticle) => void;
        particleDestroy?: (particle: TParticle) => void;
        particleInit?: (container: Container, particle: TParticle) => void;
    }

    Type Parameters

    Index

    Properties

    afterDraw? beforeDraw? destroy? draw getSidesCount? init? isInsideCanvas? loadShape? particleDestroy? particleInit?

    Properties

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

    Shape after draw effect function

    Type Declaration

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

    Shape before draw effect function

    Type Declaration

    destroy?: (container: Container) => void

    Shape destroy function

    Type Declaration

      • (container: Container): void

      • Parameters

        • container: Container

          the container initializing the shape

        Returns void

    draw: (data: IShapeDrawData<TParticle>) => void

    Shape draw function

    Type Declaration

    getSidesCount?: (particle: TParticle) => number

    Shape sides count function

    Type Declaration

      • (particle: TParticle): number

      • Parameters

        • particle: TParticle

          the particle using the shape

        Returns number

        the number of sides for the used shape

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

    Shape init function

    Type Declaration

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

    Optional shape-owned canvas bounds check.

    Type Declaration

    loadShape?: (particle: TParticle) => void

    Shape load function

    Type Declaration

      • (particle: TParticle): void

      • Parameters

        • particle: TParticle

          the particle using the shape

        Returns void

    particleDestroy?: (particle: TParticle) => void

    Shape particle destroy function

    Type Declaration

      • (particle: TParticle): void

      • Parameters

        • particle: TParticle

          the particle being destroyed

        Returns void

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

    Shape particle init function

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties