Improved PythonAPI map generation params docs

This commit is contained in:
Marc Garcia Puig 2020-04-14 13:20:42 +02:00
parent aa938b02bf
commit d2a16e9a47
2 changed files with 19 additions and 28 deletions

View File

@ -328,13 +328,11 @@ Executes a list of commands on a single simulation step, blocks until the comman
- `commands` (_list_) A list of commands to execute in batch. The commands available are listed right above, in the function **<font color="#7fb800">apply_batch()</font>**.
- `due_tick_cue` (_bool_) A boolean parameter to specify whether or not to perform a [carla.World.tick](#carla.World.tick) after applying the batch in _synchronous mode_. It is __False__ by default.
- **Return:** _list(command.Response)_
- <a name="carla.Client.generate_opendrive_world"></a>**<font color="#7fb800">generate_opendrive_world</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**opendrive**</font>, <font color="#00a6ed">**resolution**</font>, <font color="#00a6ed">**wall_height**</font>, <font color="#00a6ed">**additional_width**</font>)
- <a name="carla.Client.generate_opendrive_world"></a>**<font color="#7fb800">generate_opendrive_world</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**opendrive**</font>, <font color="#00a6ed">**parameters**</font>)
Loads a new world with a basic 3D topology generated from the content of an OpenDRIVE file. This content is passed as a `string` parameter. It is similar to `client.load_world(map_name)` but allows for custom OpenDRIVE maps in server side. Cars can drive around the map, but there are no graphics besides the road and sidewalks.
- **Parameters:**
- `opendrive` (_str_) Content of an OpenDRIVE file as `string`.
- `resolution` (_float_) Quality of the road mesh, increasing this value can reduce performance (in meters).
- `wall_height` (_float_) Height of a procedural wall that prevents cars from falling outside the map, only generated in non-junction roads (in meters).
- `additional_width` (_float_) Additional lane width to prevent cars from falling outside the map, only generated in junctions (in meters).
- `opendrive` (_str_) Content of an OpenDRIVE file as `string` (**NOT** the path of the `.xodr` file!).
- `parameters` (_[carla.OpendriveGenerationParameters](#carla.OpendriveGenerationParameters)_) Parameters used when generating a world using an OpenDRIVE file.
- <a name="carla.Client.load_world"></a>**<font color="#7fb800">load_world</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**map_name**</font>)
Creates a new world with default settings using `map_name` map. All actors in the current world will be destroyed.
- **Parameters:**
@ -1079,17 +1077,17 @@ Distance between `actor` and `other`.
This class defines the parameters used when generating a world using an OpenDRIVE file.
<h3>Instance Variables</h3>
- <a name="carla.OpendriveGenerationParameters.vertex_distance"></a>**<font color="#f8805a">vertex_distance</font>**
- <a name="carla.OpendriveGenerationParameters.vertex_distance"></a>**<font color="#f8805a">vertex_distance</font>** (_float_)
The distance between vertices when generating the world mesh from OpenDRIVE.
- <a name="carla.OpendriveGenerationParameters.max_road_length"></a>**<font color="#f8805a">max_road_length</font>**
- <a name="carla.OpendriveGenerationParameters.max_road_length"></a>**<font color="#f8805a">max_road_length</font>** (_float_)
Max road length for a single mesh portion.
- <a name="carla.OpendriveGenerationParameters.wall_height"></a>**<font color="#f8805a">wall_height</font>**
- <a name="carla.OpendriveGenerationParameters.wall_height"></a>**<font color="#f8805a">wall_height</font>** (_float_)
Defines the height of walls added to roads to prevent vehicles from falling.
- <a name="carla.OpendriveGenerationParameters.additional_width"></a>**<font color="#f8805a">additional_width</font>**
- <a name="carla.OpendriveGenerationParameters.additional_width"></a>**<font color="#f8805a">additional_width</font>** (_float_)
Additional with to junction lanes to prevent vehicles from falling.
- <a name="carla.OpendriveGenerationParameters.smooth_junctions"></a>**<font color="#f8805a">smooth_junctions</font>**
- <a name="carla.OpendriveGenerationParameters.smooth_junctions"></a>**<font color="#f8805a">smooth_junctions</font>** (_bool_)
When this variable is `True` the generated junctions will be smoothed to prevent roads from blocking other roads.
- <a name="carla.OpendriveGenerationParameters.enable_mesh_visibility"></a>**<font color="#f8805a">enable_mesh_visibility</font>**
- <a name="carla.OpendriveGenerationParameters.enable_mesh_visibility"></a>**<font color="#f8805a">enable_mesh_visibility</font>** (_bool_)
This variable indicates whether the mesh should be rendered to reduce the rendering overhead.
---

View File

@ -65,24 +65,11 @@
- param_name: opendrive
type: str
doc: >
Content of an OpenDRIVE file as `string`.
- param_name: resolution
type: float
defualt: 2.0
Content of an OpenDRIVE file as `string` (**NOT** the path of the `.xodr` file!).
- param_name: parameters
type: carla.OpendriveGenerationParameters
doc: >
Quality of the road mesh, increasing this value can reduce performance (in meters).
- param_name: wall_height
type: float
defualt: 1.0
doc: >
Height of a procedural wall that prevents cars from falling outside the map, only generated
in non-junction roads (in meters).
- param_name: additional_width
type: float
defualt: 0.6
doc: >
Additional lane width to prevent cars from falling outside the map, only generated in
junctions (in meters).
Parameters used when generating a world using an OpenDRIVE file.
doc: >
Loads a new world with a basic 3D topology generated from the content of an OpenDRIVE file. This content is passed as a `string` parameter.
It is similar to `client.load_world(map_name)` but allows for custom OpenDRIVE maps in server side.
@ -436,20 +423,26 @@
# - PROPERTIES -------------------------
instance_variables:
- var_name: vertex_distance
type: float
doc: >
The distance between vertices when generating the world mesh from OpenDRIVE.
- var_name: max_road_length
type: float
doc: >
Max road length for a single mesh portion.
- var_name: wall_height
type: float
doc: >
Defines the height of walls added to roads to prevent vehicles from falling.
- var_name: additional_width
type: float
doc: >
Additional with to junction lanes to prevent vehicles from falling.
- var_name: smooth_junctions
type: bool
doc: >
When this variable is `True` the generated junctions will be smoothed to prevent roads from blocking other roads.
- var_name: enable_mesh_visibility
type: bool
doc: >
This variable indicates whether the mesh should be rendered to reduce the rendering overhead.