Class Particles

Particles manager object

Hierarchy

Particles

Index

Constructors

Constructors

constructor

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

Properties

`Private` `Readonly` _applyDensity

_applyDensity: ((options, manualCount, group?) => void) = ...

Type declaration

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

`Private` _array

_array: Particle[]

All the particles used in canvas

`Private` `Readonly` _container

_container: Container

`Private` `Readonly` _engine

_engine: Engine

`Private` `Readonly` _initDensityFactor

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

Type declaration

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

`Private` `Readonly` _interactionManager

_interactionManager: InteractionManager

`Private` _nextId

_nextId: number

`Private` `Readonly` _pushParticle

_pushParticle: ((position?, overrideOptions?, group?, initializer?) => undefined | Particle) = ...

Type declaration

- (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

`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` _zArray

_zArray: Particle[]

lastZIndex

lastZIndex: number

limit

limit: number

movers

movers: IParticleMover[]

needsSort

needsSort: boolean

pool

pool: Particle[]

`Optional` pushing

pushing?: boolean

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

Methods

addManualParticles

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

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

clear

clear(): void
Removes all particles from the array

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

destroy

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

draw

draw(delta): Promise<void>
Parameters
- delta: IDelta
Returns Promise<void>
- Defined in Core/Particles.ts:141

filter

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

find

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

handleClickMode

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

init

init(): void
Returns void
- Defined in Core/Particles.ts:178

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

redraw

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

remove

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

removeAt

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

removeQuantity

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

setDensity

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

update

update(delta): Promise<void>
Parameters
- delta: IDelta
Returns Promise<void>
- Defined in Core/Particles.ts:275

Class Particles

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

engine: Engine

container: Container

Returns Particles

Properties

Private Readonly _applyDensity

Type declaration

Parameters

options: IParticlesOptions

manualCount: number

Optional group: string

Returns void

Private _array

Private Readonly _container

Private Readonly _engine

Private Readonly _initDensityFactor

Type declaration

Parameters

densityOptions: IParticlesDensity

Returns number

Private Readonly _interactionManager

Private _nextId

Private Readonly _pushParticle

Type declaration

Parameters

Optional position: ICoordinates

Optional overrideOptions: RecursivePartial<IParticlesOptions>

Optional group: string

Optional initializer: ((particle) => boolean)

Parameters

particle: Particle

Returns boolean

Returns undefined | Particle

Private Readonly _removeParticle

Type declaration

Parameters

index: number

Optional group: string

Optional override: boolean

Returns boolean

Private _zArray

lastZIndex

limit

movers

needsSort

pool

Optional pushing

quadTree

updaters

Accessors

count

Returns number

Methods

addManualParticles

Returns void

addParticle

Parameters

Optional position: ICoordinates

Optional overrideOptions: RecursivePartial<IParticlesOptions>

Optional group: string

Optional initializer: ((particle) => boolean)

Parameters

particle: Particle

Returns boolean

Returns undefined | Particle

clear

Returns void

destroy

Returns void

draw

Parameters

`Private` `Readonly` _applyDensity

`Optional` group: string

`Private` _array

`Private` `Readonly` _container

`Private` `Readonly` _engine

`Private` `Readonly` _initDensityFactor

`Private` `Readonly` _interactionManager

`Private` _nextId

`Private` `Readonly` _pushParticle

`Optional` position: ICoordinates

`Optional` overrideOptions: RecursivePartial<IParticlesOptions>

`Optional` group: string

`Optional` initializer: ((particle) => boolean)

`Private` `Readonly` _removeParticle

`Optional` group: string

`Optional` override: boolean

`Private` _zArray

`Optional` pushing

`Optional` position: ICoordinates

`Optional` overrideOptions: RecursivePartial<IParticlesOptions>

`Optional` group: string

`Optional` initializer: ((particle) => boolean)

`Optional` mouse: IMouseData

`Optional` overrideOptions: RecursivePartial<IParticlesOptions>

`Optional` group: string

`Optional` group: string

`Optional` override: boolean

`Optional` group: string

`Optional` override: boolean

`Optional` group: string