![]() |
VR-Exchange 2.1 API Documentation
|
VR-Exchange includes solution and project files in the example directories of the Windows version and makefiles in the example directories for the Linux version.
Please examine these files for a full picture of the build process.
VR-Exchange has the following libraries:
VR-Exchange brokers require the following third party libraries:
VR-Link - The non-HLA components use vl, vlUtil, xml, and matrix. The libHlaBroker library uses vlHLA13 or vlHLA1516. The libTenaBroker library uses vlTENA. The libDisBroker library uses vlDIS.
If you want to rebuild GUI components of the Portal or the brokers supplied with VR-Exchange, you need Qt. Qt is available as a free download under the LGPL version 2.1 license at www.qtsoftware.com. This version should be satisfactory for most VR-Exchange customers. If you need a Qt commercial license, you must purchase the license from Qt Software.
You do not need Qt to build new brokers or build the Portal without its GUI. You can purchase a Qt license from Trolltech: www.qtsoftware.com. Please see VR-Exchange Release Notes for the required version of Qt.
TENA users must install TENA middleware and any libraries required by their LROM. HLA users must install an RTI.
There are no special pre-processor flags required to build a broker. VR-Exchange includes release and debug versions of Windows libraries. Debug versions use the naming convention library_named.lib. The table lists the libraries required to build brokers for Windows and Linux.
| Libraries Required to Build Brokers | |
|---|---|
| Windows Libraries | Linux LIbraries |
| lib{protocol}Broker.lib | {protocol}broker |
| libBroker.lib | Broker |
| libPortal.lib | Portal |
| vl.lib | vl |
| vlutil.lib | vlutil |
| vl{protocol}.lib | vl{protocol} |
| matrix.lib | matrix |
| mtl.lib | mtl |
| libxml2.lib | xml |
| pthreadVC2.lib | pthread |
| QtCore4.lib | QtCore |
| QtGui4.lib | QtGui |
| commonDialogs.lib | commonDialogs |
| commonWidgets.lib | commonWidgets |
On Windows, the simpleBroker example requires the library vl5.
The table lists the libraries you need to rebuild the HLA broker.
| HLA Broker Libraries | |
|---|---|
| Windows Libraries | Linux LIbraries |
| vlPortal.lib | portal |
| libvl.lib | vl |
| vlutil.lib | vlutil |
| matrix.lib | matrix |
| mtl.lib | mtl |
| libxml2.lib | xml |
| pthreadVC2.lib | pthread |
| QtCore4.lib | QtCore4 |
| QtGui4.lib | QtGui4 |
| vlHLA13.lib, vlHLA1516.lib, or vlHLA1516e.lib ) | hla13Broker, hla1516Broker, or hla1516eBroker |
| libHla1516Broker.lib (or libHla13Broker.lib) | broker |
| commonDialogs.lib | commonDialogs |
| commonWidgets.lib | commonWidgets |
To rebuild the HLA broker on Windows, you must have the following RTI libraries (included with your RTI):
For the HLA broker several VR-Link compiler flags are required. Please consult the VR-Link documentation for instructions about how to build a VR-Link HLA federate.
VR-Exchange includes release and debug versions of the following LROM Mappers: coLromMapperRT and makLromMapperRT. You can use VR-Link to build custom LROM Mappers.
The LROM mapper files have several dynamic library dependencies that are not supplied with either VR-Link or VR-Exchange. You can get these libraries the following ways from the TENA SDA web site:
If you build a TENA broker, you must link in the vlTENART library. You must set the VR-Link compiler flag DtTENA. This library has the dynamic library dependencies listed in this section. The libraries are available from the indicated sources.
Libraries required for each platform are essentially the same. The libraries supplied with TENA Middleware and the MAK Object Model use the following naming convention:
Library_name-os-[d-]version.extension
where:
The following libraries are supplied with the TENA Middleware:
The following libraries are supplied with the MAK Object Model:
The following MAK libraries are provided with VR-Exchange. On Windows, debug libraries have a "d" before the extension, for example, vlTENARTd.lib.
| Libraries Provided by MAK for Use with TENA | |
|---|---|
| Windows | Linux |
| vlTENA.lib | vlTENA |
| vlutil.lib | vlutil |
| matrix.lib | matrix |
| vl.lib | vl |
| mtl.lib | mtl |
| libTenaBroker.lib | TenaBroker |
| commonWidgets.lib | commonWidgets |
| commonDialogs.lib | commonDialogs |
| QtCore4.lib | QtCore4 |
| QtGui4.lib | QtGui4 |
| libBroker.lib | Broker |
| libxml2.lib | libxml2 |
| pthreadVC2.lib | pthreadVC2 |
To build the DIS broker, you must specify several VR-Link compiler flags. Please consult the VR-Link documentation for instructions about how to build a VR-Link application for DIS.
| Libraries Required to Build the DIS Broker | |
|---|---|
| Windows Libraries | Linux LIbraries |
| vl.lib | vl |
| vlutil.lib | vlutil |
| matrix.lib | matrix |
| mtl.lib | mtl |
| libxml2.lib | xml2 |
| pthreadVC2.lib | portal |
| QtCore4.lib | QtCore4 |
| QtGui4.lib | QtGui4b |
| vlDIS.lib | vlDIS |
| libDisBroker.lib | disBroker |
| commonDialogs.lib | commonDialogs.lib |
| commonWidgets.lib | commonWidgets.lib |
| broker | |