Engee documentation

UNIGINE Support Package

The UNIGINE support package enables Engee to work with UNIGINE projects using library blocks Software Environment UNIGINE. The package runs on top of the subsystem Engee.Integrations and uses two auxiliary classes for data exchange: EngeeServerSocket and EngeeClientSocket. To use them in the project, connect the sources in CMakeLists.txt based on a sample from the UNIGINE integration directory.

Requirements

  • The subsystem is installed and running Engee.Integrations.

  • The UNIGINE project in C++ with assembly via CMake.

  • Added socket sources (EngeeServerSocket, EngeeClientSocket) in CMakeLists.txt following the example from the integration directory.

  • The address and port for the exchange (must match the block settings in Engee).

Quick start

  1. Install or connect the Engee subsystem.Integrations as shown in article.

  2. Connect the sources EngeeServerSocket/EngeeClientSocket in CMakeLists.txt based on a sample from the UNIGINE integration directory.

  3. In the UNIGINE project (C++/CMake):

    • In the classroom AppWorldLogic (initializing the world) create EngeeClientSocket and connect to the desired address/port (for example, 127.0.0.1:5150).

    • Get the desired object (node) by name (for example, material_ball).

    • In the world update method, read data from the socket and update the state of the object (for example, the position).

    • When shutting down, close the socket correctly.

  4. In Engee, set up blocks from the library Software Environment UNIGINE (address/port and data format), then run the model and the UNIGINE project.