Class Particles

Particles manager object

Index

Constructors

Properties

movers quadTree updaters

Accessors

Methods

addParticle clear destroy drawParticles filter find get init initPlugins push redraw remove removeAt removeQuantity setDensity setLastZIndex setResizeFactor update

Constructors

constructor

new Particles(engine: Engine, container: Container): Particles
Parameters
- engine: Engine
- container: Container
Returns Particles
- Defined in Core/Particles.ts:75

Properties

movers

movers: IParticleMover[]

quadTree

quadTree: QuadTree

The quad tree used to search particles withing ranges

updaters

updaters: IParticleUpdater[]

Accessors

count

get count(): number
Returns number
- Defined in Core/Particles.ts:96

Methods

addParticle

addParticle(
    position?: ICoordinates,
    overrideOptions?: RecursivePartial<IParticlesOptions>,
    group?: string,
    initializer?: (particle: Particle) => boolean,
): Particle | undefined
Parameters
- Optionalposition: ICoordinates
- OptionaloverrideOptions: RecursivePartial<IParticlesOptions>
- Optionalgroup: string
- Optionalinitializer: (particle: Particle) => boolean
Returns Particle | undefined
- Defined in Core/Particles.ts:100

clear

clear(): void
Removes all particles from the array

Returns void
- Defined in Core/Particles.ts:136

destroy

destroy(): void
Returns void
- Defined in Core/Particles.ts:142

drawParticles

drawParticles(delta: IDelta): void
Parameters
- delta: IDelta
Returns void
- Defined in Core/Particles.ts:149

filter

filter(condition: (particle: Particle) => boolean): Particle[]
Parameters
- condition: (particle: Particle) => boolean
Returns Particle[]
- Defined in Core/Particles.ts:155

find

find(condition: (particle: Particle) => boolean): Particle | undefined
Parameters
- condition: (particle: Particle) => boolean
Returns Particle | undefined
- Defined in Core/Particles.ts:159

get

get(index: number): Particle | undefined
Parameters
- index: number
Returns Particle | undefined
- Defined in Core/Particles.ts:163

init

init(): Promise<void>
Returns Promise<void>
- Defined in Core/Particles.ts:168

initPlugins

initPlugins(): Promise<void>
Returns Promise<void>
- Defined in Core/Particles.ts:215

push

push(
    nb: number,
    position?: ICoordinates,
    overrideOptions?: RecursivePartial<IParticlesOptions>,
    group?: string,
): void
Parameters
- nb: number
- Optionalposition: ICoordinates
- OptionaloverrideOptions: RecursivePartial<IParticlesOptions>
- Optionalgroup: string
Returns void
- Defined in Core/Particles.ts:230

redraw

redraw(): Promise<void>
Returns Promise<void>
- Defined in Core/Particles.ts:241

remove

remove(particle: Particle, group?: string, override?: boolean): void
Parameters
- particle: Particle
- Optionalgroup: string
- Optionaloverride: boolean
Returns void
- Defined in Core/Particles.ts:248

removeAt

removeAt(
    index: number,
    quantity?: number,
    group?: string,
    override?: boolean,
): void
Parameters
- index: number
- quantity: number = defaultRemoveQuantity
- Optionalgroup: string
- Optionaloverride: boolean
Returns void
- Defined in Core/Particles.ts:252

removeQuantity

removeQuantity(quantity: number, group?: string): void
Parameters
- quantity: number
- Optionalgroup: string
Returns void
- Defined in Core/Particles.ts:267

setDensity

setDensity(): void
Returns void
- Defined in Core/Particles.ts:271

setLastZIndex

setLastZIndex(zIndex: number): void
Parameters
- zIndex: number
Returns void
- Defined in Core/Particles.ts:298

setResizeFactor

setResizeFactor(factor: IDimension): void
Parameters
- factor: IDimension
Returns void
- Defined in Core/Particles.ts:303

update

update(delta: IDelta): void
Parameters
- delta: IDelta
Returns void
- Defined in Core/Particles.ts:307