From 102eb3f0c714e08ae4e4a3289b5726fccc3f47bb Mon Sep 17 00:00:00 2001 From: MattRoweEAIF Date: Wed, 26 Apr 2023 13:32:58 +0200 Subject: [PATCH] updated collision sensor documentation --- Docs/python_api.md | 2 +- Docs/ref_sensors.md | 3 +-- PythonAPI/docs/sensor_data.yml | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/Docs/python_api.md b/Docs/python_api.md index 041aeca09..5f0a6e892 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -596,7 +596,7 @@ Sets the maxixum time a network call is allowed before blocking it and raising a ## carla.CollisionEvent Inherited from _[carla.SensorData](#carla.SensorData)_
-Class that defines a collision data for sensor.other.collision. The sensor creates one of this for every collision detected which may be many for one simulation step. Learn more about this [here](ref_sensors.md#collision-detector). +Class that defines a collision data for sensor.other.collision. The sensor creates one of these for every collision detected. Each collision sensor produces one collision event per collision per frame. Multiple collision events may be produced in a single frame by collisions with multiple other actors. Learn more about this [here](ref_sensors.md#collision-detector). ### Instance Variables - **actor** (_[carla.Actor](#carla.Actor)_) diff --git a/Docs/ref_sensors.md b/Docs/ref_sensors.md index bc78eba7d..5e28d05c5 100644 --- a/Docs/ref_sensors.md +++ b/Docs/ref_sensors.md @@ -25,8 +25,7 @@ * __Blueprint:__ sensor.other.collision * __Output:__ [carla.CollisionEvent](python_api.md#carla.CollisionEvent) per collision. -This sensor registers an event each time its parent actor collisions against something in the world. Several collisions may be detected during a single simulation step. -To ensure that collisions with any kind of object are detected, the server creates "fake" actors for elements such as buildings or bushes so the semantic tag can be retrieved to identify it. +This sensor registers an event each time its parent actor collides against something in the world. Each collision sensor produces one collision event per collision per frame. Multiple collision events may be produced in a single frame by collisions with multiple other actors. To ensure that collisions with any kind of object are detected, the server creates "fake" actors for elements such as buildings or bushes so the semantic tag can be retrieved to identify it. Collision detectors do not have any configurable attribute. diff --git a/PythonAPI/docs/sensor_data.yml b/PythonAPI/docs/sensor_data.yml index 2915dbbfc..ab2a8fc38 100644 --- a/PythonAPI/docs/sensor_data.yml +++ b/PythonAPI/docs/sensor_data.yml @@ -379,7 +379,7 @@ parent: carla.SensorData # - DESCRIPTION ------------------------ doc: > - Class that defines a collision data for sensor.other.collision. The sensor creates one of this for every collision detected which may be many for one simulation step. Learn more about this [here](ref_sensors.md#collision-detector). + Class that defines a collision data for sensor.other.collision. The sensor creates one of these for every collision detected. Each collision sensor produces one collision event per collision per frame. Multiple collision events may be produced in a single frame by collisions with multiple other actors. Learn more about this [here](ref_sensors.md#collision-detector). # - PROPERTIES ------------------------- instance_variables: - var_name: actor