Class Plugins

constructor

• new Plugins(engine): Plugins

• Parameters

  • engine: Engine

  Returns Plugins

Readonly drawers

Readonly interactors

Readonly movers

Readonly pathGenerators

Readonly plugins

Readonly presets

Readonly updaters

addInteractor

• addInteractor(name, initInteractor): void

• Parameters

  • name: string

  • initInteractor: InteractorInitializer

  Returns void

addParticleMover

• addParticleMover(name, initMover): void

• Parameters

  • name: string

  • initMover: MoverInitializer

  Returns void

addParticleUpdater

• addParticleUpdater(name, initUpdater): void

• Parameters

  • name: string

  • initUpdater: UpdaterInitializer

  Returns void

addPathGenerator

• addPathGenerator(type, pathGenerator): void

• Parameters

  • type: string

  • pathGenerator: IMovePathGenerator

  Returns void

addPlugin

• addPlugin(plugin): void

• Parameters

  • plugin: IPlugin

  Returns void

addPreset

• addPreset(presetKey, options, override?): void

• Parameters

  • presetKey: string

  • options: RecursivePartial<IOptions>

  • Optional override: boolean

  Returns void

addShapeDrawer

• addShapeDrawer(types, drawer): void

• Parameters

  • types: SingleOrMultiple<string>

  • drawer: IShapeDrawer

  Returns void

destroy

• destroy(container): void

• Parameters

  • container: Container

  Returns void

getAvailablePlugins

• getAvailablePlugins(container): Map<string, IContainerPlugin>

• Parameters

  • container: Container

  Returns Map<string, IContainerPlugin>

getInteractors

• getInteractors(container, force?): IInteractor[]

• Parameters

  • container: Container

  • Optional force: boolean

  Returns IInteractor[]

getMovers

• getMovers(container, force?): IParticleMover[]

• Parameters

  • container: Container

  • Optional force: boolean

  Returns IParticleMover[]

getPathGenerator

• getPathGenerator(type): undefined | IMovePathGenerator

• Parameters

  • type: string

  Returns undefined | IMovePathGenerator

getPlugin

• getPlugin(plugin): undefined | IPlugin

• Parameters

  • plugin: string

  Returns undefined | IPlugin

getPreset

• getPreset(preset): undefined | RecursivePartial<IOptions>

• Parameters

  • preset: string

  Returns undefined | RecursivePartial<IOptions>

getShapeDrawer

• getShapeDrawer(type): undefined | IShapeDrawer

• Parameters

  • type: string

  Returns undefined | IShapeDrawer

getSupportedShapes

• getSupportedShapes(): IterableIterator<string>

• Returns IterableIterator<string>

getUpdaters

• getUpdaters(container, force?): IParticleUpdater[]

• Parameters

  • container: Container

  • Optional force: boolean

  Returns IParticleUpdater[]

loadOptions

• loadOptions(options, sourceOptions): void

• Parameters

  • options: Options

  • sourceOptions: RecursivePartial<IOptions>

  Returns void

loadParticlesOptions

• loadParticlesOptions(container, options, ...sourceOptions): void

• Parameters

  • container: Container

  • options: ParticlesOptions

  • Rest ...sourceOptions: (undefined | RecursivePartial<IParticlesOptions>)[]

  Returns void