Updated docs
This commit is contained in:
Axel1092
bernat
parent
f6676ca8e9
commit
41ef5040f0
|
|
@ -1367,36 +1367,6 @@ Returns a waypoint if all the parameters passed are correct. Otherwise, returns
|
|||
|
||||
---
|
||||
|
||||
## carla.OSM2ODR<a name="carla.OSM2ODR"></a>
|
||||
Class that performs the conversion of Open Street Maps data to OpenDRIVE.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.OSM2ODR.convert_to_odr"></a>**<font color="#7fb800">convert_to_odr</font>**(<font color="#00a6ed">**osm_file**</font>, <font color="#00a6ed">**settings**</font>)
|
||||
Converts a Open Street Maps file to OpenDRIVE format using the settings provided by the second argument.
|
||||
- **Parameters:**
|
||||
- `osm_file` (_str_) – The input Open Street Maps xml data.
|
||||
- `settings` (_[carla.OSM2ODRSettings](#carla.OSM2ODRSettings)_) – The settings used for the conversion.
|
||||
- **Return:** _str_
|
||||
|
||||
---
|
||||
|
||||
## carla.OSM2ODRSettings<a name="carla.OSM2ODRSettings"></a>
|
||||
Class containing settings to perform the conversion of Open Street Map data to OpenDRIVE.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.OSM2ODRSettings.use_offsets"></a>**<font color="#f8805a">use_offsets</font>** (_bool_)
|
||||
Enables the use of offset to position the map.
|
||||
- <a name="carla.OSM2ODRSettings.offset_x"></a>**<font color="#f8805a">offset_x</font>** (_float_)
|
||||
Offset in the x axis.
|
||||
- <a name="carla.OSM2ODRSettings.offset_y"></a>**<font color="#f8805a">offset_y</font>** (_float_)
|
||||
Offset in the y axis.
|
||||
- <a name="carla.OSM2ODRSettings.default_lane_width"></a>**<font color="#f8805a">default_lane_width</font>** (_float_)
|
||||
Defines the default width of lanes.
|
||||
- <a name="carla.OSM2ODRSettings.elevation_layer_height"></a>**<font color="#f8805a">elevation_layer_height</font>** (_float_)
|
||||
Defines the height of the different layers defined in Open Street Map data (see https://wiki.openstreetmap.org/wiki/Key:layer).
|
||||
|
||||
---
|
||||
|
||||
## carla.ObstacleDetectionEvent<a name="carla.ObstacleDetectionEvent"></a>
|
||||
<div style="padding-left:30px;margin-top:-20px"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines the obstacle data for <b>sensor.other.obstacle</b>. Learn more about this [here](ref_sensors.md#obstacle-detector).
|
||||
|
||||
|
|
@ -1436,6 +1406,23 @@ If __True__, Pedestrian navigation will be enabled using Recast tool. For very l
|
|||
|
||||
---
|
||||
|
||||
## carla.Osm2OdrSettings<a name="carla.Osm2OdrSettings"></a>
|
||||
Class containing settings to perform the conversion of Open Street Map data to OpenDRIVE.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.Osm2OdrSettings.use_offsets"></a>**<font color="#f8805a">use_offsets</font>** (_bool_)
|
||||
Enables the use of offset to position the map.
|
||||
- <a name="carla.Osm2OdrSettings.offset_x"></a>**<font color="#f8805a">offset_x</font>** (_float_)
|
||||
Offset in the x axis.
|
||||
- <a name="carla.Osm2OdrSettings.offset_y"></a>**<font color="#f8805a">offset_y</font>** (_float_)
|
||||
Offset in the y axis.
|
||||
- <a name="carla.Osm2OdrSettings.default_lane_width"></a>**<font color="#f8805a">default_lane_width</font>** (_float_)
|
||||
Defines the default width of lanes.
|
||||
- <a name="carla.Osm2OdrSettings.elevation_layer_height"></a>**<font color="#f8805a">elevation_layer_height</font>** (_float_)
|
||||
Defines the height of the different layers defined in Open Street Map data (see https://wiki.openstreetmap.org/wiki/Key:layer).
|
||||
|
||||
---
|
||||
|
||||
## carla.RadarDetection<a name="carla.RadarDetection"></a>
|
||||
Data contained inside a [carla.RadarMeasurement](#carla.RadarMeasurement). Each of these represents one of the points in the cloud that a <b>sensor.other.radar</b> registers and contains the distance, angle and velocity in relation to the radar.
|
||||
|
||||
|
|
@ -2790,6 +2777,19 @@ Returns <b>True</b> if both **<font color="#f8805a">timestamp</font>** are diffe
|
|||
|
||||
---
|
||||
|
||||
## carla.osm2odr<a name="carla.osm2odr"></a>
|
||||
Class that performs the conversion of Open Street Maps data to OpenDRIVE.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.osm2odr.convert"></a>**<font color="#7fb800">convert</font>**(<font color="#00a6ed">**osm_file**</font>, <font color="#00a6ed">**settings**</font>)
|
||||
Converts a Open Street Maps file to OpenDRIVE format using the settings provided by the second argument.
|
||||
- **Parameters:**
|
||||
- `osm_file` (_str_) – The input Open Street Maps xml data.
|
||||
- `settings` (_[carla.OSM2ODRSettings](#carla.OSM2ODRSettings)_) – The settings used for the conversion.
|
||||
- **Return:** _str_
|
||||
|
||||
---
|
||||
|
||||
## command.ApplyAngularImpulse<a name="command.ApplyAngularImpulse"></a>
|
||||
Command adaptation of **<font color="#7fb800">add_angular_impulse()</font>** in [carla.Actor](#carla.Actor). Adds angular impulse to an actor.
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ void export_osm2odr() {
|
|||
using namespace osm2odr;
|
||||
using namespace boost::python;
|
||||
|
||||
class_<OSM2ODRSettings>("Osm2odrSettings", init<>())
|
||||
class_<OSM2ODRSettings>("Osm2OdrSettings", init<>())
|
||||
.add_property("use_offsets", &OSM2ODRSettings::use_offsets, &OSM2ODRSettings::use_offsets)
|
||||
.add_property("offset_x", &OSM2ODRSettings::offset_x, &OSM2ODRSettings::offset_x)
|
||||
.add_property("offset_y", &OSM2ODRSettings::offset_y, &OSM2ODRSettings::offset_y)
|
||||
|
|
@ -33,7 +33,7 @@ void export_osm2odr() {
|
|||
;
|
||||
|
||||
class_<OSM2ODR>("osm2odr", no_init)
|
||||
.def("convert", &ConvertOSMToOpenDRIVE, (arg("osm_file"), arg("osm2odr_settings") = OSM2ODRSettings()))
|
||||
.def("convert", &ConvertOSMToOpenDRIVE, (arg("osm_file"), arg("settings") = OSM2ODRSettings()))
|
||||
.staticmethod("convert")
|
||||
;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,13 +3,13 @@
|
|||
|
||||
# - CLASSES ------------------------------
|
||||
classes:
|
||||
- class_name: OSM2ODR
|
||||
- class_name: osm2odr
|
||||
# - DESCRIPTION ------------------------
|
||||
doc: >
|
||||
Class that performs the conversion of Open Street Maps data to OpenDRIVE.
|
||||
# - METHODS ----------------------------
|
||||
methods:
|
||||
- def_name: convert_to_odr
|
||||
- def_name: convert
|
||||
static:
|
||||
True
|
||||
return: str
|
||||
|
|
@ -27,7 +27,7 @@
|
|||
doc: >
|
||||
Converts a Open Street Maps file to OpenDRIVE format using the settings provided by the second argument.
|
||||
# --------------------------------------
|
||||
- class_name: OSM2ODRSettings
|
||||
- class_name: Osm2OdrSettings
|
||||
# - DESCRIPTION ------------------------
|
||||
doc: >
|
||||
Class containing settings to perform the conversion of Open Street Map data to OpenDRIVE.
|
||||
|
|
|
|||
Loading…
Reference in New Issue