diff --git a/Docs/python_api.md b/Docs/python_api.md index d5f201f8e..a91b043b3 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -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 **apply_batch()**. - `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)_ -- **generate_opendrive_world**(**self**, **opendrive**, **resolution**, **wall_height**, **additional_width**) +- **generate_opendrive_world**(**self**, **opendrive**, **parameters**) 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. - **load_world**(**self**, **map_name**) 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.

Instance Variables

-- **vertex_distance** +- **vertex_distance** (_float_) The distance between vertices when generating the world mesh from OpenDRIVE. -- **max_road_length** +- **max_road_length** (_float_) Max road length for a single mesh portion. -- **wall_height** +- **wall_height** (_float_) Defines the height of walls added to roads to prevent vehicles from falling. -- **additional_width** +- **additional_width** (_float_) Additional with to junction lanes to prevent vehicles from falling. -- **smooth_junctions** +- **smooth_junctions** (_bool_) When this variable is `True` the generated junctions will be smoothed to prevent roads from blocking other roads. -- **enable_mesh_visibility** +- **enable_mesh_visibility** (_bool_) This variable indicates whether the mesh should be rendered to reduce the rendering overhead. --- diff --git a/PythonAPI/docs/client.yml b/PythonAPI/docs/client.yml index 22a88e479..c5e0c10a6 100644 --- a/PythonAPI/docs/client.yml +++ b/PythonAPI/docs/client.yml @@ -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.