carla/Docs/python_api.md

269 lines
4.4 KiB
Markdown
Raw Normal View History

2018-07-30 20:28:51 +08:00
<h1>Python API Reference</h1>
2018-07-29 01:29:31 +08:00
!!! 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)`
2018-10-01 20:29:11 +08:00
- `set_timeout(float_seconds)`
2018-07-29 01:29:31 +08:00
- `get_client_version()`
- `get_server_version()`
- `get_world()`
## `carla.World`
2018-10-17 02:12:23 +08:00
- `id`
- `map_name`
2018-07-29 01:29:31 +08:00
- `get_blueprint_library()`
2018-10-25 04:42:50 +08:00
- `get_map()`
2018-07-29 17:28:16 +08:00
- `get_spectator()`
2018-10-15 01:00:08 +08:00
- `get_weather()`
- `set_weather(weather_parameters)`
- `get_actors()`
2018-07-29 01:29:31 +08:00
- `spawn_actor(blueprint, transform, attach_to=None)`
- `try_spawn_actor(blueprint, transform, attach_to=None)`
2018-10-21 21:23:27 +08:00
- `wait_for_tick(seconds=1.0)`
2018-10-21 22:49:43 +08:00
- `on_tick(callback)`
2018-07-29 01:29:31 +08:00
## `carla.BlueprintLibrary`
- `find(id)`
- `filter(wildcard_pattern)`
- `__getitem__(pos)`
- `__len__()`
- `__iter__()`
## `carla.ActorBlueprint`
- `id`
- `tags`
2018-10-22 20:35:48 +08:00
- `has_tag(tag)`
2018-07-29 01:29:31 +08:00
- `match_tags(wildcard_pattern)`
2018-10-22 20:35:48 +08:00
- `has_attribute(key)`
2018-07-29 01:29:31 +08:00
- `get_attribute(key)`
- `set_attribute(key, value)`
- `__len__()`
- `__iter__()`
2018-07-29 01:29:31 +08:00
## `carla.ActorAttribute`
- `id`
2018-07-29 01:29:31 +08:00
- `type`
- `recommended_values`
- `is_modifiable`
2018-07-29 01:29:31 +08:00
- `as_bool()`
- `as_int()`
- `as_float()`
- `as_str()`
- `as_color()`
2018-10-22 20:35:48 +08:00
- `__eq__(other)`
- `__ne__(other)`
2018-07-29 01:29:31 +08:00
- `__nonzero__()`
- `__bool__()`
- `__int__()`
- `__float__()`
- `__str__()`
## `carla.ActorList`
- `filter(wildcard_pattern)`
- `__getitem__(pos)`
- `__len__()`
- `__iter__()`
2018-07-29 01:29:31 +08:00
## `carla.Actor`
- `id`
- `type_id`
2018-10-22 00:27:49 +08:00
- `semantic_tags`
- `is_alive`
2018-07-29 01:29:31 +08:00
- `get_world()`
- `get_location()`
- `get_transform()`
- `get_velocity()`
- `get_acceleration()`
2018-07-29 01:29:31 +08:00
- `set_location(location)`
- `set_transform(transform)`
- `set_simulate_physics(enabled=True)`
2018-07-29 01:29:31 +08:00
- `destroy()`
## `carla.Vehicle(carla.Actor)`
- `bounding_box`
- `control`
2018-07-29 01:29:31 +08:00
- `apply_control(vehicle_control)`
- `set_autopilot(enabled=True)`
2018-10-22 20:35:48 +08:00
## `carla.TrafficLight(carla.Actor)`
- `state`
2018-07-29 01:29:31 +08:00
## `carla.Sensor(carla.Actor)`
- `is_listening`
2018-07-29 01:29:31 +08:00
- `listen(callback_function)`
- `stop()`
2018-07-29 01:29:31 +08:00
2018-10-22 20:35:48 +08:00
## `carla.SensorData`
2018-07-29 01:29:31 +08:00
- `frame_number`
- `transform`
2018-10-22 20:35:48 +08:00
## `carla.Image(carla.SensorData)`
2018-07-29 01:29:31 +08:00
- `width`
- `height`
- `fov`
- `raw_data`
- `convert(color_converter)`
- `save_to_disk(path, color_converter=None)`
- `__len__()`
- `__iter__()`
- `__getitem__(pos)`
- `__setitem__(pos, color)`
2018-10-22 20:35:48 +08:00
## `carla.LidarMeasurement(carla.SensorData)`
- `horizontal_angle`
- `channels`
- `raw_data`
- `get_point_count(channel)`
- `save_to_disk(path)`
- `__len__()`
- `__iter__()`
- `__getitem__(pos)`
- `__setitem__(pos, location)`
2018-07-29 01:29:31 +08:00
2018-10-22 20:35:48 +08:00
## `carla.CollisionEvent(carla.SensorData)`
- `actor`
- `other_actor`
- `normal_impulse`
2018-07-29 01:29:31 +08:00
## `carla.VehicleControl`
- `throttle`
- `steer`
- `brake`
- `hand_brake`
- `reverse`
2018-10-22 20:35:48 +08:00
- `__eq__(other)`
- `__ne__(other)`
2018-07-29 01:29:31 +08:00
2018-10-25 04:42:50 +08:00
## `carla.Map`
- `name`
- `get_spawn_points()`
- `get_waypoint(location, project_to_road=True)`
- `to_opendrive()`
## `carla.Waypoint`
- `transform`
- `next(distance)`
2018-10-15 01:00:08 +08:00
## `carla.WeatherParameters`
- `cloudyness`
- `precipitation`
- `precipitation_deposits`
- `wind_intensity`
- `sun_azimuth_angle`
- `sun_altitude_angle`
2018-10-22 20:35:48 +08:00
- `__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)`
2018-10-15 01:00:08 +08:00
2018-07-29 01:29:31 +08:00
## `carla.Location`
- `x`
- `y`
- `z`
2018-10-22 20:35:48 +08:00
- `__add__(other)`
- `__sub__(other)`
- `__eq__(other)`
- `__ne__(other)`
2018-07-29 01:29:31 +08:00
## `carla.Rotation`
- `pitch`
- `yaw`
- `roll`
2018-10-22 20:35:48 +08:00
- `__eq__(other)`
- `__ne__(other)`
2018-07-29 01:29:31 +08:00
## `carla.Transform`
- `location`
- `rotation`
2018-10-22 20:35:48 +08:00
- `__eq__(other)`
- `__ne__(other)`
## `carla.Timestamp`
- `frame_count`
- `elapsed_seconds`
- `delta_seconds`
- `platform_timestamp`
- `__eq__(other)`
- `__ne__(other)`
2018-07-29 01:29:31 +08:00
## `carla.Color`
- `r`
- `g`
- `b`
- `a`
2018-10-22 20:35:48 +08:00
- `__eq__(other)`
- `__ne__(other)`
## `carla.ColorConverter`
- `Raw`
- `Depth`
- `LogarithmicDepth`
- `CityScapesPalette`
2018-10-22 20:35:48 +08:00
## `carla.ActorAttributeType`
- `Bool`
- `Int`
- `Float`
- `RGBColor`
## `carla.TrafficLightState`
- `Unknown`
- `Red`
- `Yellow`
- `Green`