Difference between revisions of "AnyWave:DeveloperCorner"
(→Create the project) |
(→Create the project) |
||
| Line 27: | Line 27: | ||
==Create the project== | ==Create the project== | ||
When building a plugin for AnyWave, the project file must find the SDK required files of AnyWave.<br /> | 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 /> | + | 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 /> | For example on Linux, that would be: /usr/local/AnyWave<br /> | ||
Revision as of 15:02, 3 August 2018
Contents
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.
The SDK
If you have installed AnyWave on your system, you will find all the required files in the installation folder.
Linux
Build from sources following the instructions on our Gitlab.
Considering the default installation path, the requires folders to build a plugin are:
- /usr/local/AnyWave/include
- /usr/local/AnyWave/lib
Mac OS
The required folders to build a plugin are:
- /Applications/AnyWave.app/content/include
- /Applications/AnyWave.app/content/frameworks
Windows
The required folders to build a plugin are:
- AnyWave\include
- AnyWave\lib
AnyWave C++ objects
See this 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.
Create the project
When building a plugin for AnyWave, the project file must find the SDK required files of AnyWave.
A good practice is to set an environment variable called AW_ROOT that points to the root folder of your AnyWave installation.
For example on Linux, that would be: /usr/local/AnyWave
Tutorials:
