Revision as of 13:24, 30 March 2016

__NOTITLE__

Welcome

This part of the Wiki is dedicated to developers who would like to implement their own plug-ins for AnyWave.
AnyWave is written using the Qt Framework and the Qt plugin mechanism, so a good knowledge of the Qt Framework is required.

Requirements

Qt5 is the base framework used by AnyWave and thus by the plug-ins.
Make sure you have the Qt5 development environment installed on your computer which will be the case if you have built AnyWave from the git repository.

Build the SDK

Click here to see how to build AnyWave from sources.

How to use the SDK

A regular AnyWave plug-in is a C++ project that will be using C++ objects defined in the SDK.

So, before creating a project to build a plug-in, the SDK must be correctly configured.
This is easily done by defining an environment variable called AWSDK that must contain the path to the SDK root folder location.

On Linux and Mac systems this can be accomplished by adding the two following lines to your .bashrc file:
AWSDK=/home/user/Dev/AwSDK
export AWSDK

On Windows, this can be done by opening the Security and System/System panel.
Then click on the left part of the window on Advanced properties.

NOTE: close and re-open the terminal for the changes to be applied.

AnyWave C++ objects

See this section of the Wiki to learn more about C++ objects defined in the SDK.

How to build a plugin

The CMake tool will take care of the building step for your plugin.
So, it is strongly advised to get used with the basic cmake concepts, though, it's quite simple to set up a cmake project to build a plug-in:
Follow this section to see have to do it.

Build a Reader plug-in

Build a signal processing plug-in

How to write a MATLAB plug-in

How to write a Python Scripted plug-in