2017-12-04 23:18:14 +08:00
|
|
|
CARLA Design
|
|
|
|
============
|
|
|
|
|
|
|
|
> _This document is a work in progress and might be incomplete._
|
|
|
|
|
|
|
|
CARLA is composed by the following modules
|
|
|
|
|
|
|
|
* Client side
|
2018-10-26 00:49:17 +08:00
|
|
|
- Python client API: "Deprecated/PythonClient/carla"
|
2017-12-04 23:18:14 +08:00
|
|
|
* Server side
|
|
|
|
- CarlaUE4 Unreal Engine project: "Unreal/CarlaUE4"
|
|
|
|
- Carla plugin for Unreal Engine: "Unreal/CarlaUE4/Plugins/Carla"
|
|
|
|
- CarlaServer: "Util/CarlaServer"
|
|
|
|
|
2018-02-03 19:15:39 +08:00
|
|
|
!!! tip
|
|
|
|
Documentation for the C++ code can be generated by running
|
|
|
|
[Doxygen](http://www.doxygen.org) in the main folder of CARLA project.
|
|
|
|
|
2017-12-04 23:18:14 +08:00
|
|
|
Python client API
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
The client API provides a Python module for communicating with the CARLA server.
|
2018-10-26 00:49:17 +08:00
|
|
|
In the folder "Deprecated/PythonClient", we provide several examples for scripting a CARLA
|
2017-12-04 23:18:14 +08:00
|
|
|
client using the "carla" module.
|
|
|
|
|
|
|
|
CarlaUE4 Unreal Engine project
|
|
|
|
------------------------------
|
|
|
|
|
|
|
|
The Unreal project "CarlaUE4" contains all the assets and scenes for generating
|
|
|
|
the CARLA binary. It uses the tools provided by the Carla plugin to assemble the
|
|
|
|
cities and behavior of the agents in the scene.
|
|
|
|
|
|
|
|
Carla plugin for Unreal Engine
|
|
|
|
------------------------------
|
|
|
|
|
|
|
|
The Carla plugin contains all the functionality of CARLA. We tried to keep this
|
|
|
|
functionality separated from the assets, so the functionality in this plugin can
|
|
|
|
be used as much as possible in any Unreal project.
|
|
|
|
|
|
|
|
It uses "CarlaServer" library for the networking communication.
|
|
|
|
|
|
|
|
CarlaServer
|
|
|
|
-----------
|
|
|
|
|
|
|
|
External library for the networking communications.
|
|
|
|
|
|
|
|
See ["CarlaServer"](carla_server.md) for implementation details.
|