Class: Plugin

.plugin. Plugin

Defines a generic plugin

Constructor

new Plugin(type, name)

Parameters:
Name Type Description
type Integer

The type of plugin, i.e. MLJ.core.plugin.type.FILTER or MLJ.core.plugin.type.RENDERING
name String

The name of plugin
Author:
  • Stefano Gabriele
Source:

Methods

(abstract) _applyTo(layer)

This function should be overridden to define the code that will be executed after that apply or apply to all visible buttons was clicked

Parameters:
Name Type Description
layer MLJ.core.Layer

The mesh file that should be affected by the code defined in this function
Author:
  • Stefano Gabriele
Source:

(abstract) _init(guiBuilder)

This function should be overridden to define the plugin GUI and its initialization stuff

Parameters:
Name Type Description
guiBuilder MLJ.core.plugin.GUIBuilder

The object that provides useful function to build the GUI quickly
Author:
  • Stefano Gabriele
Source:

(abstract) _main()

This function represents the main entry point for the plugin execution

Author:
  • Stefano Gabriele
Source:

getName() → {String}

Returns the name of plugin

Author:
  • Stefano Gabriele
Source:
Returns:

The name of plugin

Type
String

getParameters() → {Object}

Returns the parameter of plugins or undefined if plugin has no parameters

Author:
  • Stefano Gabriele
Source:
Returns:

The parameters of plugin or undefined if plugin has no parameters

Type
Object