Difference between revisions of "AnyWave:DeveloperCorner"
(→Basic requirements to build a plugin) |
(→Basic requirements to build a plugin) |
||
| Line 25: | Line 25: | ||
Note:<br/> | Note:<br/> | ||
The Windows version of AnyWave is built with Visual Studio 2017 though, so, if you plan to build a plugin for Windows, consider using this tool along with the Qt VS Addin.<br/> | The Windows version of AnyWave is built with Visual Studio 2017 though, so, if you plan to build a plugin for Windows, consider using this tool along with the Qt VS Addin.<br/> | ||
| − | Technically speaking you can build a plugin with QtCreator using another compiler like | + | Technically speaking you can build a plugin with QtCreator using another compiler like '''gcc''' or '''clang'''.<br/> |
You will need to put the runtime DLL files of the chosen compiler into the AnyWave folder after you copied the plugin into the Plugins subdirectory. | You will need to put the runtime DLL files of the chosen compiler into the AnyWave folder after you copied the plugin into the Plugins subdirectory. | ||
Revision as of 14:29, 5 September 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
Basic requirements to build a plugin
We strongly recommend QtCreator as the tool to use which is available along with the Qt open source package you will need to build a plugin.
Download Qt and Qt Creator here: Get Qt and Qt Creator
Note:
The Windows version of AnyWave is built with Visual Studio 2017 though, so, if you plan to build a plugin for Windows, consider using this tool along with the Qt VS Addin.
Technically speaking you can build a plugin with QtCreator using another compiler like gcc or clang.
You will need to put the runtime DLL files of the chosen compiler into the AnyWave folder after you copied the plugin into the Plugins subdirectory.
Create a project
Every Qt project starts with a .pro file which is the format used by qmake, the tool for building Qt projects.
AnyWave plugins require path to AnyWave SDK to successfully build.
So, before we go deep into an example, we need to provide the paths to the AnyWave SDK.
On a qmake .pro file you may add the following lines:
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:
