Class Plugins

constructor

• new Plugins(engine): Plugins

• The constructor of the plugin manager

  Parameters

  • engine: Engine

    the parent engine

  Returns Plugins

Readonly drawers

Readonly interactors

Readonly movers

Readonly pathGenerators

Readonly plugins

Readonly presets

Readonly updaters

addInteractor

• addInteractor(name, initInteractor): void

• Adds an interaction manager to the current collection

  Parameters

  • name: string

    the interaction manager name

  • initInteractor: InteractorInitializer

    the interaction manager initializer

  Returns void

addParticleMover

• addParticleMover(name, initMover): void

• Parameters

  • name: string

  • initMover: MoverInitializer

  Returns void

addParticleUpdater

• addParticleUpdater(name, initUpdater): void

• Adds a particle updater to the collection

  Parameters

  • name: string

    the particle updater name used as a key

  • initUpdater: UpdaterInitializer

    the particle updater initializer

  Returns void

addPathGenerator

• addPathGenerator(type, pathGenerator): void

• Adds a path generator to the current collection

  Parameters

  • type: string

    the type used as a key in the collection

  • pathGenerator: IMovePathGenerator

    the path generator to add

  Returns void

addPlugin

• addPlugin(plugin): void

• Adds a plugin to the plugin system, if the plugin already exists, is not added

  Parameters

  • plugin: IPlugin

    the plugin to add

  Returns void

addPreset

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

• Adds a preset to the existing collection

  Parameters

  • presetKey: string

    the preset name

  • options: RecursivePartial<IOptions>

    the options to load with the preset name

  • override: boolean = false

    if true, overwrites the existing preset

  Returns void

addShapeDrawer

• addShapeDrawer(types, drawer): void

• Adds a shape drawer (additional particle shape) to the current collection

  Parameters

  • types: SingleOrMultiple<string>

    the shape drawer types (particle shape names)

  • drawer: IShapeDrawer

    the shape drawer

  Returns void

destroy

• destroy(container): void

• Parameters

  • container: Container

  Returns void

getAvailablePlugins

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

• Gets all the available plugins, for the specified container

  Parameters

  • container: Container

    the container used to check which are the valid plugins

  Returns Map<string, IContainerPlugin>

  a map containing all enabled plugins, with the id as a key

getInteractors

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

• Returns all the container interaction managers

  Parameters

  • container: Container

    the container used to check which interaction managers are compatible

  • force: boolean = false

    if true reloads the interaction managers collection for the given container

  Returns IInteractor[]

  the array of interaction managers for the given container

getMovers

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

• Parameters

  • container: Container

  • force: boolean = false

  Returns IParticleMover[]

getPathGenerator

• getPathGenerator(type): undefined | IMovePathGenerator

• Searches the path generator with the given type name

  Parameters

  • type: string

    the path generator type to search

  Returns undefined | IMovePathGenerator

  the path generator if found, or undefined

getPlugin

• getPlugin(plugin): undefined | IPlugin

• Searches if the specified plugin exists and returns it

  Parameters

  • plugin: string

    the plugin name

  Returns undefined | IPlugin

  the plugin if found, or undefined

getPreset

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

• Searches the preset with the given name

  Parameters

  • preset: string

    the preset name to search

  Returns undefined | RecursivePartial<IOptions>

  the preset if found, or undefined

getShapeDrawer

• getShapeDrawer(type): undefined | IShapeDrawer

• Searches the given shape drawer type with the given type name

  Parameters

  • type: string

    the shape drawer type name

  Returns undefined | IShapeDrawer

  the shape drawer if found, or undefined

getSupportedShapes

• getSupportedShapes(): IterableIterator<string>

• This method returns all the supported shapes with this Plugins instance

  Returns IterableIterator<string>

  all the supported shapes type name

getUpdaters

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

• Returns all the container particle updaters

  Parameters

  • container: Container

    the container used to check which particle updaters are enabled

  • force: boolean = false

    if true reloads the updater collection for the given container

  Returns IParticleUpdater[]

  the array of updaters for the given container

loadOptions

• loadOptions(options, sourceOptions): void

• Load the given options for all the plugins

  Parameters

  • options: Options

    the actual options to set

  • sourceOptions: RecursivePartial<IOptions>

    the source options to read

  Returns void

loadParticlesOptions

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

• Load the given particles options for all the updaters

  Parameters

  • container: Container

    the container of the updaters

  • options: ParticlesOptions

    the actual options to set

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

    the source options to read

  Returns void