|
|
(74 intermediate revisions by one user not shown) |
Line 1: |
Line 1: |
| + | __NOTOC__ |
| =Welcome= | | =Welcome= |
| This part of the Wiki is dedicated to developers who would like to implement their own plug-ins for AnyWave.<br /> | | This part of the Wiki is dedicated to developers who would like to implement their own plug-ins for AnyWave.<br /> |
− | AnyWave is written using the Qt Framework and the Qt plugin mechanism, so a good knowledge of the Qt Framework is required.
| + | {| style="text-align: center; margin: auto;" |
− | | + | |+ Quick Navigation |
− | =The SDK=
| + | |- |
− | If you have installed AnyWave on your system, you will find all the required files in the installation folder.<br />
| + | | [[File:Menu_matlab_plugin.png|400px|link=AnyWave:MATLAB_Plugin|'''Write a MATLAB Plugin''']] || [[File:Menu_cpp_plugin.png|400px|link=AnyWave:Cpp_Plugin|'''Write a c++ Plugin''']] |
− | ==Linux==
| + | |- |
− | Build from sources following the instructions on our [https://gitlab.thevirtualbrain.org/anywave Gitlab].<br />
| + | | [[File:Menu_matlab_batch.png|400px|link=AnyWave:Plugin_Batch|'''Make your plugin batchable''']] || [[File:Menu_matlab_batch_gui_compatible.png|400px|link=AnyWave:MATLAB_Batch_GUI|'''Make your plugin compatible with the batch GUI of AnyWave''']] |
− | Considering the default installation path, the requires folders to build a plugin are:<br />
| + | |} |
− | * '''/usr/local/AnyWave/include'''
| + | |
− | * '''/usr/local/AnyWave/lib'''
| + | |
− | ==Mac OS==
| + | |
− | The required folders to build a plugin are:<br />
| + | |
− | * '''/Applications/AnyWave.app/content/include'''
| + | |
− | * '''/Applications/AnyWave.app/content/frameworks'''
| + | |
− | | + | |
− | ==Windows==
| + | |
− | The required folders to build a plugin are:<br />
| + | |
− | * '''AnyWave\include'''
| + | |
− | * '''AnyWave\lib'''
| + | |
− | | + | |
− | =AnyWave C++ objects=
| + | |
− | See this [[AnyWave:AwObjects|section]] of the Wiki to learn more about C++ objects defined in the SDK.
| + | |
− | | + | |
− | =How to build a plugin= | + | |
− | Using qmake is the easier solution to build a plugin as it is the Qt tool to manage project files and a qmake project can be used in QtCreator.<br />
| + | |
− | ==Create the project==
| + | |
− | When building a plugin for AnyWave, the project file must find the SDK required files of AnyWave.<br />
| + | |
− | A good practice is to set an environment variable called AW_ROOT that points to the root folder of your AnyWave installation.<br />
| + | |
− | For example on Linux, that would be: /usr/local/AnyWave<br />
| + | |
− | | + | |
− | Tutorials:<br />
| + | |
− | * [[AnyWave:BuildReader|Build a reader plugin]]
| + | |
− | | + | |
− | =Build a signal processing plug-in=
| + | |
− | ==[[AnyWave:WriteMatlabScripted|How to write a MATLAB plug-in]]==
| + | |
− | | + | |
− | ==[[AnyWave:WritePythonScripted|How to write a Python Scripted plug-in]]==
| + | |
This part of the Wiki is dedicated to developers who would like to implement their own plug-ins for AnyWave.