Class Particles

Particles manager object

Constructors

constructor

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

Properties

`Private` `Readonly` _addToPool

_addToPool: ((...particles) => void) = ...

Type declaration

- (...particles): void
- Parameters
  - Rest ...particles: Particle[]
  Returns void

`Private` _array

_array: Particle[]

All the particles used in canvas

`Private` `Readonly` _container

_container: Container

`Private` `Readonly` _engine

_engine: Engine

`Private` `Readonly` _groupLimits

_groupLimits: Map<string, number>

`Private` `Readonly` _initDensityFactor

_initDensityFactor: ((densityOptions) => number) = ...

Type declaration

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

`Private` `Readonly` _interactionManager

_interactionManager: InteractionManager

`Private` _lastZIndex

_lastZIndex: number

`Private` _limit

_limit: number

`Private` _needsSort

_needsSort: boolean

`Private` _nextId

_nextId: number

`Private` _pluginsInitialized

_pluginsInitialized: boolean

`Private` `Readonly` _pool

_pool: Particle[]

`Private` `Readonly` _removeParticle

_removeParticle: ((index, group?, override?) => boolean) = ...

Type declaration

- (index, group?, override?): boolean
- Parameters
  - index: number
  - Optional group: string
  - Optional override: boolean
  Returns boolean

`Private` `Optional` _resizeFactor

_resizeFactor?: IDimension

`Private` _zArray

_zArray: Particle[]

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

Methods

`Private` `Readonly` _applyDensity

_applyDensity(options, manualCount, group?): void
Parameters
- options: IParticlesOptions
- manualCount: number
- Optional group: string
Returns void
- Defined in Core/Particles.ts:418

`Private` `Readonly` _pushParticle

_pushParticle(position?, overrideOptions?, group?, initializer?): undefined | Particle
Parameters
- Optional position: ICoordinates
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
- Optional initializer: ((particle) => boolean)
  - - (particle): boolean
    - Parameters
      particle: Particle
      Returns boolean
Returns undefined | Particle
- Defined in Core/Particles.ts:465

addManualParticles

addManualParticles(): void
Returns void
- Defined in Core/Particles.ts:95

addParticle

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

clear

clear(): void
Removes all particles from the array

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

destroy

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

draw

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

filter

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

find

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

get

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

handleClickMode

handleClickMode(mode): void
Parameters
- mode: string
Returns void
- Defined in Core/Particles.ts:190

init

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

initPlugins

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

push

push(nb, mouse?, overrideOptions?, group?): void
Parameters
- nb: number
- Optional mouse: IMouseData
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
Returns void
- Defined in Core/Particles.ts:256

redraw

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

remove

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

removeAt

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

removeQuantity

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

setDensity

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

setLastZIndex

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

setResizeFactor

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

update

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