pixi-viewport

Class: PluginManager

PluginManager

Use this to access current plugins or add user-defined plugins

new PluginManager ()

PluginManager.js:20

This is called by Viewport to initialize the plugins.

Classes

PluginManager

Methods

add (name, plugin, index)

PluginManager.js:36

Inserts a named plugin or a user plugin into the viewport default plugin order: 'drag', 'pinch', 'wheel', 'follow', 'mouse-edges', 'decelerate', 'bounce', 'snap-zoom', 'clamp-zoom', 'snap', 'clamp'

Name Type Description
name string

of plugin
plugin Plugin

instantiated Plugin class
index number

to insert userPlugin (otherwise inserts it at the end)

get (name, ignorePaused)

PluginManager.js:55

Get plugin

Name Type Description
name string

of plugin
ignorePaused boolean optional

return null if plugin is paused

pause (name)

PluginManager.js:120

Pause plugin

Name Type Description
name string

of plugin (e.g., 'drag', 'pinch')

remove (name)

PluginManager.js:106

Removes installed plugin

Name Type Description
name string

of plugin (e.g., 'drag', 'pinch')

removeAll ()

PluginManager.js:94

removes all installed plugins

reset ()

PluginManager.js:88

Clamps and resets bounce and decelerate (as needed) after manually moving viewport

resume (name)

PluginManager.js:129

Resume plugin

Name Type Description
name string

of plugin (e.g., 'drag', 'pinch')