Class Particles

Particles manager object

Index

Constructors

Properties

availablePathGenerators checkParticlePositionPlugins effectDrawers movers pathGenerators quadTree shapeDrawers 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:94

Properties

availablePathGenerators

availablePathGenerators: Map<string, IMovePathGenerator>

checkParticlePositionPlugins

checkParticlePositionPlugins: IContainerPlugin[]

effectDrawers

effectDrawers: Map<string, IEffectDrawer<Particle>>

movers

movers: IParticleMover[]

pathGenerators

pathGenerators: Map<string, IMovePathGenerator>

quadTree

quadTree: QuadTree

The quad tree used to search particles withing ranges

shapeDrawers

shapeDrawers: Map<string, IShapeDrawer<Particle>>

updaters

updaters: IParticleUpdater[]

Accessors

count

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

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:129

clear

clear(): void
Removes all particles from the array

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

destroy

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

drawParticles

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

filter

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

find

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

get

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

init

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

initPlugins

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

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:355

redraw

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

remove

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

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:377

removeQuantity

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

setDensity

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

setLastZIndex

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

setResizeFactor

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

update

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