 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
The examples are pre-compiled and installed by the SDK installer so it is not necessary to build them in order to try them out. To activate the pre-built plug-ins, please see section "5.9.1. Loading a Plug-in" in VR-Forces Users Guide.
Before you can build an example or a custom application, you must install the supporting software that your installation depends on and you must configure environment variables, so that the example project files can find these prerequisites.
You must do the following:
If you are building for HLA, install a supported RTI. We recommend using the MAK High Performance RTI, but RTIs from other vendors are supported as well, as long as they comply with the appropriate versions of the HLA Standards. A developer's license does not include a license for the MAK RTI. However, the MAK RTI allows you to run federations of up to two federates without requiring a license. You can download the MAK RTI at: http://www.mak.com/resources/bonus-material/cat_view/16-bonus-materials/24-mak-high-performance-rti.html.
If you install an RTI, set the environment variable MAK_RTIDIR to the full path to the RTI installation (for example, C:\MAK\makRti4.1).
Note: The example project files look for RTI header files in a directory called "include" directly under $(MAK_RTIDIR), and look for RTI link libraries in a directory called "lib" directly under $(MAK_RTIDIR). If you are using an RTI that does not follow that directory-naming convention, you may need to change the project settings in order for the build system to find your RTI headers and libraries.
If you want to build the front-end examples, you must install Qt, the cross-platform GUI development kit upon which the GUI is built. Qt is available at qt.digia.com and pre-built versions are available from MAK at http://www.mak.com/resources/bonus-material.html. It is freely licensed under the LGPL version 2.1.
If you install Qt, set the following environment variables:
To build VR-Forces examples, simply open the project file of the example you wish to use and build it. The newly built DLL or shared object will automatically be copied to the "build" directory where it can be loaded via the Plug-in management interface documented in section 5.9. "Managing Plug-ins" of the VR-Forces Users Guide. Stand-alone executables will automatically be copied into the "bin" directory.
The examples/VR-Vantage directory contains examples from VR-Vantage (upon which VR-Forces is based). Not all the examples from VR-Vantage are present, specifically any examples of VR-Vantage IG and any others which are either not relevant to or which are duplicated by VR-Forces examples.
The plug-in system used by VR-Vantage is different than that of VR-Forces and will require different steps in order to use the examples. Since the VR-Vantage examples are shipped pre-built, it is not necessary to build them however in order to do so it's necessary to copy the individual VR-Vantage example directories up into the top level VR-Forces example directory. To run vrfGui with a VR-Vantage plugin, it's necessary to use the --plugin command line option. On Windows, special care should be taken to load the corresponding build configuration [debug, release] for the vrfGui executable being used. For example to load the "exampleAccessory" example in DIS, run vrfGui as follows:
vrfgui --dis --plugin ..\examples\plugins\release\exampleSymbolDecoration.dllThe following VR-Vantages examples are stand-alone executables as opposed to plugins and can be copied from the bin directory to the top-level VR-Forces bin directory: exampleObjectDictionary exampleSendDrawControl exampleSendControl