First iteration with getters, setters and previous APIs
This commit is contained in:
sergi-e
Marc Garcia Puig
parent
3893a32df4
commit
564b7b9408
|
|
@ -0,0 +1,125 @@
|
|||
# Python API reference (0.9.0)
|
||||
|
||||
This reference contains all the details about the Python API as it was for __CARLA 0.9.0__.
|
||||
|
||||
<div class="build-buttons">
|
||||
<p>
|
||||
<a href="../../python_api" target="_blank" class="btn btn-neutral" title="Go back to the latest version of the Python API">
|
||||
Back to latest</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
!!! important
|
||||
Versions prior to 0.9.0 have a very different API. For the documentation of the stable version please switch to the [stable branch](https://carla.readthedocs.io/en/stable/).
|
||||
|
||||
## `carla.Client`
|
||||
|
||||
- `Client(host, port, worker_threads=0)`
|
||||
- `set_timeout(milliseconds)`
|
||||
- `get_client_version()`
|
||||
- `get_server_version()`
|
||||
- `ping()`
|
||||
- `get_world()`
|
||||
|
||||
## `carla.World`
|
||||
|
||||
- `get_blueprint_library()`
|
||||
- `get_spectator()`
|
||||
- `spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `try_spawn_actor(blueprint, transform, attach_to=None)`
|
||||
|
||||
## `carla.BlueprintLibrary`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorBlueprint`
|
||||
|
||||
- `id`
|
||||
- `tags`
|
||||
- `contains_tag(tag)`
|
||||
- `match_tags(wildcard_pattern)`
|
||||
- `contains_attribute(key)`
|
||||
- `get_attribute(key)`
|
||||
- `set_attribute(key, value)`
|
||||
|
||||
## `carla.ActorAttribute`
|
||||
|
||||
- `is_modifiable`
|
||||
- `type`
|
||||
- `recommended_values`
|
||||
- `as_bool()`
|
||||
- `as_int()`
|
||||
- `as_float()`
|
||||
- `as_str()`
|
||||
- `as_color()`
|
||||
- `__eq__()`
|
||||
- `__ne__()`
|
||||
- `__nonzero__()`
|
||||
- `__bool__()`
|
||||
- `__int__()`
|
||||
- `__float__()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.Actor`
|
||||
|
||||
- `id`
|
||||
- `type_id`
|
||||
- `get_world()`
|
||||
- `get_location()`
|
||||
- `get_transform()`
|
||||
- `set_location(location)`
|
||||
- `set_transform(transform)`
|
||||
- `destroy()`
|
||||
|
||||
## `carla.Vehicle(carla.Actor)`
|
||||
|
||||
- `apply_control(vehicle_control)`
|
||||
- `set_autopilot(enabled=True)`
|
||||
|
||||
## `carla.Sensor(carla.Actor)`
|
||||
|
||||
- `listen(callback_function)`
|
||||
|
||||
## `carla.Image`
|
||||
|
||||
- `frame_number`
|
||||
- `width`
|
||||
- `height`
|
||||
- `type`
|
||||
- `fov`
|
||||
- `raw_data`
|
||||
|
||||
## `carla.VehicleControl`
|
||||
|
||||
- `throttle`
|
||||
- `steer`
|
||||
- `brake`
|
||||
- `hand_brake`
|
||||
- `reverse`
|
||||
|
||||
## `carla.Location`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
|
||||
## `carla.Rotation`
|
||||
|
||||
- `pitch`
|
||||
- `yaw`
|
||||
- `roll`
|
||||
|
||||
## `carla.Transform`
|
||||
|
||||
- `location`
|
||||
- `rotation`
|
||||
|
||||
## `carla.Color`
|
||||
|
||||
- `r`
|
||||
- `g`
|
||||
- `b`
|
||||
|
|
@ -0,0 +1,309 @@
|
|||
# Python API reference (0.9.1)
|
||||
|
||||
This reference contains all the details about the Python API as it was for __CARLA 0.9.1__.
|
||||
|
||||
<div class="build-buttons">
|
||||
<p>
|
||||
<a href="../../python_api" target="_blank" class="btn btn-neutral" title="Go back to the latest version of the Python API">
|
||||
Back to latest</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## `carla.Client`
|
||||
|
||||
- `Client(host, port, worker_threads=0)`
|
||||
- `set_timeout(float_seconds)`
|
||||
- `get_client_version()`
|
||||
- `get_server_version()`
|
||||
- `get_world()`
|
||||
|
||||
## `carla.World`
|
||||
|
||||
- `id`
|
||||
- `map_name`
|
||||
- `debug`
|
||||
- `get_blueprint_library()`
|
||||
- `get_map()`
|
||||
- `get_spectator()`
|
||||
- `get_weather()`
|
||||
- `set_weather(weather_parameters)`
|
||||
- `get_actors()`
|
||||
- `spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `try_spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `wait_for_tick(seconds=1.0)`
|
||||
- `on_tick(callback)`
|
||||
|
||||
## `carla.DebugHelper`
|
||||
|
||||
- `draw_point(location, size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_line(begin, end, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_arrow(begin, end, thickness=0.1, arrow_size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_box(box, rotation, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_string(location, text, draw_shadow=False, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
|
||||
## `carla.BlueprintLibrary`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorBlueprint`
|
||||
|
||||
- `id`
|
||||
- `tags`
|
||||
- `has_tag(tag)`
|
||||
- `match_tags(wildcard_pattern)`
|
||||
- `has_attribute(key)`
|
||||
- `get_attribute(key)`
|
||||
- `set_attribute(key, value)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorAttribute`
|
||||
|
||||
- `id`
|
||||
- `type`
|
||||
- `recommended_values`
|
||||
- `is_modifiable`
|
||||
- `as_bool()`
|
||||
- `as_int()`
|
||||
- `as_float()`
|
||||
- `as_str()`
|
||||
- `as_color()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
- `__nonzero__()`
|
||||
- `__bool__()`
|
||||
- `__int__()`
|
||||
- `__float__()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.ActorList`
|
||||
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.Actor`
|
||||
|
||||
- `id`
|
||||
- `type_id`
|
||||
- `parent`
|
||||
- `semantic_tags`
|
||||
- `is_alive`
|
||||
- `get_world()`
|
||||
- `get_location()`
|
||||
- `get_transform()`
|
||||
- `get_velocity()`
|
||||
- `get_acceleration()`
|
||||
- `set_location(location)`
|
||||
- `set_transform(transform)`
|
||||
- `set_simulate_physics(enabled=True)`
|
||||
- `destroy()`
|
||||
|
||||
## `carla.Vehicle(carla.Actor)`
|
||||
|
||||
- `bounding_box`
|
||||
- `apply_control(vehicle_control)`
|
||||
- `get_vehicle_control()`
|
||||
- `set_autopilot(enabled=True)`
|
||||
|
||||
## `carla.TrafficLight(carla.Actor)`
|
||||
|
||||
- `state`
|
||||
|
||||
## `carla.Sensor(carla.Actor)`
|
||||
|
||||
- `is_listening`
|
||||
- `listen(callback_function)`
|
||||
- `stop()`
|
||||
|
||||
## `carla.SensorData`
|
||||
|
||||
- `frame_number`
|
||||
- `transform`
|
||||
|
||||
## `carla.Image(carla.SensorData)`
|
||||
|
||||
- `width`
|
||||
- `height`
|
||||
- `fov`
|
||||
- `raw_data`
|
||||
- `convert(color_converter)`
|
||||
- `save_to_disk(path, color_converter=None)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, color)`
|
||||
|
||||
## `carla.LidarMeasurement(carla.SensorData)`
|
||||
|
||||
- `horizontal_angle`
|
||||
- `channels`
|
||||
- `raw_data`
|
||||
- `get_point_count(channel)`
|
||||
- `save_to_disk(path)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, location)`
|
||||
|
||||
## `carla.CollisionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `normal_impulse`
|
||||
|
||||
## `carla.LaneInvasionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `crossed_lane_markings`
|
||||
|
||||
## `carla.VehicleControl`
|
||||
|
||||
- `throttle`
|
||||
- `steer`
|
||||
- `brake`
|
||||
- `hand_brake`
|
||||
- `reverse`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Map`
|
||||
|
||||
- `name`
|
||||
- `get_spawn_points()`
|
||||
- `get_waypoint(location, project_to_road=True)`
|
||||
- `get_topology()`
|
||||
- `generate_waypoints(distance)`
|
||||
- `to_opendrive()`
|
||||
- `save_to_disk(path=self.name)`
|
||||
|
||||
## `carla.Waypoint`
|
||||
|
||||
- `transform`
|
||||
- `is_intersection`
|
||||
- `lane_width`
|
||||
- `road_id`
|
||||
- `lane_id`
|
||||
- `next(distance)`
|
||||
|
||||
## `carla.WeatherParameters`
|
||||
|
||||
- `cloudyness`
|
||||
- `precipitation`
|
||||
- `precipitation_deposits`
|
||||
- `wind_intensity`
|
||||
- `sun_azimuth_angle`
|
||||
- `sun_altitude_angle`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
Static presets
|
||||
|
||||
- `carla.WeatherParameters.ClearNoon`
|
||||
- `carla.WeatherParameters.CloudyNoon`
|
||||
- `carla.WeatherParameters.WetNoon`
|
||||
- `carla.WeatherParameters.WetCloudyNoon`
|
||||
- `carla.WeatherParameters.MidRainyNoon`
|
||||
- `carla.WeatherParameters.HardRainNoon`
|
||||
- `carla.WeatherParameters.SoftRainNoon`
|
||||
- `carla.WeatherParameters.ClearSunset`
|
||||
- `carla.WeatherParameters.CloudySunset`
|
||||
- `carla.WeatherParameters.WetSunset`
|
||||
- `carla.WeatherParameters.WetCloudySunset`
|
||||
- `carla.WeatherParameters.MidRainSunset`
|
||||
- `carla.WeatherParameters.HardRainSunset`
|
||||
- `carla.WeatherParameters.SoftRainSunset`
|
||||
|
||||
## `carla.Vector3D`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Location`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `distance(other)`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Rotation`
|
||||
|
||||
- `pitch`
|
||||
- `yaw`
|
||||
- `roll`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Transform`
|
||||
|
||||
- `location`
|
||||
- `rotation`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.BoundingBox`
|
||||
|
||||
- `location`
|
||||
- `extent`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Timestamp`
|
||||
|
||||
- `frame_count`
|
||||
- `elapsed_seconds`
|
||||
- `delta_seconds`
|
||||
- `platform_timestamp`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Color`
|
||||
|
||||
- `r`
|
||||
- `g`
|
||||
- `b`
|
||||
- `a`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.ColorConverter`
|
||||
|
||||
- `Raw`
|
||||
- `Depth`
|
||||
- `LogarithmicDepth`
|
||||
- `CityScapesPalette`
|
||||
|
||||
## `carla.ActorAttributeType`
|
||||
|
||||
- `Bool`
|
||||
- `Int`
|
||||
- `Float`
|
||||
- `RGBColor`
|
||||
|
||||
## `carla.TrafficLightState`
|
||||
|
||||
- `Off`
|
||||
- `Red`
|
||||
- `Yellow`
|
||||
- `Green`
|
||||
- `Unknown`
|
||||
|
||||
## `carla.LaneMarking`
|
||||
|
||||
- `Other`
|
||||
- `Broken`
|
||||
- `Solid`
|
||||
|
|
@ -0,0 +1,311 @@
|
|||
# Python API reference (0.9.2)
|
||||
|
||||
This reference contains all the details about the Python API as it was for __CARLA 0.9.2__.
|
||||
|
||||
<div class="build-buttons">
|
||||
<p>
|
||||
<a href="../../python_api" target="_blank" class="btn btn-neutral" title="Go back to the latest version of the Python API">
|
||||
Back to latest</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## `carla.Client`
|
||||
|
||||
- `Client(host, port, worker_threads=0)`
|
||||
- `set_timeout(float_seconds)`
|
||||
- `get_client_version()`
|
||||
- `get_server_version()`
|
||||
- `get_world()`
|
||||
|
||||
## `carla.World`
|
||||
|
||||
- `id`
|
||||
- `map_name`
|
||||
- `debug`
|
||||
- `get_blueprint_library()`
|
||||
- `get_map()`
|
||||
- `get_spectator()`
|
||||
- `get_weather()`
|
||||
- `set_weather(weather_parameters)`
|
||||
- `get_actors()`
|
||||
- `spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `try_spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `wait_for_tick(seconds=1.0)`
|
||||
- `on_tick(callback)`
|
||||
|
||||
## `carla.DebugHelper`
|
||||
|
||||
- `draw_point(location, size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_line(begin, end, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_arrow(begin, end, thickness=0.1, arrow_size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_box(box, rotation, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_string(location, text, draw_shadow=False, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
|
||||
## `carla.BlueprintLibrary`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorBlueprint`
|
||||
|
||||
- `id`
|
||||
- `tags`
|
||||
- `has_tag(tag)`
|
||||
- `match_tags(wildcard_pattern)`
|
||||
- `has_attribute(key)`
|
||||
- `get_attribute(key)`
|
||||
- `set_attribute(key, value)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorAttribute`
|
||||
|
||||
- `id`
|
||||
- `type`
|
||||
- `recommended_values`
|
||||
- `is_modifiable`
|
||||
- `as_bool()`
|
||||
- `as_int()`
|
||||
- `as_float()`
|
||||
- `as_str()`
|
||||
- `as_color()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
- `__nonzero__()`
|
||||
- `__bool__()`
|
||||
- `__int__()`
|
||||
- `__float__()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.ActorList`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.Actor`
|
||||
|
||||
- `id`
|
||||
- `type_id`
|
||||
- `parent`
|
||||
- `semantic_tags`
|
||||
- `is_alive`
|
||||
- `attributes`
|
||||
- `get_world()`
|
||||
- `get_location()`
|
||||
- `get_transform()`
|
||||
- `get_velocity()`
|
||||
- `get_acceleration()`
|
||||
- `set_location(location)`
|
||||
- `set_transform(transform)`
|
||||
- `set_simulate_physics(enabled=True)`
|
||||
- `destroy()`
|
||||
|
||||
## `carla.Vehicle(carla.Actor)`
|
||||
|
||||
- `bounding_box`
|
||||
- `apply_control(vehicle_control)`
|
||||
- `get_vehicle_control()`
|
||||
- `set_autopilot(enabled=True)`
|
||||
|
||||
## `carla.TrafficLight(carla.Actor)`
|
||||
|
||||
- `state`
|
||||
|
||||
## `carla.Sensor(carla.Actor)`
|
||||
|
||||
- `is_listening`
|
||||
- `listen(callback_function)`
|
||||
- `stop()`
|
||||
|
||||
## `carla.SensorData`
|
||||
|
||||
- `frame_number`
|
||||
- `transform`
|
||||
|
||||
## `carla.Image(carla.SensorData)`
|
||||
|
||||
- `width`
|
||||
- `height`
|
||||
- `fov`
|
||||
- `raw_data`
|
||||
- `convert(color_converter)`
|
||||
- `save_to_disk(path, color_converter=None)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, color)`
|
||||
|
||||
## `carla.LidarMeasurement(carla.SensorData)`
|
||||
|
||||
- `horizontal_angle`
|
||||
- `channels`
|
||||
- `raw_data`
|
||||
- `get_point_count(channel)`
|
||||
- `save_to_disk(path)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, location)`
|
||||
|
||||
## `carla.CollisionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `normal_impulse`
|
||||
|
||||
## `carla.LaneInvasionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `crossed_lane_markings`
|
||||
|
||||
## `carla.VehicleControl`
|
||||
|
||||
- `throttle`
|
||||
- `steer`
|
||||
- `brake`
|
||||
- `hand_brake`
|
||||
- `reverse`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Map`
|
||||
|
||||
- `name`
|
||||
- `get_spawn_points()`
|
||||
- `get_waypoint(location, project_to_road=True)`
|
||||
- `get_topology()`
|
||||
- `generate_waypoints(distance)`
|
||||
- `to_opendrive()`
|
||||
- `save_to_disk(path=self.name)`
|
||||
|
||||
## `carla.Waypoint`
|
||||
|
||||
- `transform`
|
||||
- `is_intersection`
|
||||
- `lane_width`
|
||||
- `road_id`
|
||||
- `lane_id`
|
||||
- `next(distance)`
|
||||
|
||||
## `carla.WeatherParameters`
|
||||
|
||||
- `cloudyness`
|
||||
- `precipitation`
|
||||
- `precipitation_deposits`
|
||||
- `wind_intensity`
|
||||
- `sun_azimuth_angle`
|
||||
- `sun_altitude_angle`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
Static presets
|
||||
|
||||
- `carla.WeatherParameters.ClearNoon`
|
||||
- `carla.WeatherParameters.CloudyNoon`
|
||||
- `carla.WeatherParameters.WetNoon`
|
||||
- `carla.WeatherParameters.WetCloudyNoon`
|
||||
- `carla.WeatherParameters.MidRainyNoon`
|
||||
- `carla.WeatherParameters.HardRainNoon`
|
||||
- `carla.WeatherParameters.SoftRainNoon`
|
||||
- `carla.WeatherParameters.ClearSunset`
|
||||
- `carla.WeatherParameters.CloudySunset`
|
||||
- `carla.WeatherParameters.WetSunset`
|
||||
- `carla.WeatherParameters.WetCloudySunset`
|
||||
- `carla.WeatherParameters.MidRainSunset`
|
||||
- `carla.WeatherParameters.HardRainSunset`
|
||||
- `carla.WeatherParameters.SoftRainSunset`
|
||||
|
||||
## `carla.Vector3D`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Location`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `distance(other)`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Rotation`
|
||||
|
||||
- `pitch`
|
||||
- `yaw`
|
||||
- `roll`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Transform`
|
||||
|
||||
- `location`
|
||||
- `rotation`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.BoundingBox`
|
||||
|
||||
- `location`
|
||||
- `extent`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Timestamp`
|
||||
|
||||
- `frame_count`
|
||||
- `elapsed_seconds`
|
||||
- `delta_seconds`
|
||||
- `platform_timestamp`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Color`
|
||||
|
||||
- `r`
|
||||
- `g`
|
||||
- `b`
|
||||
- `a`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.ColorConverter`
|
||||
|
||||
- `Raw`
|
||||
- `Depth`
|
||||
- `LogarithmicDepth`
|
||||
- `CityScapesPalette`
|
||||
|
||||
## `carla.ActorAttributeType`
|
||||
|
||||
- `Bool`
|
||||
- `Int`
|
||||
- `Float`
|
||||
- `RGBColor`
|
||||
|
||||
## `carla.TrafficLightState`
|
||||
|
||||
- `Off`
|
||||
- `Red`
|
||||
- `Yellow`
|
||||
- `Green`
|
||||
- `Unknown`
|
||||
|
||||
## `carla.LaneMarking`
|
||||
|
||||
- `Other`
|
||||
- `Broken`
|
||||
- `Solid`
|
||||
|
|
@ -0,0 +1,341 @@
|
|||
# Python API reference (0.9.3)
|
||||
|
||||
This reference contains all the details about the Python API as it was for __CARLA 0.9.3__.
|
||||
|
||||
<div class="build-buttons">
|
||||
<p>
|
||||
<a href="../../python_api" target="_blank" class="btn btn-neutral" title="Go back to the latest version of the Python API">
|
||||
Back to latest</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## `carla.Client`
|
||||
|
||||
- `Client(host, port, worker_threads=0)`
|
||||
- `set_timeout(float_seconds)`
|
||||
- `get_client_version()`
|
||||
- `get_server_version()`
|
||||
- `get_world()`
|
||||
|
||||
## `carla.World`
|
||||
|
||||
- `id`
|
||||
- `map_name`
|
||||
- `debug`
|
||||
- `get_blueprint_library()`
|
||||
- `get_map()`
|
||||
- `get_spectator()`
|
||||
- `get_weather()`
|
||||
- `set_weather(weather_parameters)`
|
||||
- `get_actors()`
|
||||
- `spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `try_spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `wait_for_tick(seconds=1.0)`
|
||||
- `on_tick(callback)`
|
||||
|
||||
## `carla.DebugHelper`
|
||||
|
||||
- `draw_point(location, size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_line(begin, end, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_arrow(begin, end, thickness=0.1, arrow_size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_box(box, rotation, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_string(location, text, draw_shadow=False, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
|
||||
## `carla.BlueprintLibrary`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorBlueprint`
|
||||
|
||||
- `id`
|
||||
- `tags`
|
||||
- `has_tag(tag)`
|
||||
- `match_tags(wildcard_pattern)`
|
||||
- `has_attribute(key)`
|
||||
- `get_attribute(key)`
|
||||
- `set_attribute(key, value)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorAttribute`
|
||||
|
||||
- `id`
|
||||
- `type`
|
||||
- `recommended_values`
|
||||
- `is_modifiable`
|
||||
- `as_bool()`
|
||||
- `as_int()`
|
||||
- `as_float()`
|
||||
- `as_str()`
|
||||
- `as_color()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
- `__nonzero__()`
|
||||
- `__bool__()`
|
||||
- `__int__()`
|
||||
- `__float__()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.ActorList`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.Actor`
|
||||
|
||||
- `id`
|
||||
- `type_id`
|
||||
- `parent`
|
||||
- `semantic_tags`
|
||||
- `is_alive`
|
||||
- `attributes`
|
||||
- `get_world()`
|
||||
- `get_location()`
|
||||
- `get_transform()`
|
||||
- `get_velocity()`
|
||||
- `get_acceleration()`
|
||||
- `set_location(location)`
|
||||
- `set_transform(transform)`
|
||||
- `set_simulate_physics(enabled=True)`
|
||||
- `destroy()`
|
||||
|
||||
## `carla.Vehicle(carla.Actor)`
|
||||
|
||||
- `bounding_box`
|
||||
- `apply_control(vehicle_control)`
|
||||
- `get_control()`
|
||||
- `set_autopilot(enabled=True)`
|
||||
- `get_speed_limit()`
|
||||
- `get_traffic_light_state()`
|
||||
- `is_at_traffic_light()`
|
||||
- `get_traffic_light()`
|
||||
|
||||
## `carla.TrafficLight(carla.Actor)`
|
||||
|
||||
- `state`
|
||||
- `set_state(traffic_light_state)`
|
||||
- `get_state()`
|
||||
- `set_green_time(green_time)`
|
||||
- `get_green_time()`
|
||||
- `set_yellow_time(yellow_time)`
|
||||
- `get_yellow_time()`
|
||||
- `set_red_time(red_time)`
|
||||
- `get_red_time()`
|
||||
- `get_elapsed_time()`
|
||||
- `freeze(True)`
|
||||
- `is_frozen()`
|
||||
|
||||
## `carla.Sensor(carla.Actor)`
|
||||
|
||||
- `is_listening`
|
||||
- `listen(callback_function)`
|
||||
- `stop()`
|
||||
|
||||
## `carla.SensorData`
|
||||
|
||||
- `frame_number`
|
||||
- `transform`
|
||||
|
||||
## `carla.Image(carla.SensorData)`
|
||||
|
||||
- `width`
|
||||
- `height`
|
||||
- `fov`
|
||||
- `raw_data`
|
||||
- `convert(color_converter)`
|
||||
- `save_to_disk(path, color_converter=None)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, color)`
|
||||
|
||||
## `carla.LidarMeasurement(carla.SensorData)`
|
||||
|
||||
- `horizontal_angle`
|
||||
- `channels`
|
||||
- `raw_data`
|
||||
- `get_point_count(channel)`
|
||||
- `save_to_disk(path)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, location)`
|
||||
|
||||
## `carla.CollisionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `normal_impulse`
|
||||
|
||||
## `carla.LaneInvasionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `crossed_lane_markings`
|
||||
|
||||
## `carla.GnssEvent(carla.SensorData)`
|
||||
|
||||
- `latitude`
|
||||
- `longitude`
|
||||
- `altitude`
|
||||
|
||||
## `carla.ObstacleDetectionSensorEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `distance`
|
||||
|
||||
## `carla.VehicleControl`
|
||||
|
||||
- `throttle`
|
||||
- `steer`
|
||||
- `brake`
|
||||
- `hand_brake`
|
||||
- `reverse`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Map`
|
||||
|
||||
- `name`
|
||||
- `get_spawn_points()`
|
||||
- `get_waypoint(location, project_to_road=True)`
|
||||
- `get_topology()`
|
||||
- `generate_waypoints(distance)`
|
||||
- `to_opendrive()`
|
||||
- `save_to_disk(path=self.name)`
|
||||
|
||||
## `carla.Waypoint`
|
||||
|
||||
- `transform`
|
||||
- `is_intersection`
|
||||
- `lane_width`
|
||||
- `road_id`
|
||||
- `lane_id`
|
||||
- `next(distance)`
|
||||
|
||||
## `carla.WeatherParameters`
|
||||
|
||||
- `cloudyness`
|
||||
- `precipitation`
|
||||
- `precipitation_deposits`
|
||||
- `wind_intensity`
|
||||
- `sun_azimuth_angle`
|
||||
- `sun_altitude_angle`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
Static presets
|
||||
|
||||
- `carla.WeatherParameters.ClearNoon`
|
||||
- `carla.WeatherParameters.CloudyNoon`
|
||||
- `carla.WeatherParameters.WetNoon`
|
||||
- `carla.WeatherParameters.WetCloudyNoon`
|
||||
- `carla.WeatherParameters.MidRainyNoon`
|
||||
- `carla.WeatherParameters.HardRainNoon`
|
||||
- `carla.WeatherParameters.SoftRainNoon`
|
||||
- `carla.WeatherParameters.ClearSunset`
|
||||
- `carla.WeatherParameters.CloudySunset`
|
||||
- `carla.WeatherParameters.WetSunset`
|
||||
- `carla.WeatherParameters.WetCloudySunset`
|
||||
- `carla.WeatherParameters.MidRainSunset`
|
||||
- `carla.WeatherParameters.HardRainSunset`
|
||||
- `carla.WeatherParameters.SoftRainSunset`
|
||||
|
||||
## `carla.Vector3D`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Location`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `distance(other)`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Rotation`
|
||||
|
||||
- `pitch`
|
||||
- `yaw`
|
||||
- `roll`
|
||||
- `get_forward_vector()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Transform`
|
||||
|
||||
- `location`
|
||||
- `rotation`
|
||||
- `transform(geom_object)`
|
||||
- `get_forward_vector()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.BoundingBox`
|
||||
|
||||
- `location`
|
||||
- `extent`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Timestamp`
|
||||
|
||||
- `frame_count`
|
||||
- `elapsed_seconds`
|
||||
- `delta_seconds`
|
||||
- `platform_timestamp`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Color`
|
||||
|
||||
- `r`
|
||||
- `g`
|
||||
- `b`
|
||||
- `a`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.ColorConverter`
|
||||
|
||||
- `Raw`
|
||||
- `Depth`
|
||||
- `LogarithmicDepth`
|
||||
- `CityScapesPalette`
|
||||
|
||||
## `carla.ActorAttributeType`
|
||||
|
||||
- `Bool`
|
||||
- `Int`
|
||||
- `Float`
|
||||
- `RGBColor`
|
||||
|
||||
## `carla.TrafficLightState`
|
||||
|
||||
- `Red`
|
||||
- `Yellow`
|
||||
- `Green`
|
||||
- `Off`
|
||||
- `Unknown`
|
||||
|
||||
## `carla.LaneMarking`
|
||||
|
||||
- `Other`
|
||||
- `Broken`
|
||||
- `Solid`
|
||||
|
|
@ -0,0 +1,448 @@
|
|||
# Python API reference (0.9.4)
|
||||
|
||||
This reference contains all the details about the Python API as it was for __CARLA 0.9.4__.
|
||||
|
||||
<div class="build-buttons">
|
||||
<p>
|
||||
<a href="../../python_api" target="_blank" class="btn btn-neutral" title="Go back to the latest version of the Python API">
|
||||
Back to latest</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## `carla.Client`
|
||||
|
||||
- `Client(host, port, worker_threads=0)`
|
||||
- `set_timeout(float_seconds)`
|
||||
- `get_client_version()`
|
||||
- `get_server_version()`
|
||||
- `get_world()`
|
||||
- `get_available_maps()`
|
||||
- `reload_world()`
|
||||
- `load_world(map_name)`
|
||||
- `start_recorder(string filename)`
|
||||
- `replay_file(string filename, float start, float duration, int camera_follow_id)`
|
||||
- `show_recorder_file_info(string filename)`
|
||||
- `show_recorder_collisions(string filename, char category1, char category2)`
|
||||
- `show_recorder_actors_blocked(string filename, float min_time, float min_distance)`
|
||||
- `apply_batch(commands, do_tick=False)`
|
||||
|
||||
## `carla.World`
|
||||
|
||||
- `id`
|
||||
- `debug`
|
||||
- `get_blueprint_library()`
|
||||
- `get_map()`
|
||||
- `get_spectator()`
|
||||
- `get_settings()`
|
||||
- `apply_settings(world_settings)`
|
||||
- `get_weather()`
|
||||
- `set_weather(weather_parameters)`
|
||||
- `get_actors()`
|
||||
- `spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `try_spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `wait_for_tick(seconds=1.0)`
|
||||
- `on_tick(callback)`
|
||||
- `tick()`
|
||||
|
||||
## `carla.WorldSettings`
|
||||
|
||||
- `synchronous_mode`
|
||||
- `no_rendering_mode`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.DebugHelper`
|
||||
|
||||
- `draw_point(location, size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_line(begin, end, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_arrow(begin, end, thickness=0.1, arrow_size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_box(box, rotation, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_string(location, text, draw_shadow=False, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
|
||||
## `carla.BlueprintLibrary`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorBlueprint`
|
||||
|
||||
- `id`
|
||||
- `tags`
|
||||
- `has_tag(tag)`
|
||||
- `match_tags(wildcard_pattern)`
|
||||
- `has_attribute(key)`
|
||||
- `get_attribute(key)`
|
||||
- `set_attribute(key, value)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorAttribute`
|
||||
|
||||
- `id`
|
||||
- `type`
|
||||
- `recommended_values`
|
||||
- `is_modifiable`
|
||||
- `as_bool()`
|
||||
- `as_int()`
|
||||
- `as_float()`
|
||||
- `as_str()`
|
||||
- `as_color()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
- `__nonzero__()`
|
||||
- `__bool__()`
|
||||
- `__int__()`
|
||||
- `__float__()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.ActorList`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.Actor`
|
||||
|
||||
- `id`
|
||||
- `type_id`
|
||||
- `parent`
|
||||
- `semantic_tags`
|
||||
- `is_alive`
|
||||
- `attributes`
|
||||
- `get_world()`
|
||||
- `get_location()`
|
||||
- `get_transform()`
|
||||
- `get_velocity()`
|
||||
- `get_acceleration()`
|
||||
- `set_location(location)`
|
||||
- `set_transform(transform)`
|
||||
- `set_simulate_physics(enabled=True)`
|
||||
- `destroy()`
|
||||
|
||||
## `carla.Vehicle(carla.Actor)`
|
||||
|
||||
- `bounding_box`
|
||||
- `apply_control(vehicle_control)`
|
||||
- `get_control()`
|
||||
- `set_autopilot(enabled=True)`
|
||||
- `get_physics_control()`
|
||||
- `apply_physics_control(vehicle_physics_control)`
|
||||
- `get_speed_limit()`
|
||||
- `get_traffic_light_state()`
|
||||
- `is_at_traffic_light()`
|
||||
- `get_traffic_light()`
|
||||
|
||||
## `carla.TrafficLight(carla.Actor)`
|
||||
|
||||
- `state`
|
||||
- `set_state(traffic_light_state)`
|
||||
- `get_state()`
|
||||
- `set_green_time(green_time)`
|
||||
- `get_green_time()`
|
||||
- `set_yellow_time(yellow_time)`
|
||||
- `get_yellow_time()`
|
||||
- `set_red_time(red_time)`
|
||||
- `get_red_time()`
|
||||
- `get_elapsed_time()`
|
||||
- `freeze(True)`
|
||||
- `is_frozen()`
|
||||
- `get_pole_index()`
|
||||
- `get_group_traffic_lights()`
|
||||
|
||||
## `carla.Sensor(carla.Actor)`
|
||||
|
||||
- `is_listening`
|
||||
- `listen(callback_function)`
|
||||
- `stop()`
|
||||
|
||||
## `carla.SensorData`
|
||||
|
||||
- `frame_number`
|
||||
- `transform`
|
||||
|
||||
## `carla.Image(carla.SensorData)`
|
||||
|
||||
- `width`
|
||||
- `height`
|
||||
- `fov`
|
||||
- `raw_data`
|
||||
- `convert(color_converter)`
|
||||
- `save_to_disk(path, color_converter=None)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, color)`
|
||||
|
||||
## `carla.LidarMeasurement(carla.SensorData)`
|
||||
|
||||
- `horizontal_angle`
|
||||
- `channels`
|
||||
- `raw_data`
|
||||
- `get_point_count(channel)`
|
||||
- `save_to_disk(path)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, location)`
|
||||
|
||||
## `carla.CollisionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `normal_impulse`
|
||||
|
||||
## `carla.LaneInvasionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `crossed_lane_markings`
|
||||
|
||||
## `carla.GnssEvent(carla.SensorData)`
|
||||
|
||||
- `latitude`
|
||||
- `longitude`
|
||||
- `altitude`
|
||||
|
||||
## `carla.ObstacleDetectionSensorEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `distance`
|
||||
|
||||
## `carla.VehicleControl`
|
||||
|
||||
- `throttle`
|
||||
- `steer`
|
||||
- `brake`
|
||||
- `hand_brake`
|
||||
- `reverse`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
|
||||
## `carla.WheelsPhysicsControl`
|
||||
- `tire_friction`
|
||||
- `damping_rate`
|
||||
- `steer_angle`
|
||||
- `disable_steering`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.VehiclePhysicsControl`
|
||||
|
||||
- `torque_curve`
|
||||
- `max_rpm`
|
||||
- `moi`
|
||||
- `damping_rate_full_throttle`
|
||||
- `damping_rate_zero_throttle_clutch_engaged`
|
||||
- `damping_rate_zero_throttle_clutch_disengaged`
|
||||
- `use_gear_autobox`
|
||||
- `gear_switch_time`
|
||||
- `clutch_strength`
|
||||
- `mass`
|
||||
- `drag_coefficient`
|
||||
- `center_of_mass`
|
||||
- `steering_curve`
|
||||
- `wheels`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Map`
|
||||
|
||||
- `name`
|
||||
- `get_spawn_points()`
|
||||
- `get_waypoint(location, project_to_road=True)`
|
||||
- `get_topology()`
|
||||
- `generate_waypoints(distance)`
|
||||
- `to_opendrive()`
|
||||
- `save_to_disk(path=self.name)`
|
||||
|
||||
## `carla.Waypoint`
|
||||
|
||||
- `transform`
|
||||
- `is_intersection`
|
||||
- `lane_width`
|
||||
- `road_id`
|
||||
- `lane_id`
|
||||
- `lane_change`
|
||||
- `lane_type`
|
||||
- `next(distance)`
|
||||
- `get_right_lane()`
|
||||
- `get_left_lane()`
|
||||
|
||||
## `carla.LaneChange`
|
||||
- `None`
|
||||
- `Right`
|
||||
- `Left`
|
||||
- `Both`
|
||||
|
||||
## `carla.WeatherParameters`
|
||||
|
||||
- `cloudyness`
|
||||
- `precipitation`
|
||||
- `precipitation_deposits`
|
||||
- `wind_intensity`
|
||||
- `sun_azimuth_angle`
|
||||
- `sun_altitude_angle`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
Static presets
|
||||
|
||||
- `carla.WeatherParameters.ClearNoon`
|
||||
- `carla.WeatherParameters.CloudyNoon`
|
||||
- `carla.WeatherParameters.WetNoon`
|
||||
- `carla.WeatherParameters.WetCloudyNoon`
|
||||
- `carla.WeatherParameters.MidRainyNoon`
|
||||
- `carla.WeatherParameters.HardRainNoon`
|
||||
- `carla.WeatherParameters.SoftRainNoon`
|
||||
- `carla.WeatherParameters.ClearSunset`
|
||||
- `carla.WeatherParameters.CloudySunset`
|
||||
- `carla.WeatherParameters.WetSunset`
|
||||
- `carla.WeatherParameters.WetCloudySunset`
|
||||
- `carla.WeatherParameters.MidRainSunset`
|
||||
- `carla.WeatherParameters.HardRainSunset`
|
||||
- `carla.WeatherParameters.SoftRainSunset`
|
||||
|
||||
## `carla.Vector3D`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Location`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `distance(other)`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Rotation`
|
||||
|
||||
- `pitch`
|
||||
- `yaw`
|
||||
- `roll`
|
||||
- `get_forward_vector()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Transform`
|
||||
|
||||
- `location`
|
||||
- `rotation`
|
||||
- `transform(geom_object)`
|
||||
- `get_forward_vector()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.BoundingBox`
|
||||
|
||||
- `location`
|
||||
- `extent`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Timestamp`
|
||||
|
||||
- `frame_count`
|
||||
- `elapsed_seconds`
|
||||
- `delta_seconds`
|
||||
- `platform_timestamp`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Color`
|
||||
|
||||
- `r`
|
||||
- `g`
|
||||
- `b`
|
||||
- `a`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.ColorConverter`
|
||||
|
||||
- `Raw`
|
||||
- `Depth`
|
||||
- `LogarithmicDepth`
|
||||
- `CityScapesPalette`
|
||||
|
||||
## `carla.ActorAttributeType`
|
||||
|
||||
- `Bool`
|
||||
- `Int`
|
||||
- `Float`
|
||||
- `RGBColor`
|
||||
|
||||
## `carla.TrafficLightState`
|
||||
|
||||
- `Red`
|
||||
- `Yellow`
|
||||
- `Green`
|
||||
- `Off`
|
||||
- `Unknown`
|
||||
|
||||
## `carla.LaneMarking`
|
||||
|
||||
- `Other`
|
||||
- `Broken`
|
||||
- `Solid`
|
||||
|
||||
# module `carla.command`
|
||||
|
||||
## `carla.command.DestroyActor`
|
||||
|
||||
- `actor_id`
|
||||
|
||||
## `carla.command.ApplyVehicleControl`
|
||||
|
||||
- `actor_id`
|
||||
- `control`
|
||||
|
||||
## `carla.command.ApplyWalkerControl`
|
||||
|
||||
- `actor_id`
|
||||
- `control`
|
||||
|
||||
## `carla.command.ApplyTransform`
|
||||
|
||||
- `actor_id`
|
||||
- `transform`
|
||||
|
||||
## `carla.command.ApplyVelocity`
|
||||
|
||||
- `actor_id`
|
||||
- `velocity`
|
||||
|
||||
## `carla.command.ApplyAngularVelocity`
|
||||
|
||||
- `actor_id`
|
||||
- `angular_velocity`
|
||||
|
||||
|
||||
## `carla.command.ApplyImpulse`
|
||||
|
||||
- `actor_id`
|
||||
- `impulse`
|
||||
|
||||
## `carla.command.SetSimulatePhysics`
|
||||
|
||||
- `actor_id`
|
||||
- `enabled`
|
||||
|
||||
## `carla.command.SetAutopilot`
|
||||
|
||||
- `actor_id`
|
||||
- `enabled`
|
||||
|
|
@ -0,0 +1,543 @@
|
|||
# Python API reference (0.9.5)
|
||||
|
||||
This reference contains all the details about the Python API as it was for __CARLA 0.9.5__.
|
||||
|
||||
<div class="build-buttons">
|
||||
<p>
|
||||
<a href="../../python_api" target="_blank" class="btn btn-neutral" title="Go back to the latest version of the Python API">
|
||||
Back to latest</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## `carla.Client`
|
||||
|
||||
- `Client(host, port, worker_threads=0)`
|
||||
- `set_timeout(float_seconds)`
|
||||
- `get_client_version()`
|
||||
- `get_server_version()`
|
||||
- `get_world()`
|
||||
- `get_available_maps()`
|
||||
- `reload_world()`
|
||||
- `load_world(map_name)`
|
||||
- `start_recorder(string filename)`
|
||||
- `replay_file(string filename, float start, float duration, int camera_follow_id)`
|
||||
- `show_recorder_file_info(string filename)`
|
||||
- `show_recorder_collisions(string filename, char category1, char category2)`
|
||||
- `show_recorder_actors_blocked(string filename, float min_time, float min_distance)`
|
||||
- `apply_batch(commands, do_tick=False)`
|
||||
- `apply_batch_sync(commands, do_tick=False) -> list(carla.command.Response)`
|
||||
|
||||
## `carla.World`
|
||||
|
||||
- `id`
|
||||
- `debug`
|
||||
- `get_blueprint_library()`
|
||||
- `get_map()`
|
||||
- `get_spectator()`
|
||||
- `get_settings()`
|
||||
- `apply_settings(world_settings)`
|
||||
- `get_weather()`
|
||||
- `set_weather(weather_parameters)`
|
||||
- `get_actors(actor_ids=None) -> carla.ActorList`
|
||||
- `spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `try_spawn_actor(blueprint, transform, attach_to=None)`
|
||||
- `wait_for_tick(seconds=1.0)`
|
||||
- `on_tick(callback)`
|
||||
- `tick()`
|
||||
|
||||
## `carla.WorldSettings`
|
||||
|
||||
- `synchronous_mode`
|
||||
- `no_rendering_mode`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.DebugHelper`
|
||||
|
||||
- `draw_point(location, size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_line(begin, end, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_arrow(begin, end, thickness=0.1, arrow_size=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_box(box, rotation, thickness=0.1, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
- `draw_string(location, text, draw_shadow=False, color=carla.Color(), life_time=-1.0, persistent_lines=True)`
|
||||
|
||||
## `carla.BlueprintLibrary`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorBlueprint`
|
||||
|
||||
- `id`
|
||||
- `tags`
|
||||
- `has_tag(tag)`
|
||||
- `match_tags(wildcard_pattern)`
|
||||
- `has_attribute(key)`
|
||||
- `get_attribute(key)`
|
||||
- `set_attribute(key, value)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.ActorAttribute`
|
||||
|
||||
- `id`
|
||||
- `type`
|
||||
- `recommended_values`
|
||||
- `is_modifiable`
|
||||
- `as_bool()`
|
||||
- `as_int()`
|
||||
- `as_float()`
|
||||
- `as_str()`
|
||||
- `as_color()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
- `__nonzero__()`
|
||||
- `__bool__()`
|
||||
- `__int__()`
|
||||
- `__float__()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.ActorList`
|
||||
|
||||
- `find(id)`
|
||||
- `filter(wildcard_pattern)`
|
||||
- `__getitem__(pos)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
|
||||
## `carla.Actor`
|
||||
|
||||
- `id`
|
||||
- `type_id`
|
||||
- `parent`
|
||||
- `semantic_tags`
|
||||
- `is_alive`
|
||||
- `attributes`
|
||||
- `get_world()`
|
||||
- `get_location()`
|
||||
- `get_transform()`
|
||||
- `get_velocity()`
|
||||
- `get_angular_velocity()`
|
||||
- `get_acceleration()`
|
||||
- `set_location(location)`
|
||||
- `set_transform(transform)`
|
||||
- `set_velocity(vector)`
|
||||
- `set_angular_velocity(vector)`
|
||||
- `add_impulse(vector)`
|
||||
- `set_simulate_physics(enabled=True)`
|
||||
- `destroy()`
|
||||
- `__str__()`
|
||||
|
||||
## `carla.Vehicle(carla.Actor)`
|
||||
|
||||
- `bounding_box`
|
||||
- `apply_control(vehicle_control)`
|
||||
- `get_control()`
|
||||
- `get_physics_control()`
|
||||
- `apply_physics_control(vehicle_physics_control)`
|
||||
- `set_autopilot(enabled=True)`
|
||||
- `get_speed_limit()`
|
||||
- `get_traffic_light_state()`
|
||||
- `is_at_traffic_light()`
|
||||
- `get_traffic_light()`
|
||||
|
||||
## `carla.TrafficLight(carla.Actor)`
|
||||
|
||||
- `state`
|
||||
- `set_state(traffic_light_state)`
|
||||
- `get_state()`
|
||||
- `set_green_time(green_time)`
|
||||
- `get_green_time()`
|
||||
- `set_yellow_time(yellow_time)`
|
||||
- `get_yellow_time()`
|
||||
- `set_red_time(red_time)`
|
||||
- `get_red_time()`
|
||||
- `get_elapsed_time()`
|
||||
- `freeze(True)`
|
||||
- `is_frozen()`
|
||||
- `get_pole_index()`
|
||||
- `get_group_traffic_lights()`
|
||||
|
||||
## `carla.Sensor(carla.Actor)`
|
||||
|
||||
- `is_listening`
|
||||
- `listen(callback_function)`
|
||||
- `stop()`
|
||||
|
||||
## `carla.SensorData`
|
||||
|
||||
- `frame_number`
|
||||
- `timestamp`
|
||||
- `transform`
|
||||
|
||||
## `carla.Image(carla.SensorData)`
|
||||
|
||||
- `width`
|
||||
- `height`
|
||||
- `fov`
|
||||
- `raw_data`
|
||||
- `convert(color_converter)`
|
||||
- `save_to_disk(path, color_converter=None)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, color)`
|
||||
|
||||
## `carla.LidarMeasurement(carla.SensorData)`
|
||||
|
||||
- `horizontal_angle`
|
||||
- `channels`
|
||||
- `raw_data`
|
||||
- `get_point_count(channel)`
|
||||
- `save_to_disk(path)`
|
||||
- `__len__()`
|
||||
- `__iter__()`
|
||||
- `__getitem__(pos)`
|
||||
- `__setitem__(pos, location)`
|
||||
|
||||
## `carla.CollisionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `normal_impulse`
|
||||
|
||||
## `carla.LaneInvasionEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `crossed_lane_markings`
|
||||
|
||||
## `carla.GnssEvent(carla.SensorData)`
|
||||
|
||||
- `latitude`
|
||||
- `longitude`
|
||||
- `altitude`
|
||||
|
||||
## `carla.ObstacleDetectionSensorEvent(carla.SensorData)`
|
||||
|
||||
- `actor`
|
||||
- `other_actor`
|
||||
- `distance`
|
||||
|
||||
## `carla.VehicleControl`
|
||||
|
||||
- `throttle`
|
||||
- `steer`
|
||||
- `brake`
|
||||
- `hand_brake`
|
||||
- `reverse`
|
||||
- `gear`
|
||||
- `manual_gear_shift`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
|
||||
## `carla.WheelsPhysicsControl`
|
||||
|
||||
- `tire_friction`
|
||||
- `damping_rate`
|
||||
- `steer_angle`
|
||||
- `disable_steering`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.VehiclePhysicsControl`
|
||||
|
||||
- `torque_curve`
|
||||
- `max_rpm`
|
||||
- `moi`
|
||||
- `damping_rate_full_throttle`
|
||||
- `damping_rate_zero_throttle_clutch_engaged`
|
||||
- `damping_rate_zero_throttle_clutch_disengaged`
|
||||
- `use_gear_autobox`
|
||||
- `gear_switch_time`
|
||||
- `clutch_strength`
|
||||
- `mass`
|
||||
- `drag_coefficient`
|
||||
- `center_of_mass`
|
||||
- `steering_curve`
|
||||
- `wheels`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Map`
|
||||
|
||||
- `name`
|
||||
- `get_spawn_points()`
|
||||
- `get_waypoint(location, project_to_road=True, lane_type=carla.LaneType.Driving)`
|
||||
- `get_topology()`
|
||||
- `generate_waypoints(distance)`
|
||||
- `transform_to_geolocation(location)`
|
||||
- `to_opendrive()`
|
||||
- `save_to_disk(path=self.name)`
|
||||
|
||||
## `carla.LaneType`
|
||||
|
||||
- `NONE`
|
||||
- `Driving`
|
||||
- `Stop`
|
||||
- `Shoulder`
|
||||
- `Biking`
|
||||
- `Sidewalk`
|
||||
- `Border`
|
||||
- `Restricted`
|
||||
- `Parking`
|
||||
- `Bidirectional`
|
||||
- `Median`
|
||||
- `Special1`
|
||||
- `Special2`
|
||||
- `Special3`
|
||||
- `RoadWorks`
|
||||
- `Tram`
|
||||
- `Rail`
|
||||
- `Entry`
|
||||
- `Exit`
|
||||
- `OffRamp`
|
||||
- `OnRamp`
|
||||
- `Any`
|
||||
|
||||
## `carla.LaneChange`
|
||||
|
||||
- `NONE`
|
||||
- `Right`
|
||||
- `Left`
|
||||
- `Both`
|
||||
|
||||
## `carla.LaneMarkingColor`
|
||||
|
||||
- `Standard = White`
|
||||
- `Blue`
|
||||
- `Green`
|
||||
- `Red`
|
||||
- `White`
|
||||
- `Yellow`
|
||||
- `Other`
|
||||
|
||||
## `carla.LaneMarkingType`
|
||||
|
||||
- `NONE`
|
||||
- `Other`
|
||||
- `Broken`
|
||||
- `Solid`
|
||||
- `SolidSolid`
|
||||
- `SolidBroken`
|
||||
- `BrokenSolid`
|
||||
- `BrokenBroken`
|
||||
- `BottsDots`
|
||||
- `Grass`
|
||||
- `Curb`
|
||||
|
||||
## `carla.LaneMarking`
|
||||
|
||||
- `type -> carla.LaneMarking`
|
||||
- `color -> carla.RoadMarkColor`
|
||||
- `lane_change -> carla.LaneChange`
|
||||
- `width`
|
||||
|
||||
## `carla.Waypoint`
|
||||
|
||||
- `id`
|
||||
- `transform`
|
||||
- `is_intersection`
|
||||
- `lane_width`
|
||||
- `road_id`
|
||||
- `section_id`
|
||||
- `lane_id`
|
||||
- `s`
|
||||
- `lane_change -> carla.LaneChange`
|
||||
- `lane_type -> carla.LaneType`
|
||||
- `right_lane_marking -> carla.LaneMarking`
|
||||
- `left_lane_marking -> carla.LaneMarking`
|
||||
- `next(distance) -> list(carla.Waypoint)`
|
||||
- `get_right_lane() -> carla.Waypoint`
|
||||
- `get_left_lane() -> carla.Waypoint`
|
||||
|
||||
## `carla.WeatherParameters`
|
||||
|
||||
- `cloudyness`
|
||||
- `precipitation`
|
||||
- `precipitation_deposits`
|
||||
- `wind_intensity`
|
||||
- `sun_azimuth_angle`
|
||||
- `sun_altitude_angle`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
Static presets
|
||||
|
||||
- `carla.WeatherParameters.ClearNoon`
|
||||
- `carla.WeatherParameters.CloudyNoon`
|
||||
- `carla.WeatherParameters.WetNoon`
|
||||
- `carla.WeatherParameters.WetCloudyNoon`
|
||||
- `carla.WeatherParameters.MidRainyNoon`
|
||||
- `carla.WeatherParameters.HardRainNoon`
|
||||
- `carla.WeatherParameters.SoftRainNoon`
|
||||
- `carla.WeatherParameters.ClearSunset`
|
||||
- `carla.WeatherParameters.CloudySunset`
|
||||
- `carla.WeatherParameters.WetSunset`
|
||||
- `carla.WeatherParameters.WetCloudySunset`
|
||||
- `carla.WeatherParameters.MidRainSunset`
|
||||
- `carla.WeatherParameters.HardRainSunset`
|
||||
- `carla.WeatherParameters.SoftRainSunset`
|
||||
|
||||
## `carla.Vector3D`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Location`
|
||||
|
||||
- `x`
|
||||
- `y`
|
||||
- `z`
|
||||
- `distance(other)`
|
||||
- `__add__(other)`
|
||||
- `__sub__(other)`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Rotation`
|
||||
|
||||
- `pitch`
|
||||
- `yaw`
|
||||
- `roll`
|
||||
- `get_forward_vector()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Transform`
|
||||
|
||||
- `location`
|
||||
- `rotation`
|
||||
- `transform(geom_object)`
|
||||
- `get_forward_vector()`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.BoundingBox`
|
||||
|
||||
- `location`
|
||||
- `extent`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Timestamp`
|
||||
|
||||
- `frame_count`
|
||||
- `elapsed_seconds`
|
||||
- `delta_seconds`
|
||||
- `platform_timestamp`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.Color`
|
||||
|
||||
- `r`
|
||||
- `g`
|
||||
- `b`
|
||||
- `a`
|
||||
- `__eq__(other)`
|
||||
- `__ne__(other)`
|
||||
|
||||
## `carla.ColorConverter`
|
||||
|
||||
- `Raw`
|
||||
- `Depth`
|
||||
- `LogarithmicDepth`
|
||||
- `CityScapesPalette`
|
||||
|
||||
## `carla.ActorAttributeType`
|
||||
|
||||
- `Bool`
|
||||
- `Int`
|
||||
- `Float`
|
||||
- `RGBColor`
|
||||
|
||||
## `carla.TrafficLightState`
|
||||
|
||||
- `Red`
|
||||
- `Yellow`
|
||||
- `Green`
|
||||
- `Off`
|
||||
- `Unknown`
|
||||
|
||||
## `carla.LaneMarking`
|
||||
|
||||
- `Other`
|
||||
- `Broken`
|
||||
- `Solid`
|
||||
|
||||
# module `carla.command`
|
||||
|
||||
`carla.command.FutureActor` (not yet spawned actor handler)
|
||||
|
||||
## `carla.command.Response`
|
||||
|
||||
- `actor_id`
|
||||
- `error` -> str|empty
|
||||
- `has_error()`
|
||||
|
||||
## `carla.command.SpawnActor`
|
||||
|
||||
- `__init__(blueprint, transform, parent=None)`
|
||||
- `then(command)`
|
||||
|
||||
## `carla.command.DestroyActor`
|
||||
|
||||
- `__init__(actor)`
|
||||
- `actor_id`
|
||||
|
||||
## `carla.command.ApplyVehicleControl`
|
||||
|
||||
- `__init__(actor, control)`
|
||||
- `actor_id`
|
||||
- `control`
|
||||
|
||||
## `carla.command.ApplyWalkerControl`
|
||||
|
||||
- `__init__(actor, control)`
|
||||
- `actor_id`
|
||||
- `control`
|
||||
|
||||
## `carla.command.ApplyTransform`
|
||||
|
||||
- `__init__(actor, transform)`
|
||||
- `actor_id`
|
||||
- `transform`
|
||||
|
||||
## `carla.command.ApplyVelocity`
|
||||
|
||||
- `__init__(actor, velocity)`
|
||||
- `actor_id`
|
||||
- `velocity`
|
||||
|
||||
## `carla.command.ApplyAngularVelocity`
|
||||
|
||||
- `__init__(actor, angular_velocity)`
|
||||
- `actor_id`
|
||||
- `angular_velocity`
|
||||
|
||||
|
||||
## `carla.command.ApplyImpulse`
|
||||
|
||||
- `__init__(actor, impulse)`
|
||||
- `actor_id`
|
||||
- `impulse`
|
||||
|
||||
## `carla.command.SetSimulatePhysics`
|
||||
|
||||
- `__init__(actor, bool)`
|
||||
- `actor_id`
|
||||
- `enabled`
|
||||
|
||||
## `carla.command.SetAutopilot`
|
||||
|
||||
- `__init__(actor, bool)`
|
||||
- `actor_id`
|
||||
- `enabled`
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -1,4 +1,6 @@
|
|||
#Python API reference
|
||||
This reference contains all the details about latest version of the Python API. To consult a valid reference for a specific CARLA release, please select it from the list hereunder.<br><details><summary><b>Previous references</b></summary><br><ul><li><a href=../APIs/python_api_098><b>CARLA 0.9.8</b></a></li><li><a href=../APIs/python_api_097><b>CARLA 0.9.7</b></a></li><li><a href=../APIs/python_api_096><b>CARLA 0.9.6</b></a></li><li><a href=../APIs/python_api_095><b>CARLA 0.9.5</b></a></li><li><a href=../APIs/python_api_094><b>CARLA 0.9.4</b></a></li><li><a href=../APIs/python_api_093><b>CARLA 0.9.3</b></a></li><li><a href=../APIs/python_api_092><b>CARLA 0.9.2</b></a></li><li><a href=../APIs/python_api_091><b>CARLA 0.9.1</b></a></li><li><a href=../APIs/python_api_090><b>CARLA 0.9.0</b></a></li></ul></details><br><hr>
|
||||
|
||||
## carla.Actor<a name="carla.Actor"></a>
|
||||
CARLA defines actors as anything that plays a role in the simulation or can be moved around. That includes: pedestrians, vehicles, sensors and traffic signs (considering traffic lights as part of these). Actors are spawned in the simulation by [carla.World](#carla.World) and they need for a [carla.ActorBlueprint](#carla.ActorBlueprint) to be created. These blueprints belong into a library provided by CARLA, find more about them [here](bp_library.md).
|
||||
|
||||
|
|
@ -28,32 +30,42 @@ Tells the simulator to destroy this actor and returns <b>True</b> if it was succ
|
|||
- **Return:** _bool_
|
||||
- **Warning:** <font color="#ED2F2F">_This method blocks the script until the destruction is completed by the simulator.
|
||||
_</font>
|
||||
- <a name="carla.Actor.get_acceleration"></a>**<font color="#7fb800">get_acceleration</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Actor.get_acceleration"></a>**<font color="#7fb800">get_acceleration</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the actor's 3D acceleration vector the client recieved during last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
|
||||
- <a name="carla.Actor.get_angular_velocity"></a>**<font color="#7fb800">get_angular_velocity</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the actor's angular velocity vector the client recieved during last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
|
||||
- **Setter:** _[carla.Actor.set_angular_velocity](#carla.Actor.set_angular_velocity)_
|
||||
- <a name="carla.Actor.get_location"></a>**<font color="#7fb800">get_location</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the actor's location the client recieved during last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.Location](#carla.Location)_
|
||||
- **Setter:** _[carla.Actor.set_location](#carla.Actor.set_location)_
|
||||
- <a name="carla.Actor.get_transform"></a>**<font color="#7fb800">get_transform</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the actor's transform (location and rotation) the client recieved during last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.Transform](#carla.Transform)_
|
||||
- **Setter:** _[carla.Actor.set_transform](#carla.Actor.set_transform)_
|
||||
- <a name="carla.Actor.get_velocity"></a>**<font color="#7fb800">get_velocity</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the actor's velocity vector the client recieved during last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
|
||||
- **Setter:** _[carla.Actor.set_velocity](#carla.Actor.set_velocity)_
|
||||
- <a name="carla.Actor.get_world"></a>**<font color="#7fb800">get_world</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the world this actor belongs to.
|
||||
- **Return:** _[carla.World](#carla.World)_
|
||||
- <a name="carla.Actor.set_angular_velocity"></a>**<font color="#7fb800">set_angular_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**angular_velocity**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Actor.set_angular_velocity"></a>**<font color="#7fb800">set_angular_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**angular_velocity**</font>)
|
||||
Changes the actor's angular velocity vector.
|
||||
- **Parameters:**
|
||||
- `angular_velocity` (_[carla.Vector3D](#carla.Vector3D)_)
|
||||
- **Getter:** _[carla.Actor.get_angular_velocity](#carla.Actor.get_angular_velocity)_
|
||||
- <a name="carla.Actor.set_location"></a>**<font color="#7fb800">set_location</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**location**</font>)
|
||||
Teleports the actor to a given location.
|
||||
- **Parameters:**
|
||||
- `location` (_[carla.Location](#carla.Location)_)
|
||||
- **Getter:** _[carla.Actor.get_location](#carla.Actor.get_location)_
|
||||
- <a name="carla.Actor.set_simulate_physics"></a>**<font color="#7fb800">set_simulate_physics</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**enabled**=True</font>)
|
||||
Enables or disables the simulation of physics on this actor.
|
||||
- **Parameters:**
|
||||
|
|
@ -62,13 +74,15 @@ Enables or disables the simulation of physics on this actor.
|
|||
Teleports the actor to a given transform (location and rotation).
|
||||
- **Parameters:**
|
||||
- `transform` (_[carla.Transform](#carla.Transform)_)
|
||||
- **Getter:** _[carla.Actor.get_transform](#carla.Actor.get_transform)_
|
||||
- <a name="carla.Actor.set_velocity"></a>**<font color="#7fb800">set_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**velocity**</font>)
|
||||
Sets the actor's velocity vector.
|
||||
- **Parameters:**
|
||||
- `velocity` (_[carla.Vector3D](#carla.Vector3D)_)
|
||||
- **Getter:** _[carla.Actor.get_velocity](#carla.Actor.get_velocity)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Actor.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Actor.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -97,8 +111,8 @@ Reads the attribute as int.
|
|||
- <a name="carla.ActorAttribute.as_str"></a>**<font color="#7fb800">as_str</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Reads the attribute as string.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.ActorAttribute.__bool__"></a>**<font color="#7fb800">\__bool__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorAttribute.__bool__"></a>**<font color="#7fb800">\__bool__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.ActorAttribute.__float__"></a>**<font color="#7fb800">\__float__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.ActorAttribute.__int__"></a>**<font color="#7fb800">\__int__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.ActorAttribute.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
|
@ -151,19 +165,25 @@ Returns <b>True</b> if any of the tags listed for this blueprint matches `wildca
|
|||
- **Parameters:**
|
||||
- `wildcard_pattern` (_str_)
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.ActorBlueprint.get_attribute"></a>**<font color="#7fb800">get_attribute</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**id**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorBlueprint.get_attribute"></a>**<font color="#7fb800">get_attribute</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**id**</font>)
|
||||
Returns the actor's attribute with `id` as identifier if existing.
|
||||
- **Parameters:**
|
||||
- `id` (_str_)
|
||||
- **Return:** _[carla.ActorAttribute](#carla.ActorAttribute)_
|
||||
- <a name="carla.ActorBlueprint.set_attribute"></a>**<font color="#7fb800">set_attribute</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**id**</font>, <font color="#00a6ed">**value**</font>)
|
||||
- **Setter:** _[carla.ActorBlueprint.set_attribute](#carla.ActorBlueprint.set_attribute)_
|
||||
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorBlueprint.set_attribute"></a>**<font color="#7fb800">set_attribute</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**id**</font>, <font color="#00a6ed">**value**</font>)
|
||||
If the `id` attribute is modifiable, changes its value to `value`.
|
||||
- **Parameters:**
|
||||
- `id` (_str_) – The identifier for the attribute that is intended to be changed.
|
||||
- `value` (_str_) – The new value for said attribute.
|
||||
- **Getter:** _[carla.ActorBlueprint.get_attribute](#carla.ActorBlueprint.get_attribute)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.ActorBlueprint.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorBlueprint.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Allows iteration within this class' attributes.
|
||||
- <a name="carla.ActorBlueprint.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the amount of attributes for this blueprint.
|
||||
|
|
@ -186,8 +206,8 @@ Finds an actor using its identifier and returns it or <b>None</b> if it is not p
|
|||
- `actor_id` (_int_)
|
||||
- **Return:** _[carla.Actor](#carla.Actor)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.ActorList.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorList.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
Returns the actor corresponding to `pos` position in the list.
|
||||
- **Return:** _[carla.Actor](#carla.Actor)_
|
||||
- <a name="carla.ActorList.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
|
@ -209,7 +229,9 @@ A class that comprises all the information for an actor at a certain moment in t
|
|||
An identifier for the snapshot itself.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.ActorSnapshot.get_acceleration"></a>**<font color="#7fb800">get_acceleration</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ActorSnapshot.get_acceleration"></a>**<font color="#7fb800">get_acceleration</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the acceleration vector registered for an actor in that tick.
|
||||
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
|
||||
- <a name="carla.ActorSnapshot.get_angular_velocity"></a>**<font color="#7fb800">get_angular_velocity</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
|
@ -252,8 +274,8 @@ Returns the blueprint corresponding to that identifier.
|
|||
- `id` (_str_)
|
||||
- **Return:** _[carla.ActorBlueprint](#carla.ActorBlueprint)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.BlueprintLibrary.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.BlueprintLibrary.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
Returns the blueprint stored in `pos` position inside the data structure containing them.
|
||||
- **Return:** _[carla.ActorBlueprint](#carla.ActorBlueprint)_
|
||||
- <a name="carla.BlueprintLibrary.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
|
@ -288,7 +310,9 @@ Returns **True** if a point passed in world space is inside this bounding box.
|
|||
- `world_point` (_[carla.Location](#carla.Location)_) – The point in world space to be checked.
|
||||
- `transform` (_[carla.Transform](#carla.Transform)_) – Contains location and rotation needed to convert this object's local space to world space.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.BoundingBox.get_local_vertices"></a>**<font color="#7fb800">get_local_vertices</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.BoundingBox.get_local_vertices"></a>**<font color="#7fb800">get_local_vertices</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns a list containing the locations of this object's vertices in local space.
|
||||
- **Return:** _list([carla.Location](#carla.Location))_
|
||||
- <a name="carla.BoundingBox.get_world_vertices"></a>**<font color="#7fb800">get_world_vertices</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**transform**</font>)
|
||||
|
|
@ -297,8 +321,8 @@ Returns a list containing the locations of this object's vertices in world space
|
|||
- `transform` (_[carla.Transform](#carla.Transform)_) – Contains location and rotation needed to convert this object's local space to world space.
|
||||
- **Return:** _list([carla.Location](#carla.Location))_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.BoundingBox.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.BoundingBox](#carla.BoundingBox)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.BoundingBox.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.BoundingBox](#carla.BoundingBox)</font>)
|
||||
Returns true if both location and extent are equal for this and `other`.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.BoundingBox.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.BoundingBox](#carla.BoundingBox)</font>)
|
||||
|
|
@ -384,7 +408,9 @@ Enables the recording feature, which will start saving every information possibl
|
|||
- `filename` (_str_) – Name of the file to write the recorded data. A simple name will save the recording in 'CarlaUE4/Saved/recording.log'. Otherwise, if some folder appears in the name, it will be considered an absolute path.
|
||||
- <a name="carla.Client.stop_recorder"></a>**<font color="#7fb800">stop_recorder</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Stops the recording in progress. If you specified a path in `filename`, the recording will be there. If not, look inside `CarlaUE4/Saved/`.
|
||||
- <a name="carla.Client.get_available_maps"></a>**<font color="#7fb800">get_available_maps</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Client.get_available_maps"></a>**<font color="#7fb800">get_available_maps</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns a list of strings containing the paths of the maps available on server. These paths are dynamic, they will be created during the simulation and so you will not find them when looking up in your files. One of the possible returns for this method would be:
|
||||
['/Game/Carla/Maps/Town01',
|
||||
'/Game/Carla/Maps/Town02',
|
||||
|
|
@ -408,7 +434,9 @@ Returns an instance of the traffic manager related to the specified port. If it
|
|||
- <a name="carla.Client.get_world"></a>**<font color="#7fb800">get_world</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the world object currently active in the simulation. This world will be later used for example to load maps.
|
||||
- **Return:** _[carla.World](#carla.World)_
|
||||
- <a name="carla.Client.set_replayer_time_factor"></a>**<font color="#7fb800">set_replayer_time_factor</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**time_factor**=1.0</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Client.set_replayer_time_factor"></a>**<font color="#7fb800">set_replayer_time_factor</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**time_factor**=1.0</font>)
|
||||
When used, the time speed of the reenacted simulation is modified at will. It can be used several times while a playback is in curse.
|
||||
- **Parameters:**
|
||||
- `time_factor` (_float_) – 1.0 means normal time speed. Greater than 1.0 means fast motion (2.0 would be double speed) and lesser means slow motion (0.5 would be half speed).
|
||||
|
|
@ -454,8 +482,8 @@ Initializes a color, black by default.
|
|||
- `b` (_int_)
|
||||
- `a` (_int_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Color.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Color](#carla.Color)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Color.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Color](#carla.Color)</font>)
|
||||
- <a name="carla.Color.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Color](#carla.Color)</font>)
|
||||
- <a name="carla.Color.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -541,8 +569,8 @@ Quotient between current RPM and MaxRPM where the autonomous gear box should shi
|
|||
- `down_ratio` (_float_)
|
||||
- `up_ratio` (_float_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.GearPhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.GearPhysicsControl](#carla.GearPhysicsControl)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.GearPhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.GearPhysicsControl](#carla.GearPhysicsControl)</font>)
|
||||
- <a name="carla.GearPhysicsControl.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.GearPhysicsControl](#carla.GearPhysicsControl)</font>)
|
||||
- <a name="carla.GearPhysicsControl.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -566,8 +594,8 @@ Height regarding ground level.
|
|||
- `longitude` (_float_)
|
||||
- `altitude` (_float_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.GeoLocation.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.GeoLocation](#carla.GeoLocation)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.GeoLocation.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.GeoLocation](#carla.GeoLocation)</font>)
|
||||
- <a name="carla.GeoLocation.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.GeoLocation](#carla.GeoLocation)</font>)
|
||||
- <a name="carla.GeoLocation.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -586,8 +614,8 @@ West/East value of a point on the map.
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.GnssMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.GnssMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -604,8 +632,8 @@ Angular velocity in rad/sec.
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.IMUMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.IMUMeasurement.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -632,8 +660,8 @@ Saves the image to disk using a converter pattern stated as `color_converter`. T
|
|||
- `path` (_str_) – Path that will contain the image.
|
||||
- `color_converter` (_[carla.ColorConverter](#carla.ColorConverter)_) – Default <b>Raw</b> will make no changes.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Image.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Image.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
- <a name="carla.Image.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.Image.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.Image.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**color**=[carla.Color](#carla.Color)</font>)
|
||||
|
|
@ -651,7 +679,9 @@ Identificator found in the OpenDRIVE file.
|
|||
Bounding box encapsulating the junction lanes.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.Junction.get_waypoints"></a>**<font color="#7fb800">get_waypoints</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**lane_type**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Junction.get_waypoints"></a>**<font color="#7fb800">get_waypoints</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**lane_type**</font>)
|
||||
Returns a list of pairs of waypoints. Every tuple on the list contains first an initial and then a final waypoint within the intersection boundaries that describe the beginning and the end of said lane along the junction. Lanes follow their OpenDRIVE definitions so there may be many different tuples with the same starting waypoint due to possible deviations, as this are considered different lanes.
|
||||
- **Parameters:**
|
||||
- `lane_type` (_[carla.LaneType](#carla.LaneType)_) – Type of lanes to get the waypoints.
|
||||
|
|
@ -711,7 +741,9 @@ A waypoint placed in the lane of the one that made the query and at the `s` of t
|
|||
The location and orientation of the landmark in the simulation.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.Landmark.get_lane_validities"></a>**<font color="#7fb800">get_lane_validities</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Landmark.get_lane_validities"></a>**<font color="#7fb800">get_lane_validities</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns which lanes the landmark is affecting to. As there may be specific lanes where the landmark is not effective, the return is a list of pairs containing ranges of the __lane_id__ affected:
|
||||
<small>Example: In a road with 5 lanes, being 3 not affected: [(from_lane1,to_lane2),(from_lane4,to_lane5)]</small>.
|
||||
- **Return:** _list(tuple(int))_
|
||||
|
|
@ -833,8 +865,8 @@ List of lane markings that have been crossed and detected by the sensor.
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.LaneInvasionEvent.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.LaneInvasionEvent.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -933,13 +965,15 @@ List of 3D points received as data.
|
|||
Saves the point cloud to disk as a <b>.ply</b> file describing data from 3D scanners. The files generated are ready to be used within [MeshLab](http://www.meshlab.net/), an open source system for processing said files. Just take into account that axis may differ from Unreal Engine and so, need to be reallocated.
|
||||
- **Parameters:**
|
||||
- `path` (_str_)
|
||||
- <a name="carla.LidarMeasurement.get_point_count"></a>**<font color="#7fb800">get_point_count</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**channel**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.LidarMeasurement.get_point_count"></a>**<font color="#7fb800">get_point_count</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**channel**</font>)
|
||||
Retrieves the number of points sorted by channel that are generated by this measure. Sorting by channel allows to identify the original channel for every point.
|
||||
- **Parameters:**
|
||||
- `channel` (_int_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.LidarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.LidarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
- <a name="carla.LidarMeasurement.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.LidarMeasurement.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.LidarMeasurement.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**location**=[carla.Location](#carla.Location)</font>)
|
||||
|
|
@ -1154,8 +1188,8 @@ Returns Euclidean distance in meters from this location to another one.
|
|||
- `location` (_[carla.Location](#carla.Location)_) – The other point to compute the distance with.
|
||||
- **Return:** _float_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Location.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Location](#carla.Location)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Location.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Location](#carla.Location)</font>)
|
||||
Returns __True__ if both locations are the same point in space.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.Location.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Location](#carla.Location)</font>)
|
||||
|
|
@ -1198,7 +1232,9 @@ Converts a given `location`, a point in the simulation, to a [carla.GeoLocation]
|
|||
- **Parameters:**
|
||||
- `location` (_[carla.Location](#carla.Location)_)
|
||||
- **Return:** _[carla.GeoLocation](#carla.GeoLocation)_
|
||||
- <a name="carla.Map.get_all_landmarks"></a>**<font color="#7fb800">get_all_landmarks</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Map.get_all_landmarks"></a>**<font color="#7fb800">get_all_landmarks</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns all the landmarks in the map. Landmarks retrieved using this method have a __null__ waypoint.
|
||||
- **Return:** _list([carla.Landmark](#carla.Landmark))_
|
||||
- <a name="carla.Map.get_all_landmarks_from_id"></a>**<font color="#7fb800">get_all_landmarks_from_id</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**opendrive_id**</font>)
|
||||
|
|
@ -1238,8 +1274,8 @@ Returns a waypoint if all the parameters passed are correct. Otherwise, returns
|
|||
- `s` (_float_) – Specify the length from the road start.
|
||||
- **Return:** _[carla.Waypoint](#carla.Waypoint)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Map.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Map.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1256,8 +1292,8 @@ Distance between `actor` and `other`.
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.ObstacleDetectionEvent.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.ObstacleDetectionEvent.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1295,8 +1331,8 @@ The velocity of the detected object towards the sensor in m/s.
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.RadarDetection.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RadarDetection.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1308,11 +1344,13 @@ The velocity of the detected object towards the sensor in m/s.
|
|||
The complete information of the [carla.RadarDetection](#carla.RadarDetection) the radar has registered.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.RadarMeasurement.get_detection_count"></a>**<font color="#7fb800">get_detection_count</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RadarMeasurement.get_detection_count"></a>**<font color="#7fb800">get_detection_count</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Retrieves the number of entries generated, same as **<font color="#7fb800">\__str__()</font>**.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.RadarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RadarMeasurement.__getitem__"></a>**<font color="#7fb800">\__getitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>)
|
||||
- <a name="carla.RadarMeasurement.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.RadarMeasurement.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
- <a name="carla.RadarMeasurement.__setitem__"></a>**<font color="#7fb800">\__setitem__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**pos**=int</font>, <font color="#00a6ed">**detection**=[carla.RadarDetection](#carla.RadarDetection)</font>)
|
||||
|
|
@ -1339,12 +1377,14 @@ Degrees around the X-axis.
|
|||
- `pitch` (_float_) – Y rotation in degrees.
|
||||
- `yaw` (_float_) – Z rotation in degrees.
|
||||
- `roll` (_float_) – X rotation in degrees.
|
||||
- <a name="carla.Rotation.get_forward_vector"></a>**<font color="#7fb800">get_forward_vector</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Rotation.get_forward_vector"></a>**<font color="#7fb800">get_forward_vector</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Computes the vector pointing forward according to the orientation of each axis.
|
||||
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Rotation.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Rotation](#carla.Rotation)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Rotation.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Rotation](#carla.Rotation)</font>)
|
||||
Returns __True__ if both rotations represent the same orientation of each axis.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.Rotation.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Rotation](#carla.Rotation)</font>)
|
||||
|
|
@ -1392,8 +1432,8 @@ The ego acceleration component _lon_ regarding the route smoothened by an averag
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.RssEgoDynamicsOnRoute.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RssEgoDynamicsOnRoute.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1416,8 +1456,8 @@ Current ego vehicle dynamics regarding the route.
|
|||
|
||||
<h3>Methods</h3>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.RssResponse.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RssResponse.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1474,8 +1514,8 @@ Erases the targets that have been appended to the route.
|
|||
- <a name="carla.RssSensor.drop_route"></a>**<font color="#7fb800">drop_route</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Discards the current route. If there are targets remaining in **<font color="#f8805a">routing_targets</font>**, creates a new route using those. Otherwise, a new route is created at random.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.RssSensor.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.RssSensor.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1521,8 +1561,8 @@ The function the sensor will be calling to every time a new measurement is recei
|
|||
- <a name="carla.Sensor.stop"></a>**<font color="#7fb800">stop</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Commands the sensor to stop listening for data.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Sensor.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Sensor.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1569,8 +1609,8 @@ Time register of the frame at which this measurement was taken given by the OS i
|
|||
- `delta_seconds` (_float_)
|
||||
- `platform_timestamp` (_float_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Timestamp.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Timestamp](#carla.Timestamp)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Timestamp.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Timestamp](#carla.Timestamp)</font>)
|
||||
- <a name="carla.Timestamp.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Timestamp](#carla.Timestamp)</font>)
|
||||
- <a name="carla.Timestamp.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -1593,7 +1633,9 @@ Stops the traffic light at its current state.
|
|||
- <a name="carla.TrafficLight.is_frozen"></a>**<font color="#7fb800">is_frozen</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns <b>True</b> if a traffic light is frozen according to last tick. The method does not call the simulator.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.TrafficLight.get_elapsed_time"></a>**<font color="#7fb800">get_elapsed_time</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.TrafficLight.get_elapsed_time"></a>**<font color="#7fb800">get_elapsed_time</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the time in seconds since current light state started according to last tick. The method does not call the simulator.
|
||||
- **Return:** _float_
|
||||
- <a name="carla.TrafficLight.get_group_traffic_lights"></a>**<font color="#7fb800">get_group_traffic_lights</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
|
@ -1607,33 +1649,43 @@ Returns the index of the pole that identifies it as part of the traffic light gr
|
|||
- <a name="carla.TrafficLight.get_state"></a>**<font color="#7fb800">get_state</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the state of the traffic light according to last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.TrafficLightState](#carla.TrafficLightState)_
|
||||
- **Setter:** _[carla.TrafficLight.set_state](#carla.TrafficLight.set_state)_
|
||||
- <a name="carla.TrafficLight.get_green_time"></a>**<font color="#7fb800">get_green_time</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the seconds set for the traffic light to be green according to last tick. The method does not call the simulator.
|
||||
- **Return:** _float_
|
||||
- **Setter:** _[carla.TrafficLight.set_green_time](#carla.TrafficLight.set_green_time)_
|
||||
- <a name="carla.TrafficLight.get_red_time"></a>**<font color="#7fb800">get_red_time</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the seconds set for the traffic light to be red according to last tick. The method does not call the simulator.
|
||||
- **Return:** _float_
|
||||
- **Setter:** _[carla.TrafficLight.set_red_time](#carla.TrafficLight.set_red_time)_
|
||||
- <a name="carla.TrafficLight.get_yellow_time"></a>**<font color="#7fb800">get_yellow_time</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the the seconds set for the traffic light to be yellow according to last tick. The method does not call the simulator.
|
||||
- **Return:** _float_
|
||||
- <a name="carla.TrafficLight.set_state"></a>**<font color="#7fb800">set_state</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**state**</font>)
|
||||
- **Setter:** _[carla.TrafficLight.set_yellow_time](#carla.TrafficLight.set_yellow_time)_
|
||||
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.TrafficLight.set_state"></a>**<font color="#7fb800">set_state</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**state**</font>)
|
||||
Sets a given state to a traffic light actor.
|
||||
- **Parameters:**
|
||||
- `state` (_[carla.TrafficLightState](#carla.TrafficLightState)_)
|
||||
- **Getter:** _[carla.TrafficLight.get_state](#carla.TrafficLight.get_state)_
|
||||
- <a name="carla.TrafficLight.set_green_time"></a>**<font color="#7fb800">set_green_time</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**green_time**</font>)
|
||||
- **Parameters:**
|
||||
- `green_time` (_float_) – Sets a given time (in seconds) for the green light to be active.
|
||||
- **Getter:** _[carla.TrafficLight.get_green_time](#carla.TrafficLight.get_green_time)_
|
||||
- <a name="carla.TrafficLight.set_red_time"></a>**<font color="#7fb800">set_red_time</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**red_time**</font>)
|
||||
Sets a given time (in seconds) for the red state to be active.
|
||||
- **Parameters:**
|
||||
- `red_time` (_float_)
|
||||
- **Getter:** _[carla.TrafficLight.get_red_time](#carla.TrafficLight.get_red_time)_
|
||||
- <a name="carla.TrafficLight.set_yellow_time"></a>**<font color="#7fb800">set_yellow_time</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**yellow_time**</font>)
|
||||
Sets a given time (in seconds) for the yellow light to be active.
|
||||
- **Parameters:**
|
||||
- `yellow_time` (_float_)
|
||||
- **Getter:** _[carla.TrafficLight.get_yellow_time](#carla.TrafficLight.get_yellow_time)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.TrafficLight.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.TrafficLight.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1748,12 +1800,14 @@ Describes a rotation for an object according to Unreal Engine's axis system.
|
|||
Translates a 3D point from global to local coordinates using the current transformation as frame of reference.
|
||||
- **Parameters:**
|
||||
- `in_point` (_[carla.Location](#carla.Location)_) – Location in the space to which the transformation will be applied.
|
||||
- <a name="carla.Transform.get_forward_vector"></a>**<font color="#7fb800">get_forward_vector</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Transform.get_forward_vector"></a>**<font color="#7fb800">get_forward_vector</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Computes a forward vector using its rotation.
|
||||
- **Return:** _[carla.Vector3D](#carla.Vector3D)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Transform.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Transform](#carla.Transform)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Transform.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Transform](#carla.Transform)</font>)
|
||||
Returns __True__ if both location and rotation are equal for this and `other`.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.Transform.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Transform](#carla.Transform)</font>)
|
||||
|
|
@ -1780,8 +1834,8 @@ Y-axis value.
|
|||
- `x` (_float_)
|
||||
- `y` (_float_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Vector2D.__add__"></a>**<font color="#7fb800">\__add__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector2D](#carla.Vector2D)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Vector2D.__add__"></a>**<font color="#7fb800">\__add__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector2D](#carla.Vector2D)</font>)
|
||||
- <a name="carla.Vector2D.__sub__"></a>**<font color="#7fb800">\__sub__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector2D](#carla.Vector2D)</font>)
|
||||
- <a name="carla.Vector2D.__mul__"></a>**<font color="#7fb800">\__mul__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector2D](#carla.Vector2D)</font>)
|
||||
- <a name="carla.Vector2D.__truediv__"></a>**<font color="#7fb800">\__truediv__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector2D](#carla.Vector2D)</font>)
|
||||
|
|
@ -1815,8 +1869,8 @@ Z-axis value.
|
|||
- `y` (_float_)
|
||||
- `z` (_float_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Vector3D.__add__"></a>**<font color="#7fb800">\__add__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Vector3D.__add__"></a>**<font color="#7fb800">\__add__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
|
||||
- <a name="carla.Vector3D.__sub__"></a>**<font color="#7fb800">\__sub__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
|
||||
- <a name="carla.Vector3D.__mul__"></a>**<font color="#7fb800">\__mul__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
|
||||
- <a name="carla.Vector3D.__truediv__"></a>**<font color="#7fb800">\__truediv__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.Vector3D](#carla.Vector3D)</font>)
|
||||
|
|
@ -1851,12 +1905,15 @@ Applies a physics control object in the next tick containing the parameters that
|
|||
- <a name="carla.Vehicle.is_at_traffic_light"></a>**<font color="#7fb800">is_at_traffic_light</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Vehicles will be affected by a traffic light when the light is red and the vehicle is inside its bounding box. The client returns whether a traffic light is affecting this vehicle according to last tick (it does not call the simulator).
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.Vehicle.get_control"></a>**<font color="#7fb800">get_control</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Vehicle.get_control"></a>**<font color="#7fb800">get_control</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the control applied in the last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.VehicleControl](#carla.VehicleControl)_
|
||||
- <a name="carla.Vehicle.get_light_state"></a>**<font color="#7fb800">get_light_state</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns a flag representing the vehicle light state, this represents which lights are active or not.
|
||||
- **Return:** _[carla.VehicleLightState](#carla.VehicleLightState)_
|
||||
- **Setter:** _[carla.Vehicle.set_light_state](#carla.Vehicle.set_light_state)_
|
||||
- <a name="carla.Vehicle.get_physics_control"></a>**<font color="#7fb800">get_physics_control</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The simulator returns the last physics control applied to this vehicle.
|
||||
- **Return:** _[carla.VehiclePhysicsControl](#carla.VehiclePhysicsControl)_
|
||||
|
|
@ -1870,7 +1927,8 @@ Retrieves the traffic light actor affecting this vehicle (if any) according to l
|
|||
- <a name="carla.Vehicle.get_traffic_light_state"></a>**<font color="#7fb800">get_traffic_light_state</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the state of the traffic light affecting this vehicle according to last tick. The method does not call the simulator. If no traffic light is currently affecting the vehicle, returns <b>green</b>.
|
||||
- **Return:** _[carla.TrafficLightState](#carla.TrafficLightState)_
|
||||
- <a name="carla.Vehicle.set_autopilot"></a>**<font color="#7fb800">set_autopilot</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**enabled**=True</font>, <font color="#00a6ed">**port**=8000</font>)
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Vehicle.set_autopilot"></a>**<font color="#7fb800">set_autopilot</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**enabled**=True</font>, <font color="#00a6ed">**tm**=None</font>)
|
||||
Registers or deletes the vehicle from a Traffic Manager's list. When __True__, the Traffic Manager passed as parameter will move the vehicle around. The autopilot takes place client-side.
|
||||
- **Parameters:**
|
||||
- `enabled` (_bool_)
|
||||
|
|
@ -1879,9 +1937,10 @@ Registers or deletes the vehicle from a Traffic Manager's list. When __True__, t
|
|||
Sets the light state of a vehicle using a flag that represents the lights that are on and off.
|
||||
- **Parameters:**
|
||||
- `light_state` (_[carla.VehicleLightState](#carla.VehicleLightState)_)
|
||||
- **Getter:** _[carla.Vehicle.get_light_state](#carla.Vehicle.get_light_state)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Vehicle.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Vehicle.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1915,8 +1974,8 @@ States which gear is the vehicle running on.
|
|||
- `manual_gear_shift` (_bool_)
|
||||
- `gear` (_int_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.VehicleControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehicleControl](#carla.VehicleControl)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.VehicleControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehicleControl](#carla.VehicleControl)</font>)
|
||||
- <a name="carla.VehicleControl.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehicleControl](#carla.VehicleControl)</font>)
|
||||
- <a name="carla.VehicleControl.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -2003,8 +2062,8 @@ VehiclePhysicsControl constructor.
|
|||
- `steering_curve` (_[carla.Vector2D](#carla.Vector2D)_)
|
||||
- `wheels` (_list([carla.WheelPhysicsControl](#carla.WheelPhysicsControl))_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.VehiclePhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehiclePhysicsControl](#carla.VehiclePhysicsControl)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.VehiclePhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehiclePhysicsControl](#carla.VehiclePhysicsControl)</font>)
|
||||
- <a name="carla.VehiclePhysicsControl.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.VehiclePhysicsControl](#carla.VehiclePhysicsControl)</font>)
|
||||
- <a name="carla.VehiclePhysicsControl.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -2026,12 +2085,14 @@ On the next tick, the control will move the walker in a certain direction with a
|
|||
On the next tick, the control defines a list of bone transformations that will be applied to the walker's skeleton.
|
||||
- **Parameters:**
|
||||
- `control` (_[carla.WalkerBoneControl](#carla.WalkerBoneControl)_)
|
||||
- <a name="carla.Walker.get_control"></a>**<font color="#7fb800">get_control</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Walker.get_control"></a>**<font color="#7fb800">get_control</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The client returns the control applied to this walker during last tick. The method does not call the simulator.
|
||||
- **Return:** _[carla.WalkerControl](#carla.WalkerControl)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Walker.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Walker.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -2047,13 +2108,15 @@ Sets the destination that the pedestrian will reach.
|
|||
Enables AI control for its parent walker.
|
||||
- <a name="carla.WalkerAIController.stop"></a>**<font color="#7fb800">stop</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Disables AI control for its parent walker.
|
||||
- <a name="carla.WalkerAIController.set_max_speed"></a>**<font color="#7fb800">set_max_speed</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**speed**=1.4</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WalkerAIController.set_max_speed"></a>**<font color="#7fb800">set_max_speed</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**speed**=1.4</font>)
|
||||
Sets a speed for the walker in meters per second.
|
||||
- **Parameters:**
|
||||
- `speed` (_float_) – speed in m/s. An easy walking speed is set by default.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WalkerAIController.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WalkerAIController.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -2070,8 +2133,8 @@ Intializes an object containing moves to be applied on tick. These are listed wi
|
|||
- **Parameters:**
|
||||
- `list(name,transform)` (_tuple_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WalkerBoneControl.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WalkerBoneControl.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -2095,8 +2158,8 @@ If <b>True</b>, the walker will perform a jump.
|
|||
- `speed` (_float_)
|
||||
- `jump` (_bool_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WalkerControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WalkerControl](#carla.WalkerControl)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WalkerControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WalkerControl](#carla.WalkerControl)</font>)
|
||||
Compares every variable with `other` and returns <b>True</b> if these are all the same.
|
||||
- <a name="carla.WalkerControl.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WalkerControl](#carla.WalkerControl)</font>)
|
||||
Compares every variable with `other` and returns <b>True</b> if any of these differ.
|
||||
|
|
@ -2156,7 +2219,9 @@ Returns a list of waypoints from this to the start of the lane separated by a ce
|
|||
- **Parameters:**
|
||||
- `distance` (_float_) – The approximate distance between waypoints.
|
||||
- **Return:** _list([carla.Waypoint](#carla.Waypoint))_
|
||||
- <a name="carla.Waypoint.get_junction"></a>**<font color="#7fb800">get_junction</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Waypoint.get_junction"></a>**<font color="#7fb800">get_junction</font>**(<font color="#00a6ed">**self**</font>)
|
||||
If the waypoint belongs to a junction this function returns the asociated junction object. Otherwise returns null.
|
||||
- **Return:** _[carla.Junction](#carla.Junction)_
|
||||
- <a name="carla.Waypoint.get_landmarks"></a>**<font color="#7fb800">get_landmarks</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**distance**</font>, <font color="#00a6ed">**stop_at_junction**=False</font>)
|
||||
|
|
@ -2181,8 +2246,8 @@ Generates a waypoint at the center of the right lane based on the direction of t
|
|||
Will return <b>None</b> if the lane does not exist.
|
||||
- **Return:** _[carla.Waypoint](#carla.Waypoint)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.Waypoint.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Waypoint.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -2226,8 +2291,8 @@ Method to initialize an object defining weather conditions. This class has some
|
|||
- **Note:** <font color="#8E8E8E">_ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset.
|
||||
_</font>
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WeatherParameters.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WeatherParameters.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**</font>)
|
||||
Returns <b>True</b> if both objects' variables are the same.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.WeatherParameters.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**</font>)
|
||||
|
|
@ -2267,8 +2332,8 @@ World position of the wheel. This is a read-only parameter.
|
|||
- `max_handbrake_torque` (_float_)
|
||||
- `position` (_[carla.Vector3D](#carla.Vector3D)_)
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WheelPhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WheelPhysicsControl](#carla.WheelPhysicsControl)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WheelPhysicsControl.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WheelPhysicsControl](#carla.WheelPhysicsControl)</font>)
|
||||
- <a name="carla.WheelPhysicsControl.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WheelPhysicsControl](#carla.WheelPhysicsControl)</font>)
|
||||
- <a name="carla.WheelPhysicsControl.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
|
||||
|
|
@ -2322,7 +2387,9 @@ Same as **<font color="#7fb800">spawn_actor()</font>** but returns <b>None</b> o
|
|||
- `attach_to` (_[carla.Actor](#carla.Actor)_) – The parent object that the spawned actor will follow around.
|
||||
- `attachment` (_[carla.AttachmentType](#carla.AttachmentType)_) – Determines how fixed and rigorous should be the changes in position according to its parent object.
|
||||
- **Return:** _[carla.Actor](#carla.Actor)_
|
||||
- <a name="carla.World.get_actor"></a>**<font color="#7fb800">get_actor</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor_id**</font>)
|
||||
|
||||
<h5 style="margin-top: -20px">Getters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.World.get_actor"></a>**<font color="#7fb800">get_actor</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor_id**</font>)
|
||||
Looks up for an actor by ID and returns <b>None</b> if not found.
|
||||
- **Parameters:**
|
||||
- `actor_id` (_int_)
|
||||
|
|
@ -2366,13 +2433,17 @@ Returns the spectator actor. The spectator is a special type of actor created by
|
|||
- <a name="carla.World.get_weather"></a>**<font color="#7fb800">get_weather</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Retrieves an object containing weather parameters currently active in the simulation, mainly cloudiness, precipitation, wind and sun position.
|
||||
- **Return:** _[carla.WeatherParameters](#carla.WeatherParameters)_
|
||||
- <a name="carla.World.set_weather"></a>**<font color="#7fb800">set_weather</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**weather**</font>)
|
||||
- **Setter:** _[carla.World.set_weather](#carla.World.set_weather)_
|
||||
|
||||
<h5 style="margin-top: -20px">Setters</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.World.set_weather"></a>**<font color="#7fb800">set_weather</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**weather**</font>)
|
||||
Changes the weather parameteres ruling the simulation to another ones defined in an object.
|
||||
- **Parameters:**
|
||||
- `weather` (_[carla.WeatherParameters](#carla.WeatherParameters)_) – New conditions to be applied.
|
||||
- **Getter:** _[carla.World.get_weather](#carla.World.get_weather)_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.World.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.World.__str__"></a>**<font color="#7fb800">\__str__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
The content of the world is parsed and printed as a brief report of its current state.
|
||||
- **Return:** _string_
|
||||
|
||||
|
|
@ -2397,8 +2468,8 @@ Creates an object containing desired settings that could later be applied throug
|
|||
- `no_rendering_mode` (_bool_) – Set this to true to completely disable rendering in the simulation.
|
||||
- `fixed_delta_seconds` (_float_) – Set this time in seconds to get a fixed time-step in between frames. 0.0 means variable time-step and it is the default mode.
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WorldSettings.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WorldSettings](#carla.WorldSettings)</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WorldSettings.__eq__"></a>**<font color="#7fb800">\__eq__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WorldSettings](#carla.WorldSettings)</font>)
|
||||
Returns <b>True</b> if both objects' variables are the same.
|
||||
- **Return:** _bool_
|
||||
- <a name="carla.WorldSettings.__ne__"></a>**<font color="#7fb800">\__ne__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**other**=[carla.WorldSettings](#carla.WorldSettings)</font>)
|
||||
|
|
@ -2433,8 +2504,8 @@ Given a certain actor ID, checks if there is a snapshot corresponding it and so,
|
|||
- `actor_id` (_int_)
|
||||
- **Return:** _bool_
|
||||
|
||||
<h3>Dunder methods</h3>
|
||||
- <a name="carla.WorldSnapshot.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
<h5 style="margin-top: -20px">Dunder methods</h5>
|
||||
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.WorldSnapshot.__iter__"></a>**<font color="#7fb800">\__iter__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Method that enables iteration for this class using **<font color="#f8805a">timestamp</font>** as reference value.
|
||||
- <a name="carla.WorldSnapshot.__len__"></a>**<font color="#7fb800">\__len__</font>**(<font color="#00a6ed">**self**</font>)
|
||||
Returns the amount of [carla.ActorSnapshot](#carla.ActorSnapshot) present in this snapshot.
|
||||
|
|
|
|||
|
|
@ -23,6 +23,8 @@ QUERY = re.compile(r'([cC]arla(\.[a-zA-Z0-9_]+)+)')
|
|||
def create_hyperlinks(text):
|
||||
return re.sub(QUERY, r'[\1](#\1)', text)
|
||||
|
||||
def create_getter_setter_hyperlinks(text):
|
||||
return re.sub(QUERY, r'[\1](#\1)', text)
|
||||
|
||||
def join(elem, separator=''):
|
||||
return separator.join(elem)
|
||||
|
|
@ -72,13 +74,22 @@ class MarkdownFile:
|
|||
|
||||
def first_title(self):
|
||||
self._data = join([
|
||||
self._data, '#Python API reference'])
|
||||
self._data, '#Python API reference\n'])
|
||||
|
||||
def button_apis(self):
|
||||
self._data = join([
|
||||
self._data,
|
||||
''])
|
||||
|
||||
def title(self, strongness, buf):
|
||||
self._data = join([
|
||||
self._data, '\n', self.list_depth(), '#' * strongness, ' ', buf, '\n'])
|
||||
|
||||
def title_html(self, strongness, buf):
|
||||
if strongness == 5:
|
||||
self._data = join([
|
||||
self._data, '\n', self.list_depth(), '<h', str(strongness), ' style="margin-top: -20px">', buf, '</h', str(strongness),'>\n','<div style="padding-left:30px;margin-top:-25px"></div>'])
|
||||
else:
|
||||
self._data = join([
|
||||
self._data, '\n', self.list_depth(), '<h', str(strongness), '>', buf, '</h', str(strongness), '>\n'])
|
||||
|
||||
|
|
@ -383,6 +394,68 @@ def add_doc_method(md, method, class_key):
|
|||
|
||||
md.list_pop()
|
||||
|
||||
def add_doc_getter_setter(md, method, class_key,is_getter,other_list):
|
||||
method_name = method['def_name']
|
||||
method_key = join([class_key, method_name], '.')
|
||||
method_def = gen_doc_method_def(method, False)
|
||||
md.list_pushn(join([html_key(method_key), method_def]))
|
||||
|
||||
# Method doc
|
||||
if valid_dic_val(method, 'doc'):
|
||||
md.textn(create_hyperlinks(md.prettify_doc(method['doc'])))
|
||||
|
||||
printed_title = False
|
||||
if valid_dic_val(method, 'params'):
|
||||
for param in method['params']:
|
||||
# is_self = valid_dic_val(param, 'param_name') and param['param_name'] == 'self'
|
||||
have_doc = valid_dic_val(param, 'doc')
|
||||
have_type = valid_dic_val(param, 'type')
|
||||
if not have_doc and not have_type:
|
||||
continue
|
||||
# Print the 'Parameters' title once
|
||||
if not printed_title:
|
||||
printed_title = True
|
||||
md.list_push(bold('Parameters:') + '\n')
|
||||
add_doc_method_param(md, param)
|
||||
if printed_title:
|
||||
md.list_pop()
|
||||
|
||||
# Return doc
|
||||
if valid_dic_val(method, 'return'):
|
||||
md.list_push(bold('Return:') + ' ')
|
||||
md.textn(italic(create_hyperlinks(method['return'])))
|
||||
md.list_pop()
|
||||
|
||||
# If setter/getter
|
||||
for element in other_list:
|
||||
el_name = element['def_name']
|
||||
if el_name[4:] == method_name[4:]:
|
||||
if is_getter:
|
||||
md.list_push(bold('Setter:') + ' ')
|
||||
else:
|
||||
md.list_push(bold('Getter:') + ' ')
|
||||
md.textn(italic(create_hyperlinks(class_key+'.'+el_name)))
|
||||
md.list_pop()
|
||||
|
||||
# Note doc
|
||||
if valid_dic_val(method, 'note'):
|
||||
md.list_push(bold('Note:') + ' ')
|
||||
md.textn(color(COLOR_NOTE, italic(create_hyperlinks(method['note']))))
|
||||
md.list_pop()
|
||||
|
||||
# Warning doc
|
||||
if valid_dic_val(method, 'warning'):
|
||||
md.list_push(bold('Warning:') + ' ')
|
||||
md.textn(color(COLOR_WARNING, italic(create_hyperlinks(method['warning']))))
|
||||
md.list_pop()
|
||||
|
||||
# Raises error doc
|
||||
if valid_dic_val(method, 'raises'):
|
||||
md.list_pushn(bold('Raises:') + ' ' + method['raises'])
|
||||
md.list_pop()
|
||||
|
||||
md.list_pop()
|
||||
|
||||
def add_doc_dunder(md, dunder, class_key):
|
||||
dunder_name = dunder['def_name']
|
||||
dunder_key = join([class_key, dunder_name], '.')
|
||||
|
|
@ -510,6 +583,19 @@ class Documentation:
|
|||
"""Generates the documentation body"""
|
||||
md = MarkdownFile()
|
||||
md.first_title()
|
||||
md.textn(
|
||||
"This reference contains all the details about latest version of the Python API. To consult a valid reference for a specific CARLA release, please select it from the list hereunder.<br>"
|
||||
+"<details><summary><b>Previous references</b></summary><br><ul>"
|
||||
+"<li><a href="+"../APIs/python_api_098"+"><b>CARLA 0.9.8</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_097"+"><b>CARLA 0.9.7</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_096"+"><b>CARLA 0.9.6</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_095"+"><b>CARLA 0.9.5</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_094"+"><b>CARLA 0.9.4</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_093"+"><b>CARLA 0.9.3</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_092"+"><b>CARLA 0.9.2</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_091"+"><b>CARLA 0.9.1</b></a></li>"
|
||||
+"<li><a href="+"../APIs/python_api_090"+"><b>CARLA 0.9.0</b></a></li>"
|
||||
+"</ul></details><br><hr>")
|
||||
for module_name in sorted(self.master_dict):
|
||||
module = self.master_dict[module_name]
|
||||
module_key = module_name
|
||||
|
|
@ -536,17 +622,31 @@ class Documentation:
|
|||
if valid_dic_val(cl, 'methods'):
|
||||
method_list = list()
|
||||
dunder_list = list()
|
||||
get_list = list()
|
||||
set_list = list()
|
||||
for method in cl['methods']:
|
||||
method_name = method['def_name']
|
||||
if method_name[0] == '_' and method_name != '__init__':
|
||||
dunder_list.append(method)
|
||||
elif method_name[:4] == 'get_':
|
||||
get_list.append(method)
|
||||
elif method_name[:4] == 'set_':
|
||||
set_list.append(method)
|
||||
else:
|
||||
method_list.append(method)
|
||||
md.title_html(3, 'Methods')
|
||||
for method in method_list:
|
||||
add_doc_method(md, method, class_key)
|
||||
if len(get_list)>0:
|
||||
md.title_html(5, 'Getters')
|
||||
for method in get_list:
|
||||
add_doc_getter_setter(md, method, class_key,True,set_list)
|
||||
if len(set_list)>0:
|
||||
md.title_html(5, 'Setters')
|
||||
for method in set_list:
|
||||
add_doc_getter_setter(md, method, class_key,False,get_list)
|
||||
if len(dunder_list)>0:
|
||||
md.title_html(3, 'Dunder methods')
|
||||
md.title_html(5, 'Dunder methods')
|
||||
for method in dunder_list:
|
||||
add_doc_dunder(md, method, class_key)
|
||||
md.separator()
|
||||
|
|
|
|||
Loading…
Reference in New Issue