diff --git a/Docs/python_api.md b/Docs/python_api.md index bd2b35d08..e106c74ee 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -88,7 +88,7 @@ - [**OnRamp**](#carla.LaneType.OnRamp) _Instance variable_ - [**Any**](#carla.LaneType.Any) _Instance variable_ - [**SensorData**](#carla.SensorData) _Class_ - - [**frame_number**](#carla.SensorData.frame_number) _Instance variable_ + - [**frame**](#carla.SensorData.frame) _Instance variable_ - [**timestamp**](#carla.SensorData.timestamp) _Instance variable_ - [**transform**](#carla.SensorData.transform) _Instance variable_ - [**TrafficLightState**](#carla.TrafficLightState) _Class_ @@ -226,6 +226,7 @@ - [**transform_to_geolocation**(**self**, **location**)](#carla.Map.transform_to_geolocation) _Method_ - [**to_opendrive**(**self**)](#carla.Map.to_opendrive) _Method_ - [**save_to_disk**(**self**, **path**)](#carla.Map.save_to_disk) _Method_ + - [**\__str__**(**self**)](#carla.Map.__str__) _Method_ - [**ObstacleDetectionEvent**](#carla.ObstacleDetectionEvent) _Class_ - [**actor**](#carla.ObstacleDetectionEvent.actor) _Instance variable_ - [**other_actor**](#carla.ObstacleDetectionEvent.other_actor) _Instance variable_ @@ -342,6 +343,7 @@ - [**next**(**self**, **distance**)](#carla.Waypoint.next) _Method_ - [**get_right_lane**(**self**)](#carla.Waypoint.get_right_lane) _Method_ - [**get_left_lane**(**self**)](#carla.Waypoint.get_left_lane) _Method_ + - [**\__str__**(**self**)](#carla.Waypoint.__str__) _Method_ - [**WeatherParameters**](#carla.WeatherParameters) _Class_ - [**cloudyness**](#carla.WeatherParameters.cloudyness) _Instance variable_ - [**precipitation**](#carla.WeatherParameters.precipitation) _Instance variable_ @@ -404,22 +406,24 @@ - [**height**](#carla.Image.height) _Instance variable_ - [**fov**](#carla.Image.fov) _Instance variable_ - [**raw_data**](#carla.Image.raw_data) _Instance variable_ - - [**convert**(**self**)](#carla.Image.convert) _Method_ - - [**save_to_disk**(**self**)](#carla.Image.save_to_disk) _Method_ + - [**convert**(**self**, **color_converter**)](#carla.Image.convert) _Method_ + - [**save_to_disk**(**self**, **path**, **color_converter**=Raw)](#carla.Image.save_to_disk) _Method_ - [**\__len__**(**self**)](#carla.Image.__len__) _Method_ - [**\__iter__**(**self**)](#carla.Image.__iter__) _Method_ - - [**\__getitem__**(**self**)](#carla.Image.__getitem__) _Method_ - - [**\__setitem__**(**self**)](#carla.Image.__setitem__) _Method_ + - [**\__getitem__**(**self**, **pos**)](#carla.Image.__getitem__) _Method_ + - [**\__setitem__**(**self**, **pos**, **color**)](#carla.Image.__setitem__) _Method_ + - [**\__str__**(**self**)](#carla.Image.__str__) _Method_ - [**LidarMeasurement**](#carla.LidarMeasurement) _Class_ - [**horizontal_angle**](#carla.LidarMeasurement.horizontal_angle) _Instance variable_ - [**channels**](#carla.LidarMeasurement.channels) _Instance variable_ - [**raw_data**](#carla.LidarMeasurement.raw_data) _Instance variable_ - - [**get_point_count**(**self**)](#carla.LidarMeasurement.get_point_count) _Method_ - - [**save_to_disk**(**self**)](#carla.LidarMeasurement.save_to_disk) _Method_ + - [**get_point_count**(**self**, **channel**)](#carla.LidarMeasurement.get_point_count) _Method_ + - [**save_to_disk**(**self**, **path**)](#carla.LidarMeasurement.save_to_disk) _Method_ - [**\__len__**(**self**)](#carla.LidarMeasurement.__len__) _Method_ - [**\__iter__**(**self**)](#carla.LidarMeasurement.__iter__) _Method_ - - [**\__getitem__**(**self**)](#carla.LidarMeasurement.__getitem__) _Method_ - - [**\__setitem__**(**self**)](#carla.LidarMeasurement.__setitem__) _Method_ + - [**\__getitem__**(**self**, **pos**)](#carla.LidarMeasurement.__getitem__) _Method_ + - [**\__setitem__**(**self**, **pos**, **location**)](#carla.LidarMeasurement.__setitem__) _Method_ + - [**\__str__**(**self**)](#carla.LidarMeasurement.__str__) _Method_ - [**Location**](#carla.Location) _Class_ - [**x**](#carla.Location.x) _Instance variable_ - [**y**](#carla.Location.y) _Instance variable_ @@ -556,8 +560,8 @@ ## carla.AttachmentType _class_

Instance Variables

-- **Rigid** (_int_) -- **SpringArm** (_int_) +- **Rigid** +- **SpringArm** --- @@ -686,11 +690,16 @@ Defines the lane marking types that OpenDRIVE accepts. - **Broken** - **Solid** - **SolidSolid** +For double solid line. - **SolidBroken** +From inside to outside except for center lane which is from left to right. - **BrokenSolid** +From inside to outside except for center lane which is from left to right. - **BrokenBroken** +From inside to outside except for center lane which is from left to right. - **BottsDots** - **Grass** +Grass edge. - **Curb** --- @@ -727,9 +736,12 @@ All the possible lane types that OpenDRIVE accepts. ## carla.SensorData _class_

Instance Variables

-- **frame_number** +- **frame** +Frame count when the data was generated. - **timestamp** +Simulation-time when the data was generated. - **transform** +Sensor's transform when the data was generated. --- @@ -1047,9 +1059,12 @@ This function executes some commands altogether as fast as it can one after the ## carla.CollisionEvent([carla.SensorData](#carla.SensorData)) _class_

Instance Variables

-- **actor** -- **other_actor** -- **normal_impulse** +- **actor** (_[carla.Actor](#carla.Actor)_) +Get "self" actor. Actor that measured the collision. +- **other_actor** (_[carla.Actor](#carla.Actor)_) +Get the actor to which we collided. +- **normal_impulse** (_[carla.Vector3D](#carla.Vector3D)_) +Normal impulse result of the collision. --- @@ -1102,17 +1117,19 @@ Contains geolocation simulated data. ## carla.GnssEvent([carla.SensorData](#carla.SensorData)) _class_

Instance Variables

-- **latitude** -- **longitude** -- **altitude** +- **latitude** (_float_) +- **longitude** (_float_) +- **altitude** (_float_) --- ## carla.LaneInvasionEvent([carla.SensorData](#carla.SensorData)) _class_

Instance Variables

-- **actor** -- **crossed_lane_markings** +- **actor** (_[carla.Actor](#carla.Actor)_) +Get "self" actor. Actor that invaded another lane. +- **crossed_lane_markings** (_list([carla.LaneMarking](#carla.LaneMarking))_) +List of lane markings that have been crossed. --- @@ -1160,15 +1177,19 @@ Returns the OpenDRIVE of the current map as string. Save the OpenDRIVE of the current map to disk. - **Parameters:** - `path` – Path where it will be saved. +- **\__str__**(**self**) --- ## carla.ObstacleDetectionEvent([carla.SensorData](#carla.SensorData)) _class_

Instance Variables

-- **actor** -- **other_actor** -- **distance** +- **actor** (_[carla.Actor](#carla.Actor)_) +Get "self" actor. Actor that measured the collision. +- **other_actor** (_[carla.Actor](#carla.Actor)_) +Get the actor to which we collided. +- **distance** (_float_) +Get obstacle distance. --- @@ -1506,6 +1527,7 @@ Can return `None` if the lane does not exist. Generates a Waypoint at the center of the left lane based on the direction of the current Waypoint, regardless if the lane change is allowed in this location. Can return `None` if the lane does not exist. - **Return:** _[carla.Waypoint](#carla.Waypoint)_ +- **\__str__**(**self**) --- @@ -1692,12 +1714,20 @@ Find an ActorSnapshot by id. - **raw_data**

Methods

-- **convert**(**self**) -- **save_to_disk**(**self**) +- **convert**(**self**, **color_converter**) + - **Parameters:** + - `color_converter` (_[carla.ColorConverter](#carla.ColorConverter)_) +- **save_to_disk**(**self**, **path**, **color_converter**=Raw) + - **Parameters:** + - `path` (_str_) + - `color_converter` (_[carla.ColorConverter](#carla.ColorConverter)_) - **\__len__**(**self**) - **\__iter__**(**self**) -- **\__getitem__**(**self**) -- **\__setitem__**(**self**) +- **\__getitem__**(**self**, **pos**) +- **\__setitem__**(**self**, **pos**, **color**) + - **Parameters:** + - `color` (_[carla.Color](#carla.Color)_) +- **\__str__**(**self**) --- @@ -1709,12 +1739,17 @@ Find an ActorSnapshot by id. - **raw_data**

Methods

-- **get_point_count**(**self**) -- **save_to_disk**(**self**) +- **get_point_count**(**self**, **channel**) +- **save_to_disk**(**self**, **path**) + - **Parameters:** + - `path` (_str_) - **\__len__**(**self**) - **\__iter__**(**self**) -- **\__getitem__**(**self**) -- **\__setitem__**(**self**) +- **\__getitem__**(**self**, **pos**) +- **\__setitem__**(**self**, **pos**, **location**) + - **Parameters:** + - `location` (_[carla.Location](#carla.Location)_) +- **\__str__**(**self**) --- diff --git a/PythonAPI/docs/map.yml b/PythonAPI/docs/map.yml index aa32a3264..54c42bb0b 100644 --- a/PythonAPI/docs/map.yml +++ b/PythonAPI/docs/map.yml @@ -111,16 +111,21 @@ doc: > - var_name: SolidSolid doc: > + For double solid line. - var_name: SolidBroken doc: > + From inside to outside except for center lane which is from left to right. - var_name: BrokenSolid doc: > + From inside to outside except for center lane which is from left to right. - var_name: BrokenBroken doc: > + From inside to outside except for center lane which is from left to right. - var_name: BottsDots doc: > - var_name: Grass doc: > + Grass edge. - var_name: Curb doc: > @@ -219,6 +224,10 @@ Path where it will be saved doc: > Save the OpenDRIVE of the current map to disk + # -------------------------------------- + - def_name: __str__ + doc: > + # -------------------------------------- - class_name: LaneMarking # - DESCRIPTION ------------------------ @@ -340,4 +349,7 @@ Can return `None` if the lane does not exist # -------------------------------------- + - def_name: __str__ + doc: > + # -------------------------------------- ... diff --git a/PythonAPI/docs/sensor_data.yml b/PythonAPI/docs/sensor_data.yml index 735e41e15..ac867c362 100644 --- a/PythonAPI/docs/sensor_data.yml +++ b/PythonAPI/docs/sensor_data.yml @@ -8,12 +8,15 @@ doc: > # - PROPERTIES ------------------------- instance_variables: - - var_name: frame_number + - var_name: frame doc: > + Frame count when the data was generated. - var_name: timestamp doc: > + Simulation-time when the data was generated. - var_name: transform doc: > + Sensor's transform when the data was generated. - class_name: ColorConverter # - DESCRIPTION ------------------------ @@ -46,9 +49,18 @@ # - METHODS ---------------------------- methods: - def_name: convert + params: + - param_name: color_converter + type: carla.ColorConverter doc: > # -------------------------------------- - def_name: save_to_disk + params: + - param_name: path + type: str + - param_name: color_converter + type: carla.ColorConverter + default: Raw doc: > # -------------------------------------- - def_name: __len__ @@ -58,9 +70,18 @@ doc: > # -------------------------------------- - def_name: __getitem__ + params: + - param_name: pos doc: > # -------------------------------------- - def_name: __setitem__ + params: + - param_name: pos + - param_name: color + type: carla.Color + doc: > + # -------------------------------------- + - def_name: __str__ doc: > # -------------------------------------- @@ -79,9 +100,14 @@ # - METHODS ---------------------------- methods: - def_name: get_point_count + params: + - param_name: channel doc: > # -------------------------------------- - def_name: save_to_disk + params: + - param_name: path + type: str doc: > # -------------------------------------- - def_name: __len__ @@ -91,9 +117,18 @@ doc: > # -------------------------------------- - def_name: __getitem__ + params: + - param_name: pos doc: > # -------------------------------------- - def_name: __setitem__ + params: + - param_name: pos + - param_name: location + type: carla.Location + doc: > + # -------------------------------------- + - def_name: __str__ doc: > # -------------------------------------- @@ -104,11 +139,17 @@ # - PROPERTIES ------------------------- instance_variables: - var_name: actor + type: carla.Actor doc: > + Get "self" actor. Actor that measured the collision. - var_name: other_actor + type: carla.Actor doc: > + Get the actor to which we collided. - var_name: normal_impulse + type: carla.Vector3D doc: > + Normal impulse result of the collision. - class_name: ObstacleDetectionEvent parent: carla.SensorData @@ -117,11 +158,18 @@ # - PROPERTIES ------------------------- instance_variables: - var_name: actor + type: carla.Actor doc: > + Get "self" actor. Actor that measured the collision. - var_name: other_actor + type: carla.Actor doc: > + Get the actor to which we collided. - var_name: distance + type: float doc: > + Get obstacle distance. + # -------------------------------------- - class_name: LaneInvasionEvent parent: carla.SensorData @@ -130,9 +178,14 @@ # - PROPERTIES ------------------------- instance_variables: - var_name: actor + type: carla.Actor doc: > + Get "self" actor. Actor that invaded another lane. - var_name: crossed_lane_markings + type: list(carla.LaneMarking) doc: > + List of lane markings that have been crossed. + # -------------------------------------- - class_name: GnssEvent parent: carla.SensorData @@ -141,9 +194,12 @@ # - PROPERTIES ------------------------- instance_variables: - var_name: latitude + type: float doc: > - var_name: longitude + type: float doc: > - var_name: altitude + type: float doc: > ... diff --git a/PythonAPI/docs/world.yml b/PythonAPI/docs/world.yml index 87f4b5d7a..ded92e833 100644 --- a/PythonAPI/docs/world.yml +++ b/PythonAPI/docs/world.yml @@ -129,10 +129,8 @@ # - PROPERTIES ------------------------- instance_variables: - var_name: Rigid - type: int doc: > - var_name: SpringArm - type: int doc: > # --------------------------------------