Developers Guide

Last updated 2 months ago

How to design and create applications with ApertusVR

CMake

The source code of ApertusVR uses CMAKE, which gives you the opportunity to use an IDE or platform of your choice.

Git

The "master" branch is considered stable, at all times. The "develop" branch is the one where all contributions must be merged before being promoted to master. If you plan to propose a patch, please pull-request it into the "develop" branch, or its own feature branch. Direct commit to "master" are not permitted.

C++ coding style

The #define Guard

All header files should have #define guards to prevent multiple inclusion. The format of the symbol name should be <APE>_<PLUGINNAME>_H.

#ifndef APE_TESTERPLUGIN_H
#define APE_TESTERPLUGIN_H
...
#endif // APE_TESTERPLUGIN_H

Include headers

Includes must use the following the usage:

  • c++ headers

  • Ape.h

  • system/...

  • plugin/...

  • managers/...

  • datatypes/...

  • sceneelements/...

  • utils/...

  • your own headers and others