diff --git a/Docs/python_api.md b/Docs/python_api.md index ec043d0e4..4c9cde36d 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -340,13 +340,13 @@ - [**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_ + - [**cloudiness**](#carla.WeatherParameters.cloudiness) _Instance variable_ - [**precipitation**](#carla.WeatherParameters.precipitation) _Instance variable_ - [**precipitation_deposits**](#carla.WeatherParameters.precipitation_deposits) _Instance variable_ - [**wind_intensity**](#carla.WeatherParameters.wind_intensity) _Instance variable_ - [**sun_azimuth_angle**](#carla.WeatherParameters.sun_azimuth_angle) _Instance variable_ - [**sun_altitude_angle**](#carla.WeatherParameters.sun_altitude_angle) _Instance variable_ - - [**\__init__**(**self**, **cloudyness**=0.0, **precipitation**=0.0, **precipitation_deposits**=0.0, **wind_intensity**=0.0, **sun_azimuth_angle**=0.0, **sun_altitude_angle**=0.0)](#carla.WeatherParameters.__init__) _Method_ + - [**\__init__**(**self**, **cloudiness**=0.0, **precipitation**=0.0, **precipitation_deposits**=0.0, **wind_intensity**=0.0, **sun_azimuth_angle**=0.0, **sun_altitude_angle**=0.0)](#carla.WeatherParameters.__init__) _Method_ - [**\__eq__**(**self**, **other**)](#carla.WeatherParameters.__eq__) _Method_ - [**\__ne__**(**self**, **other**)](#carla.WeatherParameters.__ne__) _Method_ - [**\__str__**(**self**)](#carla.WeatherParameters.__str__) _Method_ @@ -543,7 +543,7 @@ --- ## carla.ActorList _class_ -Class that provides acces to actors. +Class that provides access to actors.

Methods

- **find**(**self**, **actor_id**) @@ -560,7 +560,7 @@ Class that provides acces to actors. --- ## carla.AttachmentType _class_ -Defines the attachment options. +Class that defines the attachment options.

Instance Variables

- **Rigid** @@ -569,7 +569,7 @@ Defines the attachment options. --- ## carla.BlueprintLibrary _class_ -Class that provides acces to blueprints. +Class that provides access to blueprints.

Methods

- **find**(**self**) @@ -586,7 +586,7 @@ Filters a list of ActorBlueprint with id or tags matching wildcard_pattern. --- ## carla.ColorConverter _class_ -Defines the color converter options. +Class that defines the color converter options.

Instance Variables

- **Raw** @@ -644,7 +644,7 @@ Class that provides drawing debug shapes. --- ## carla.LaneChange _class_ -Defines the lane change options. +Class that defines the lane change options.

Instance Variables

- **NONE** @@ -674,7 +674,7 @@ Horizontal lane marking thickness. --- ## carla.LaneMarkingColor _class_ -Defines the lane marking colors. +Class that defines the lane marking colors.

Instance Variables

- **Standard** @@ -689,7 +689,7 @@ White by default. --- ## carla.LaneMarkingType _class_ -Defines the lane marking types that OpenDRIVE accepts. +Class that defines the lane marking types that OpenDRIVE accepts.

Instance Variables

- **NONE** @@ -771,7 +771,7 @@ Actor is anything that plays a role in the simulation and can be moved around, e

Instance Variables

- **id** (_int_) -Unique id identifying this actor. Note ids are only unique during a given episode. +Unique id identifying this actor. Note ids are unique during a given episode. - **type_id** (_str_) Id of the blueprint that created this actor, e.g. "vehicle.ford.mustang". - **parent** (_[carla.Actor](#carla.Actor)_) @@ -842,7 +842,7 @@ Enable or disable physics simulation on this actor. --- ## carla.ActorAttribute _class_ -Defines an attribute of a [carla.ActorBlueprint](#carla.ActorBlueprint). +Class that defines an attribute of a [carla.ActorBlueprint](#carla.ActorBlueprint).

Instance Variables

- **id** (_str_) @@ -902,7 +902,7 @@ Defines an attribute of a [carla.ActorBlueprint](#carla.ActorBlueprint). --- ## carla.ActorBlueprint _class_ -Contains all the necessary information for spawning an Actor. +Class that contains all the necessary information for spawning an Actor.

Instance Variables

- **id** (_str_) @@ -939,7 +939,7 @@ _ --- ## carla.ActorSnapshot _class_ -Provides acces to the data of a [carla.Actor](#carla.Actor) in a [carla.WorldSnapshot](#carla.WorldSnapshot). +Class that provides access to the data of a [carla.Actor](#carla.Actor) in a [carla.WorldSnapshot](#carla.WorldSnapshot).

Instance Variables

- **id** (_int_) @@ -964,7 +964,7 @@ Bounding box helper class. - **location** (_[carla.Location](#carla.Location)_) The center of the bounding box in the world. - **extent** (_[carla.Vector3D](#carla.Vector3D)_) -Contains the vector from the center of the bounding box to one of the vertex of the box. +It contains the vector from the center of the bounding box to one of the vertex of the box. So, if you want to know the _X bounding box size_, you can just do `extent.x * 2`.

Methods

@@ -1047,7 +1047,7 @@ So, if you want to see only collisions about a vehicle and a walker, we would us - `category1` (_single char_) – Character specifying the category of the first actor. - `category2` (_single char_) – Character specifying the category of the second actor. - **show_recorder_actors_blocked**(**self**, **filename**, **min_time**, **min_distance**) -Shows which actors seems blocked by some reason. The idea is to calculate which actors are not moving as much as 'min_distance' for a period of 'min_time'. By default min_time = 60 seconds (1 min) and min_distance = 100 centimeters (1 m). +Shows which actors seem blocked by some reason. The idea is to calculate which actors are not moving as much as 'min_distance' for a period of 'min_time'. By default min_time = 60 seconds (1 min) and min_distance = 100 centimeters (1 m). - **Parameters:** - `filename` (_str_) – Name of the recorded file to load. - `min_time` (_float_) – How many seconds has to be stoped an actor to be considered as blocked. @@ -1064,9 +1064,9 @@ Apply a different playback speed to current playback. Can be used several times - **Parameters:** - `time_factor` (_float_) – A value of 1.0 means normal time factor. A value < 1.0 means slow motion (for example 0.5 is half speed) A value > 1.0 means fast motion (for example 2.0 is double speed). - **apply_batch**(**self**, **commands**) -This function executes some commands altogether as fast as it can. For example, to set autopilot on on some actors, we could use: [sample_code](https://github.com/carla-simulator/carla/blob/10c5f6a482a21abfd00220c68c7f12b4110b7f63/PythonAPI/examples/spawn_npc.py#L126) We don't have control about the response of each command. If we need that, we can use apply_batch_sync(). +This function executes some commands altogether as fast as it can. For example, to set autopilot on some actors, we could use: [sample_code](https://github.com/carla-simulator/carla/blob/10c5f6a482a21abfd00220c68c7f12b4110b7f63/PythonAPI/examples/spawn_npc.py#L126) We don't have control about the response of each command. If we need that, we can use apply_batch_sync(). - **Parameters:** - - `commands` (_list_) – A list of commands to execute in batch. Each command have a different number of parameters. Currently we can use these [commands](#commands.ApplyAngularVelocity): + - `commands` (_list_) – A list of commands to execute in batch. Each command has a different number of parameters. Currently, we can use these [commands](#commands.ApplyAngularVelocity): SpawnActor DestroyActor ApplyVehicleControl @@ -1086,7 +1086,7 @@ This function executes some commands altogether as fast as it can one after the --- ## carla.CollisionEvent([carla.SensorData](#carla.SensorData)) _class_ -Defines a registered collision. +Class that defines a registered collision.

Instance Variables

- **actor** (_[carla.Actor](#carla.Actor)_) @@ -1099,7 +1099,7 @@ Normal impulse result of the collision. --- ## carla.Color _class_ -Defines a 32-bit BGRA color. +Class that defines a 32-bit BGRA color.

Instance Variables

- **r** @@ -1122,7 +1122,7 @@ Client constructor. --- ## carla.GeoLocation _class_ -Contains geolocation simulated data. +Class that contains geolocation simulated data.

Instance Variables

- **latitude** (_float_) @@ -1167,15 +1167,15 @@ Returns a list of transformations corresponding to the recommended spawn points - `location` (_[carla.Location](#carla.Location)_) – Location where you want to get the [carla.Waypoint](#carla.Waypoint). - `project_to_road` (_bool_) – If **True**, the waypoint will be at the center of the nearest lane. If **False**, the waypoint will be at the given location. Also, in this second case, the result may be `None` if the waypoint is not found. - - `lane_type` (_[carla.LaneType](#carla.LaneType)_) – This parameter is used to limit the search on a certain lane types. This can be used like a flag: `LaneType.Driving & LaneType.Shoulder`. + - `lane_type` (_[carla.LaneType](#carla.LaneType)_) – This parameter is used to limit the search on a certain lane type. This can be used like a flag: `LaneType.Driving & LaneType.Shoulder`. - **Return:** _[carla.Waypoint](#carla.Waypoint)_ - **get_topology**(**self**) -Provides a minimal graph of the topology of the current OpenDRIVE file. It is constituted by a list of pairs of waypoints, where the first waypoint is the origin and the second one is the destination. It can be loaded into [NetworkX](https://networkx.github.io/). A valid output could be: `[ (w0, w1), (w0, w2), (w1, w3), (w2, w3), (w0, w4) ]`. +It provides a minimal graph of the topology of the current OpenDRIVE file. It is constituted by a list of pairs of waypoints, where the first waypoint is the origin and the second one is the destination. It can be loaded into [NetworkX](https://networkx.github.io/). A valid output could be: `[ (w0, w1), (w0, w2), (w1, w3), (w2, w3), (w0, w4) ]`. - **Return:** _list(tuple([carla.Waypoint](#carla.Waypoint), [carla.Waypoint](#carla.Waypoint)))_ - **generate_waypoints**(**self**, **distance**) Returns a list of waypoints positioned on the center of the lanes all over the map with an approximate distance between them. - **Parameters:** - - `distance` (_float_) – Aproximate distance between the waypoints. + - `distance` (_float_) – Approximate distance between the waypoints. - **Return:** _list([carla.Waypoint](#carla.Waypoint))_ - **transform_to_geolocation**(**self**, **location**) Converts a given [carla.Location](#carla.Location) `(x, y, z)` to a [carla.GeoLocation](#carla.GeoLocation) `(lat, lon, alt)`. @@ -1226,11 +1226,11 @@ Computes a forward vector using the current rotation.

Instance Variables

- **frame** (_int_) -Number of frames elapsed since the simulator was launched. +The number of frames elapsed since the simulator was launched. - **elapsed_seconds** (_float_) Simulated seconds elapsed since the beginning of the current episode. - **delta_seconds** (_float_) -Simulated seconds elapsed since previous frame. +Simulated seconds elapsed since the previous frame. - **platform_timestamp** (_float_) Time-stamp of the frame at which this measurement was taken, in seconds as given by the OS. @@ -1259,7 +1259,7 @@ Time-stamp of the frame at which this measurement was taken, in seconds as given --- ## carla.Transform _class_ -Defines a transformation without scaling. +Class that defines a transformation without scaling.

Instance Variables

- **location** (_[carla.Location](#carla.Location)_) @@ -1362,15 +1362,15 @@ VehicleControl is used for controlling the basic movement of a vehicle.

Instance Variables

- **throttle** (_float_) -Scalar value to control the vehicle throttle. +A scalar value to control the vehicle throttle. - **steer** (_float_) -Scalar value to control the vehicle steering. +A scalar value to control the vehicle steering. - **brake** (_float_) -Scalar value to control the vehicle brake. +A scalar value to control the vehicle brake. - **hand_brake** (_bool_) If true, hand brake will be used. - **reverse** (_bool_) -If true, vehicle will move reverse. +If true, the vehicle will move reverse. - **manual_gear_shift** (_bool_) If true, the vehicle will be controlled by changing gears manually. - **gear** (_int_) @@ -1410,11 +1410,11 @@ The moment of inertia of the vehicle's engine. - **damping_rate_full_throttle** (_float_) Damping rate when the throttle is maximum. - **damping_rate_zero_throttle_clutch_engaged** (_float_) -Damping rate when the thottle is zero with clutch engaged. +Damping rate when the throttle is zero with clutch engaged. - **damping_rate_zero_throttle_clutch_disengaged** (_float_) Damping rate when the throttle is zero with clutch disengaged. - **use_gear_autobox** (_bool_) -If true, the vehicle will have automatic transmission. +If true, the vehicle will have an automatic transmission. - **gear_switch_time** (_float_) Switching time between gears. - **clutch_strength** (_float_) @@ -1428,7 +1428,7 @@ The center of mass of the vehicle. - **steering_curve** (_list([carla.Vector2D](#carla.Vector2D))_) Curve that indicates the maximum steering for a specific forward speed. - **wheels** (_list([carla.WheelPhysicsControl](#carla.WheelPhysicsControl))_) -List of [carla.WheelPhysicsControl](#carla.WheelPhysicsControl) objects. This list should have 4 elements, where index 0 corresponds to front left wheel, index 1 corresponds to front right wheel, index 2 corresponds to back left wheel and index 3 corresponds to back right wheel. For 2 wheeled vehicles, set same values for both front and back wheels. +List of [carla.WheelPhysicsControl](#carla.WheelPhysicsControl) objects. This list should have 4 elements, where index 0 corresponds to the front left wheel, index 1 corresponds to the front right wheel, index 2 corresponds to the back left wheel and index 3 corresponds to the back right wheel. For 2 wheeled vehicles, set the same values for both front and back wheels.

Methods

- **\__init__**(**self**, **torque_curve**=[[0.0, 500.0], [5000.0, 500.0]], **max_rpm**=5000.0, **moi**=1.0, **damping_rate_full_throttle**=0.15, **damping_rate_zero_throttle_clutch_engaged**=2.0, **damping_rate_zero_throttle_clutch_disengaged**=0.35, **use_gear_autobox**=True, **gear_switch_time**=0.5, **clutch_strength**=10.0, **mass**=1000.0, **drag_coefficient**=0.3, **center_of_mass**=[0.0, 0.0, 0.0], **steering_curve**=[0.0, 0.0, 0.0], **wheels**=list()) @@ -1482,9 +1482,9 @@ WalkerControl is used for controlling the basic movement of a walker.

Instance Variables

- **direction** (_[carla.Vector3D](#carla.Vector3D)_) -Vector that control the direction of the walker. +Vector that controls the direction of the walker. - **speed** (_float_) -Scalar value to control the walker speed. +A scalar value to control the walker speed. - **jump** (_bool_) If true, the walker will perform a jump. @@ -1520,17 +1520,17 @@ OpenDRIVE road's id. - **section_id** (_int_) OpenDRIVE section's id, based on the order that they are originally defined. - **lane_id** (_int_) -OpenDRIVE lane's id, this value can be positive or negative which represents the direction of the current lane with respect to the road. For more information refer to OpenDRIVE [documentaion](http://www.opendrive.org/docs/OpenDRIVEFormatSpecRev1.4H.pdf#page=20). +OpenDRIVE lane's id, this value can be positive or negative which represents the direction of the current lane with respect to the road. For more information refer to OpenDRIVE [documentation](http://www.opendrive.org/docs/OpenDRIVEFormatSpecRev1.4H.pdf#page=20). - **s** (_float_) OpenDRIVE `s` value of the current position. - **lane_change** (_[carla.LaneChange](#carla.LaneChange)_) -Lane change definition of the current Waypoint's location, based on the traffic rules defined in the OpenDRIVE file. Basically it tells you if a lane change can be done and in which direction. +Lane change definition of the current Waypoint's location, based on the traffic rules defined in the OpenDRIVE file. Basically, it tells you if a lane change can be done and in which direction. - **lane_type** (_[carla.LaneType](#carla.LaneType)_) The lane type of the current Waypoint, based on OpenDRIVE types. - **right_lane_marking** (_[carla.LaneMarking](#carla.LaneMarking)_) -The right lane marking information based on the directin of the Waypoint. +The right lane marking information based on the direction of the Waypoint. - **left_lane_marking** (_[carla.LaneMarking](#carla.LaneMarking)_) -The left lane marking information based on the directin of the Waypoint. +The left lane marking information based on the direction of the Waypoint.

Methods

- **next**(**self**, **distance**) @@ -1555,8 +1555,8 @@ Can return `None` if the lane does not exist. WeatherParameters class is used for requesting and changing the lighting and weather conditions inside the world.

Instance Variables

-- **cloudyness** (_float_) -Weather cloudyness. Values range from 0 to 100. +- **cloudiness** (_float_) +Weather cloudiness. Values range from 0 to 100. - **precipitation** (_float_) Precipitation amount for controlling rain intensity. Values range from 0 to 100. - **precipitation_deposits** (_float_) @@ -1564,15 +1564,15 @@ Precipitation deposits for controlling the area of puddles on roads. Values rang - **wind_intensity** (_float_) Wind intensity. Values range from 0 to 100. - **sun_azimuth_angle** (_float_) -Azimuth angle of the sun in degrees. Values range from 0 to 360. +The azimuth angle of the sun in degrees. Values range from 0 to 360. - **sun_altitude_angle** (_float_) Altitude angle of the sun in degrees. Values range from -90 to 90.

Methods

-- **\__init__**(**self**, **cloudyness**=0.0, **precipitation**=0.0, **precipitation_deposits**=0.0, **wind_intensity**=0.0, **sun_azimuth_angle**=0.0, **sun_altitude_angle**=0.0) +- **\__init__**(**self**, **cloudiness**=0.0, **precipitation**=0.0, **precipitation_deposits**=0.0, **wind_intensity**=0.0, **sun_azimuth_angle**=0.0, **sun_altitude_angle**=0.0) WeatherParameters constructor. - **Parameters:** - - `cloudyness` (_float_) + - `cloudiness` (_float_) - `precipitation` (_float_) - `precipitation_deposits` (_float_) - `wind_intensity` (_float_) @@ -1593,7 +1593,7 @@ WheelPhysicsControl is used for controlling the physics parameters of a vehicle'

Instance Variables

- **tire_friction** (_float_) -Scalar value that indicates the friction of the wheel. +A scalar value that indicates the friction of the wheel. - **damping_rate** (_float_) The damping rate of the wheel. - **max_steer_angle** (_float_) @@ -1625,7 +1625,7 @@ The id of the episode associated with this world.

Methods

- **get_blueprint_library**(**self**) -Return the list of blueprints available in this world. This blueprints can be used to spawning actor into the world. +Return the list of blueprints available in this world. These blueprints can be used to spawn actors into the world. - **Return:** _[carla.BlueprintLibrary](#carla.BlueprintLibrary)_ - **get_map**(**self**) Return the map that describes this world. @@ -1753,7 +1753,7 @@ Return number of ActorSnapshots present in this WorldSnapshot. --- ## carla.Image([carla.SensorData](#carla.SensorData)) _class_ -Defines an image of 32-bit BGRA colors. +Class that defines an image of 32-bit BGRA colors.

Instance Variables

- **width** (_int_) @@ -1878,7 +1878,7 @@ Is true if the sensor is listening for data.

Methods

- **listen**(**self**, **callback**) - **Parameters:** - - `callback` (_function_) – Function that will be called each time the sensor sends data. As a parameter the function receives a buffer with the data. + - `callback` (_function_) – Function that will be called each time the sensor sends data. As a parameter, the function receives a buffer with the data. - **stop**(**self**) Stops listening for data. - **\__str__**(**self**) @@ -1945,7 +1945,7 @@ A vehicle actor.

Instance Variables

- **bounding_box** (_[carla.BoundingBox](#carla.BoundingBox)_) -Bounding box of the vehicle. +The bounding box of the vehicle.

Methods

- **apply_control**(**self**, **control**) @@ -1958,7 +1958,7 @@ Return the control last applied to this vehicle. - **Note:** _This function does not call the simulator, it returns the data received in the last tick. _ - **apply_physics_control**(**self**, **physics_control**) -Apply physics control to this vehicle. The control will take effect on next tick. +Apply physics control to this vehicle. The control will take effect on the next tick. - **Parameters:** - `physics_control` (_[carla.VehiclePhysicsControl](#carla.VehiclePhysicsControl)_) - **get_physics_control**(**self**) @@ -1997,11 +1997,11 @@ A walking actor, pedestrian.

Instance Variables

- **bounding_box** (_[carla.BoundingBox](#carla.BoundingBox)_) -Bounding box of the walker. +The bounding box of the walker.

Methods

- **apply_control**(**self**, **control**) -Apply control to this walker. The control will take effect on next tick. +Apply control to this walker. The control will take effect on the next tick. - **Parameters:** - `control` (_[carla.WalkerControl](#carla.WalkerControl)_) - **apply_control**(**self**, **control**) diff --git a/Docs/python_api_tutorial.md b/Docs/python_api_tutorial.md index 6f8e9cbc9..7b83532aa 100644 --- a/Docs/python_api_tutorial.md +++ b/Docs/python_api_tutorial.md @@ -107,8 +107,8 @@ transform = Transform(Location(x=230, y=195, z=40), Rotation(yaw=180)) actor = world.spawn_actor(blueprint, transform) ``` -The spawn actor function comes in two flavours, [`spawn_actor`](../python_api/#carla.World.spawn_actor) and -[`try_spawn_actor`](../python_api/#carla.World.try_spawn_actor). The former will raise an exception if the actor could not be +The spawn actor function comes in two flavours, [`spawn_actor`](python_api.md#carla.World.spawn_actor) and +[`try_spawn_actor`](python_api.md#carla.World.try_spawn_actor). The former will raise an exception if the actor could not be spawned, the later will return `None` instead. The most typical cause of failure is collision at spawn point, meaning the actor does not fit at the spot we chose; probably another vehicle is in that spot or we tried to spawn into a @@ -180,7 +180,7 @@ by providing throttle, break, and steer values vehicle.apply_control(carla.VehicleControl(throttle=1.0, steer=-1.0)) ``` -These are all the parameters of the [`VehicleControl`](../python_api/#carla.VehicleControl) object and their default +These are all the parameters of the [`VehicleControl`](python_api.md#carla.VehicleControl) object and their default values ```py @@ -199,7 +199,7 @@ Also, physics control properties can be tuned for vehicles and its wheels vehicle.apply_physics_control(carla.VehiclePhysicsControl(max_rpm = 5000.0, center_of_mass = carla.Vector3D(0.0, 0.0, 0.0), torque_curve=[[0,400],[5000,400]])) ``` -These properties are controlled through a [`VehiclePhysicsControl`](../python_api/#carla.VehiclePhysicsControl) object, which also contains a property to control each wheel's physics through a [`WheelPhysicsControl`](../python_api/#carla.WheelPhysicsControl) object. +These properties are controlled through a [`VehiclePhysicsControl`](python_api.md#carla.VehiclePhysicsControl) object, which also contains a property to control each wheel's physics through a [`WheelPhysicsControl`](python_api.md#carla.WheelPhysicsControl) object. ```py carla.VehiclePhysicsControl( @@ -237,7 +237,7 @@ Where: - *drag_coefficient*: Drag coefficient of the vehicle's chassis - *center_of_mass*: The center of mass of the vehicle - *steering_curve*: Curve that indicates the maximum steering for a specific forward speed -- *wheels*: List of [`WheelPhysicsControl`](../python_api/#carla.WheelPhysicsControl) objects. +- *wheels*: List of [`WheelPhysicsControl`](python_api.md#carla.WheelPhysicsControl) objects. ```py carla.WheelPhysicsControl( @@ -327,7 +327,7 @@ for speed_sign in actor_list.filter('traffic.speed_limit.*'): Among the actors you can find in this list are - * **Traffic lights** with a `state` property to check the light's current state. + * **Traffic lights** with a [`state`](python_api.md#carla.TrafficLight.state) property to check the light's current state. * **Speed limit signs** with the speed codified in their type_id. * The **Spectator** actor that can be used to move the view of the simulator window. @@ -355,7 +355,7 @@ world.set_weather(carla.WeatherParameters.WetCloudySunset) ``` The full list of presets can be found in the -[WeatherParameters reference](python_api.md#carlaweatherparameters). +[WeatherParameters reference](python_api.md#carla.WeatherParameters). ### World Snapshot @@ -410,7 +410,7 @@ Let's start by getting the map of the current world map = world.get_map() ``` -For starters, the map has a `name` attribute that matches the name of the +For starters, the map has a [`name`](python_api.md#carla.Map.name) attribute that matches the name of the currently loaded city, e.g. Town01. And, as we've seen before, we can also ask the map to provide a list of recommended locations for spawning vehicles, `map.get_spawn_points()`. @@ -423,7 +423,7 @@ vehicle waypoint = map.get_waypoint(vehicle.get_location()) ``` -This waypoint's `transform` is located on a drivable lane, and it's oriented +This waypoint's [`transform`](python_api.md#carla.Waypoint.transform) is located on a drivable lane, and it's oriented according to the road direction at that point. Waypoints also have function to query the "next" waypoints; this method returns diff --git a/PythonAPI/docs/actor.yml b/PythonAPI/docs/actor.yml index 258bb14fb..fccc1d40a 100644 --- a/PythonAPI/docs/actor.yml +++ b/PythonAPI/docs/actor.yml @@ -150,7 +150,7 @@ - var_name: bounding_box type: carla.BoundingBox doc: > - The Bounding box of the vehicle. + The bounding box of the vehicle. # - METHODS ---------------------------- methods: - def_name: apply_control @@ -238,7 +238,7 @@ - var_name: bounding_box type: carla.BoundingBox doc: > - Bounding box of the walker. + The bounding box of the walker. # - METHODS ---------------------------- methods: - def_name: apply_control diff --git a/PythonAPI/docs/blueprint.yml b/PythonAPI/docs/blueprint.yml index 084f68edc..edf3097e0 100644 --- a/PythonAPI/docs/blueprint.yml +++ b/PythonAPI/docs/blueprint.yml @@ -22,7 +22,7 @@ - class_name: Color # - DESCRIPTION ------------------------ doc: > - Class defines a 32-bit BGRA color. + Class that defines a 32-bit BGRA color. # - PROPERTIES ------------------------- instance_variables: - var_name: r diff --git a/PythonAPI/docs/client.yml b/PythonAPI/docs/client.yml index 441ce55da..7151f2a86 100644 --- a/PythonAPI/docs/client.yml +++ b/PythonAPI/docs/client.yml @@ -194,7 +194,7 @@ - param_name: commands type: list doc: > - A list of commands to execute in batch. Each command have a different number of parameters. + A list of commands to execute in batch. Each command has a different number of parameters. Currently, we can use these [commands](#commands.ApplyAngularVelocity): SpawnActor DestroyActor @@ -208,7 +208,7 @@ SetAutopilot doc: > This function executes some commands altogether as fast as it can. - For example, to set autopilot on on some actors, we could use: + For example, to set autopilot on some actors, we could use: [sample_code](https://github.com/carla-simulator/carla/blob/10c5f6a482a21abfd00220c68c7f12b4110b7f63/PythonAPI/examples/spawn_npc.py#L126) We don't have control about the response of each command. If we need that, we can use apply_batch_sync(). diff --git a/PythonAPI/docs/control.yml b/PythonAPI/docs/control.yml index d45235092..069a16a74 100644 --- a/PythonAPI/docs/control.yml +++ b/PythonAPI/docs/control.yml @@ -32,7 +32,7 @@ - var_name: reverse type: bool doc: > - If true, vehicle will move reverse. + If true, the vehicle will move reverse. # -------------------------------------- - var_name: manual_gear_shift type: bool @@ -95,7 +95,7 @@ - var_name: direction type: carla.Vector3D doc: > - Vector that control the direction of the walker. + Vector that controls the direction of the walker. # -------------------------------------- - var_name: speed type: float @@ -230,7 +230,7 @@ - var_name: wheels type: list(carla.WheelPhysicsControl) doc: > - List of carla.WheelPhysicsControl objects. This list should have 4 elements, where index 0 corresponds to front left wheel, index 1 corresponds to front right wheel, index 2 corresponds to back left wheel and index 3 corresponds to back right wheel. For 2 wheeled vehicles, set the same values for both front and back wheels. + List of carla.WheelPhysicsControl objects. This list should have 4 elements, where index 0 corresponds to the front left wheel, index 1 corresponds to the front right wheel, index 2 corresponds to the back left wheel and index 3 corresponds to the back right wheel. For 2 wheeled vehicles, set the same values for both front and back wheels. # - METHODS ---------------------------- methods: diff --git a/PythonAPI/docs/world.yml b/PythonAPI/docs/world.yml index 35e15b130..91cf5a3be 100644 --- a/PythonAPI/docs/world.yml +++ b/PythonAPI/docs/world.yml @@ -11,7 +11,7 @@ - var_name: frame type: int doc: > - Number of frames elapsed since the simulator was launched. + The number of frames elapsed since the simulator was launched. - var_name: elapsed_seconds type: float doc: > @@ -19,7 +19,7 @@ - var_name: delta_seconds type: float doc: > - Simulated seconds elapsed since previous frame. + Simulated seconds elapsed since the previous frame. - var_name: platform_timestamp type: float doc: > @@ -159,7 +159,7 @@ return: carla.BlueprintLibrary doc: > Return the list of blueprints available in this world. These blueprints - can be used to spawning actors into the world. + can be used to spawn actors into the world. # -------------------------------------- - def_name: get_map return: carla.Map