p71924506
/
carla
mirror of https://github.com/carla-simulator/carla.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Formatted some docstring to be shorter

This commit is contained in:
Daniel 2024-07-24 14:19:55 +02:00 committed by Blyron
parent 19b892f76b
commit a089c3b800
1 changed files with 56 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
PythonAPI/carla/source/carla/libcarla.pyi
View File

@ -602,27 +602,48 @@ class ActorState(__CarlaEnum):
class AttachmentType(__CarlaEnum):
"""Class that defines attachment options between an actor and its parent. When spawning actors, these can be attached to another actor so their position changes accordingly. This is specially useful for sensors. The snippet in `carla.World.spawn_actor` shows some sensors being attached to a car when spawned.
"""
Class that defines attachment options between an actor and its parent.
When spawning actors, these can be attached to another actor so their
position changes accordingly. This is specially useful for sensors.
The snippet in `carla.World.spawn_actor` shows some sensors being
attached to a car when spawned.
+ Note that the attachment type is declared as an enum within the class."""
# region Instance Variables
Rigid = 0,
"""With this fixed attachment the object follow its parent position strictly. This is the recommended attachment to retrieve precise data from the simulation."""
"""With this fixed attachment the object follow its parent position strictly.
This is the recommended attachment to retrieve precise data from the simulation."""
SpringArm = 1,
"""An attachment that expands or retracts the position of the actor, depending on its parent. This attachment is only recommended to record videos from the simulation where a smooth movement is needed. SpringArms are an Unreal Engine component so check the UE docs to learn more about them.
"""
An attachment that expands or retracts the position of the actor,
depending on its parent. This attachment is only recommended to record
videos from the simulation where a smooth movement is needed. SpringArms
are an Unreal Engine component so check the UE docs to learn more about
them.
https://docs.unrealengine.com/5.3/en-US/using-spring-arm-components-in-unreal-engine/
+ Warning: The `SpringArm` attachment presents weird behaviors when an actor is spawned with a relative translation in the Z-axis (e.g. `child_location = Location(0,0,2)`).
+ Warning: The `SpringArm` attachment presents weird behaviors when an
actor is spawned with a relative translation in the Z-axis (e.g. `child_location = Location(0,0,2)`).
"""
SpringArmGhost = 2,
"""An attachment like the previous one but that does not make the collision test, and that means that it does not expands or retracts the position of the actor. The term ghost is because then the camera can cross walls and other geometries. This attachment is only recommended to record videos from the simulation where a smooth movement is needed. SpringArms are an Unreal Engine component so check the UE docs to learn more about them.
"""
An attachment like the previous one but that does not make the collision test,
and that means that it does not expands or retracts the position of the actor.
The term ghost is because then the camera can cross walls and other geometries.
This attachment is only recommended to record videos from the simulation where
a smooth movement is needed. SpringArms are an Unreal Engine component so
check the UE docs to learn more about them.
https://docs.unrealengine.com/5.3/en-US/using-spring-arm-components-in-unreal-engine/
+ Warning: The `SpringArm` attachment presents weird behaviors when an actor is spawned with a relative translation in the Z-axis (e.g. `child_location = Location(0,0,2)`)."""
+ Warning: The `SpringArm` attachment presents weird behaviors when an actor is
spawned with a relative translation in the Z-axis (e.g. `child_location = Location(0,0,2)`).
"""
# endregion
@ -1091,7 +1112,12 @@ class Color():
class ColorConverter(__CarlaEnum):
"""Class that defines conversion patterns that can be applied to a `carla.Image` in order to show information provided by `carla.Sensor`. Depth conversions cause a loss of accuracy, as sensors detect depth as float that is then converted to a grayscale value between 0 and 255. Take a look at the snippet in `carla.Sensor.listen` to see an example of how to create and save image data for `sensor.camera.semantic_segmentation`.
"""
Class that defines conversion patterns that can be applied to a `carla.Image` in order to show
information provided by `carla.Sensor`. Depth conversions cause a loss of accuracy, as sensors
detect depth as float that is then converted to a grayscale value between 0 and 255. Take a look
at the snippet in `carla.Sensor.listen` to see an example of how to create and save image data
for `sensor.camera.semantic_segmentation`.
"""
# region Instance Variables
@ -3014,7 +3040,12 @@ class Sensor(Actor):
class SensorData():
"""Base class for all the objects containing data generated by a `carla.Sensor`. This objects should be the argument of the function said sensor is listening to, in order to work with them. Each of these sensors needs for a specific type of sensor data. Hereunder is a list of the sensors and their corresponding data.
"""
Base class for all the objects containing data generated by a `carla.Sensor`.
This objects should be the argument of the function said sensor is listening to,
in order to work with them. Each of these sensors needs for a specific type of
sensor data. Hereunder is a list of the sensors and their corresponding data.
- Cameras (RGB, depth and semantic segmentation): `carla.Image`.
- Collision detector: `carla.CollisionEvent`.
- GNSS sensor: `carla.GnssMeasurement`.
@ -3044,7 +3075,9 @@ class SensorData():
class TextureColor():
"""Class representing a texture object to be uploaded to the server. Pixel format is RGBA, uint8 per channel.
"""
Class representing a texture object to be uploaded to the server.
Pixel format is RGBA, uint8 per channel.
"""
# region Instance Variables
@property
@ -3082,7 +3115,10 @@ class TextureColor():
class TextureFloatColor():
"""Class representing a texture object to be uploaded to the server. Pixel format is RGBA, float per channel."""
"""
Class representing a texture object to be uploaded to the server.
Pixel format is RGBA, float per channel.
"""
# region Instance Variables
@property
@ -3109,7 +3145,11 @@ class TextureFloatColor():
class Timestamp():
"""Class that contains time information for simulated data. This information is automatically retrieved as part of the `carla.WorldSnapshot` the client gets on every frame, but might also be used in many other situations such as a `carla.Sensor` retrieving data."""
"""
Class that contains time information for simulated data. This information is automatically
retrieved as part of the `carla.WorldSnapshot` the client gets on every frame, but might also
be used in many other situations such as a `carla.Sensor` retrieving data.
"""
# region Instance Variables
@property
@ -4993,7 +5033,10 @@ class WorldSettings():
class WorldSnapshot():
"""This snapshot comprises all the information for every actor on scene at a certain moment of time. It creates and gives acces to a data structure containing a series of `carla.ActorSnapshot`. The client recieves a new snapshot on every tick that cannot be stored."""
"""
This snapshot comprises all the information for every actor on scene at a certain moment of time.
It creates and gives acces to a data structure containing a series of `carla.ActorSnapshot`.
The client recieves a new snapshot on every tick that cannot be stored."""
pass
# region Instance Variables