Class Particles

Particles manager object

Hierarchy

Particles

Index

Constructors

Properties

#engine array freqs interactionManager lastZIndex limit movers needsSort nextId pushing quadTree updaters zArray

Accessors

Constructors

constructor

new Particles(engine: Engine, container: Container): Particles
Parameters
- engine: Engine
- container: Container
Returns Particles

Properties

`Private` `Readonly` #engine

#engine: Engine

array

array: Particle[]

All the particles used in canvas

`Private` `Readonly` freqs

freqs: IParticlesFrequencies

`Private` `Readonly` interactionManager

interactionManager: InteractionManager

lastZIndex

lastZIndex: number

limit

limit: number

movers

movers: IParticleMover[]

needsSort

needsSort: boolean

`Private` nextId

nextId: number

`Optional` pushing

pushing?: boolean

quadTree

quadTree: QuadTree

The quad tree used to search particles withing ranges

updaters

updaters: IParticleUpdater[]

zArray

zArray: Particle[]

Accessors

count

get count(): number
Returns number

Methods

addManualParticles

addManualParticles(): void
Returns void

addParticle

addParticle(position?: ICoordinates, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string): undefined | Particle
Parameters
- Optional position: ICoordinates
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
Returns undefined | Particle

addSplitParticle

addSplitParticle(parent: Particle, splitParticlesOptions?: RecursivePartial<IParticlesOptions>): undefined | Particle
Parameters
- parent: Particle
- Optional splitParticlesOptions: RecursivePartial<IParticlesOptions>
Returns undefined | Particle

`Private` applyDensity

applyDensity(options: IParticlesOptions, manualCount: number, group?: string): void
Parameters
- options: IParticlesOptions
- manualCount: number
- Optional group: string
Returns void

clear

clear(): void
Removes all particles from the array

Returns void

destroy

destroy(): void
Returns void

draw

draw(delta: IDelta): Promise<void>
Parameters
- delta: IDelta
Returns Promise<void>

getLinkFrequency

getLinkFrequency(p1: IParticle, p2: IParticle): number
Parameters
- p1: IParticle
- p2: IParticle
Returns number

getTriangleFrequency

getTriangleFrequency(p1: IParticle, p2: IParticle, p3: IParticle): number
Parameters
- p1: IParticle
- p2: IParticle
- p3: IParticle
Returns number

handleClickMode

handleClickMode(mode: string): void
Parameters
- mode: string
Returns void

init

init(): void
Returns void

`Private` initDensityFactor

initDensityFactor(densityOptions: IParticlesDensity): number
Parameters
- densityOptions: IParticlesDensity
Returns number

push

push(nb: number, mouse?: IMouseData, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string): void
Parameters
- nb: number
- Optional mouse: IMouseData
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
Returns void

`Private` pushParticle

pushParticle(position?: ICoordinates, overrideOptions?: RecursivePartial<IParticlesOptions>, group?: string, initializer?: ((particle: Particle) => boolean)): undefined | Particle
Parameters
- Optional position: ICoordinates
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
- Optional initializer: ((particle: Particle) => boolean)
  - - (particle: Particle): boolean
    - Parameters
      
      particle: Particle
      
      Returns boolean
Returns undefined | Particle

redraw

redraw(): Promise<void>
Returns Promise<void>

remove

remove(particle: Particle, group?: string, override?: boolean): void
Parameters
- particle: Particle
- Optional group: string
- Optional override: boolean
Returns void

removeAt

removeAt(index: number, quantity?: number, group?: string, override?: boolean): void
Parameters
- index: number
- quantity: number = 1
- Optional group: string
- Optional override: boolean
Returns void

removeQuantity

removeQuantity(quantity: number, group?: string): void
Parameters
- quantity: number
- Optional group: string
Returns void

setDensity

setDensity(): void
Returns void

update

update(delta: IDelta): Promise<void>
Parameters
- delta: IDelta
Returns Promise<void>