First steps

Last updated 2 months ago

Apertus Package Manager (apm) is a command line application to manage 3rd Parties and to create plugins and samples easier by generating the necessary folders and files.

Creating a new plugin

To create a new plugin for ApertusVR use apm to generate folders and files. In the following example, we create a new plugin called "ipCamera":

ApertusVR\utilities\apm>python apm.py create plugin ipCamera
Creating new plugin with the following properties:
name: ipCamera
path: ../../plugins/ipCamera/
class name: ApeIpCameraPlugin
header name: APE_IPCAMERAPLUGIN_H
header file path: ../../plugins/ipCamera/ApeIpCameraPlugin.h
cpp file path: ../../plugins/ipCamera/ApeIpCameraPlugin.cpp
Do you want to continue? [Y/n]

If you find everything in order, type 'y' and press enter to continue.

If you want to add your newly created plugin to plugins/CMakeLists.txt, just type 'y' when apm asks it:

Add to plugins/CMakeLists.txt? [Y/n] y

In order to see your new plugin in your IDE, don't forget to

  1. regenerate the CMake project

  2. reload / reopen the generated project file in your IDE.

after editing CMakeLists.txt files.

Creating a new sample

Creating a new sample for ApertusVR happens the same way as creating a plugin. In the following example, we create a new sample called "ipCamera":

ApertusVR\utilities\apm>python apm.py create sample ipCamera
Creating new sample with the following properties:
name: ipCamera
path: ../../samples/ipCamera/
class name: ApeIpCamera
cpp file path: ../../samples/ipCamera/ApeIpCamera.cpp
Do you want to continue? [Y/n]

If you find everything in order, type 'y' and press enter to continue.

If you want to add your newly created sample to samples/CMakeLists.txt, just type 'y' when apm asks it:

Add to samples/CMakeLists.txt? [Y/n] y

In order to see your new sample in your IDE, don't forget to

  1. regenerate the CMake project

  2. reload / reopen the generated project file in your IDE.

after editing CMakeLists.txt files.