public interface IQuimpCorePlugin extends IQuimpPluginExchangeData
Contain also flags understood by plugins
PluginFactory
Modifier and Type | Field and Description |
---|---|
static int |
CHANGE_SIZE
Plugin change size of input data.
|
static int |
DOES_SNAKES
Plugin process snakes only.
|
static int |
GENERAL
Type of plugin not defined.
|
static int |
MODIFY_INPUT
Plugin modify input data in place.
|
Modifier and Type | Method and Description |
---|---|
String |
about()
Get short info about plugin.
|
String |
getVersion()
Get version of plugin.
|
int |
setup()
Provide basic information to QuimP about plugin.
|
int |
showUi(boolean val)
Show or hide plugin UI.
|
getPluginConfig, setPluginConfig
static final int GENERAL
static final int DOES_SNAKES
static final int CHANGE_SIZE
static final int MODIFY_INPUT
int setup()
It must return at least type of plugin
int showUi(boolean val)
UI is not obligatory. This function must be implemented but may do nothing.
val
- booleanreturn toggleWindow() ? 1 : 0;
, where toggle window
returns boolean value.String getVersion()
Versioning may be used for detecting incompatibilities between configurations. Plugin version is saved in QuimP config files, and then passed to plugin by setPluginConfig(ParamList) as \a version key. This key is not available if plugin has not provided its version. The plugin is responsible for parsing this parameter.
String about()
One can use white characters in this string to limit line length because there is no guarantee that displayer will wrap lines.
It can shows also simple help for supported macro options.
Copyright © 2002–2019 Department of Computer Science, Warwick University. All rights reserved.