|
Goto page 1 2 3
3. Create your class that extends Plugin.Plugin abstract class. By doing so, you are forced to implement all the required methods. Here are the information about those methods:
public abstract bool isAcceptProgramVersion(float version);
MODI will call this method, in order to check whether the plugin is compatible with the current version of MODI. Return true if the plugin support this version of MODI, or false, if not.
public abstract String GetAcceptedProgramVersion();
Implement this method to tell MODI, what are the versions that are supported by the Plugin. This is used only to display a message box to user, when your plugin does not support the current version of MODI.
public abstract String GetName();
Return your plugin name.
public abstract Parameter[] GetParameters();
Return the parameters for your plugin. These parameters are the customization that users can change via the parameters panel.
public abstract String GetDescription();
Return the description of your plugin
public abstract bool CheckParameters(Parameter[] parameters, out String Message);
Check if the parameters saved in a preset is valid or not. When MODI starts, it read the saved preset from a XML file. This file can possibly be edited by someone. This can make a wrong values being provided to your plugin, so you have to check the parameters first.
public abstract UserControl GetParametersPanel(ParametersOKDelegate _parameterOKMethod, ParametersErrorDelegate _parameterErrorMethod, List<String> imgList, List<String> selectedImg);
This method is called by MODI when users try to add/edit a modifier in/to the modifiers stack. Your plugin has to provide MODI a UserControl object giving users a chance to customize how the process should be processed.
imgList and selectedImg are the lists containing full path to images added to MODI for modification and selected images respectively. You can use this information for generating a preview
using images that a user has added to MODI.
public abstract void SetParametersPanelValue(Parameter[] parameters);
This method is called when users try to update parameters of your plugin. MODI will call this method and pass through the current parameters. It is the responsibility of your plugin to set the parameters panel UI accordingly to the parameters values.
public abstract override String ToString();
This override the base class ToString Method. It is used to display the human-readable
text on the MODI GUI. You can return here what the method GetName() returns.
public abstract bool Execute(Image img, Parameter[] parameters, FileInfo fi, out Image modifiedImage, out String Message);
This is the implementation of your plugin. MODI calls this method to actually process the images. The original image is passed to this method via the variable img, and the result is passed back via modifiedImage. Some plugin might want to know about the path or filename to the original image. This is passed to plugin via fi variable. If the processing failed for any reason, you should send back a message to MODI via the Message variable.
|
