2. Scope of document¶
The purpose of this document is to describe the current state of the AGX Dynamics API as well give an overview of how to use the API.
In addition to this user manual, there is also the generated API documentation which is located in <agx-dir>/doc/html
On the windows platform, there are also shortcuts from the START menu to all the documentation and all the tutorials and demonstration scripts. It is located in START\AGX Dynamics-2.37.0.0 (replace 2.37.0.0 with the version of AGX Dynamics you have installed).
AGX Dynamics Main Page – Link to a web page containing the tutorials and demonstration scripts.
AGX Dynamics API Documentation – Doxygen generated API documentation.
On Linux the API documentation included in the AGX package can be inaccessible if your web browser is running sandboxed. The sandbox can make parts of the file system inaccessible for the browser. To work around this problem, a python-based utility is provided with AGX that is available as /opt/Algoryx/AGX-<version>/bin/doc-server.py. The utility starts a local webserver, listening on localhost, and provides a GUI for easy access to the documentation. For window managers that automatically find .desktop-files, there will also be an item on the start menu to launch the documentation utility.