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

New iteration with parameters, commands and fixes on DS comments

This commit is contained in:
sergi-e 2020-09-23 23:32:23 +02:00 committed by Marc Garcia Puig
parent 402731cefa
commit b79461f0c4
3 changed files with 143 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
Docs/python_api.md
View File

@ -19,20 +19,20 @@ A list of semantic tags provided by the blueprint listing components for this ac
The identifier of the blueprint this actor was based on, e.g. `vehicle.ford.mustang`. The identifier of the blueprint this actor was based on, e.g. `vehicle.ford.mustang`.
<h3>Methods</h3> <h3>Methods</h3>
- <a name="carla.Actor.add_angular_impulse"></a>**<font color="#7fb800">add_angular_impulse</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**impulse**</font>) - <a name="carla.Actor.add_angular_impulse"></a>**<font color="#7fb800">add_angular_impulse</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**angular_impulse**</font>)
Applies an angular impulse at the center of mass of the actor. Angular impulses are instantaneous. Use __<font color="#7fb800">add_torque()</font>__ to apply rotation forces over time. Applies an angular impulse at the center of mass of the actor. Angular impulses only last an instant. Use __<font color="#7fb800">add_torque()</font>__ to apply rotation forces over a period of time.
- **Parameters:** - **Parameters:**
- `impulse` (_[carla.Vector3D](#carla.Vector3D)<small> – N*s</small>_) – Angular impulse vector in global coordinates. - `angular_impulse` (_[carla.Vector3D](#carla.Vector3D)<small> – N*s</small>_) – Angular impulse vector in global coordinates.
- <a name="carla.Actor.add_impulse"></a>**<font color="#7fb800">add_impulse</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**impulse**</font>)
Applies an impulse at the center of mass of the actor. Impulses are instantaneous. Use __<font color="#7fb800">add_force()</font>__ to apply forces over time.
- **Parameters:**
- `impulse` (_[carla.Vector3D](#carla.Vector3D)<small> – degrees</small>_) – Impulse vector in global coordinates.
- <a name="carla.Actor.add_force"></a>**<font color="#7fb800">add_force</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**force**</font>) - <a name="carla.Actor.add_force"></a>**<font color="#7fb800">add_force</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**force**</font>)
Applies a force at the center of mass of the actor. The effects of the force depend on the delta time (time between simulation steps) during which it is applied. Use __<font color="#7fb800">add_angular_impulse()</font>__ to apply an instantaneous rotation impulse. Applies a force at the center of mass of the actor. This method should be used for forces that are applied over a certain period of time. Use __<font color="#7fb800">add_impulse()</font>__ to apply an impulse that only lasts an instant.
- **Parameters:** - **Parameters:**
- `force` (_[carla.Vector3D](#carla.Vector3D)_) – Force vector in global coordinates. - `force` (_[carla.Vector3D](#carla.Vector3D)<small> – degrees</small>_) – Force vector in global coordinates.
- <a name="carla.Actor.add_impulse"></a>**<font color="#7fb800">add_impulse</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**impulse**</font>)
Applies an impulse at the center of mass of the actor. Impulses only last an instant. Use __<font color="#7fb800">add_force()</font>__ to apply forces over a period of time.
- **Parameters:**
- `impulse` (_[carla.Vector3D](#carla.Vector3D)_) – Impulse vector in global coordinates.
- <a name="carla.Actor.add_torque"></a>**<font color="#7fb800">add_torque</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**torque**</font>) - <a name="carla.Actor.add_torque"></a>**<font color="#7fb800">add_torque</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**torque**</font>)
Applies a torque at the center of mass of the actor. The effects of the torque depend on the delta time (time between simulation steps) during which it is applied. Use __<font color="#7fb800">add_angular_impulse()</font>__ to apply an instantaneous rotation impulse. Applies a torque at the center of mass of the actor. The effects of the torque depend on the delta time (time between simulation steps) during which it is applied. Use __<font color="#7fb800">add_angular_impulse()</font>__ to apply a rotation impulse that only lasts an instant.
- **Parameters:** - **Parameters:**
- `torque` (_[carla.Vector3D](#carla.Vector3D)_) – Torque vector in global coordinates. - `torque` (_[carla.Vector3D](#carla.Vector3D)_) – Torque vector in global coordinates.
- <a name="carla.Actor.destroy"></a>**<font color="#7fb800">destroy</font>**(<font color="#00a6ed">**self**</font>) - <a name="carla.Actor.destroy"></a>**<font color="#7fb800">destroy</font>**(<font color="#00a6ed">**self**</font>)
@ -43,7 +43,7 @@ _</font>
- <a name="carla.Actor.disable_constant_velocity"></a>**<font color="#7fb800">disable_constant_velocity</font>**(<font color="#00a6ed">**self**</font>) - <a name="carla.Actor.disable_constant_velocity"></a>**<font color="#7fb800">disable_constant_velocity</font>**(<font color="#00a6ed">**self**</font>)
Disables any constant velocity previously set for a [carla.Vehicle](#carla.Vehicle) actor. Disables any constant velocity previously set for a [carla.Vehicle](#carla.Vehicle) actor.
- <a name="carla.Actor.enable_constant_velocity"></a>**<font color="#7fb800">enable_constant_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**velocity**</font>) - <a name="carla.Actor.enable_constant_velocity"></a>**<font color="#7fb800">enable_constant_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**velocity**</font>)
Sets the actor's velocity vector to a constant value over time. The modification is instantaneous. The resulting velocity will not be exactly the `velocity` being set. It will be affected by external forces such as friction. Sets the actor's velocity vector to a constant value over time. The resulting velocity will be approximately the `velocity` being set, as with __<font color="#7fb800">set_target_velocity()</font>__.
- **Parameters:** - **Parameters:**
- `velocity` (_[carla.Vector3D](#carla.Vector3D)_) – Velocity vector in local space. - `velocity` (_[carla.Vector3D](#carla.Vector3D)_) – Velocity vector in local space.
- **Warning:** <font color="#ED2F2F">_Enabling a constant velocity for a vehicle managed by the [Traffic Manager](https://[carla.readthedocs.io](#carla.readthedocs.io)/en/latest/adv_traffic_manager/) may cause conflicts. It will not be able to override the constant velocity being set. - **Warning:** <font color="#ED2F2F">_Enabling a constant velocity for a vehicle managed by the [Traffic Manager](https://[carla.readthedocs.io](#carla.readthedocs.io)/en/latest/adv_traffic_manager/) may cause conflicts. It will not be able to override the constant velocity being set.
@ -73,7 +73,7 @@ Returns the world this actor belongs to.
<h5 style="margin-top: -20px">Setters</h5> <h5 style="margin-top: -20px">Setters</h5>
<div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Actor.set_target_angular_velocity"></a>**<font color="#7fb800">set_target_angular_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**angular_velocity**</font>) <div style="padding-left:30px;margin-top:-25px"></div>- <a name="carla.Actor.set_target_angular_velocity"></a>**<font color="#7fb800">set_target_angular_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**angular_velocity**</font>)
Sets the actor's angular velocity vector. The modification is instantaneous, and done before physics. The resulting angular velocity will be affected by external forces over time (such as friction). Sets the actor's angular velocity vector. The modification will be effective two frames after the setting, and the update between angular velocities will be sudden. Also, this is applied before the physics step so the resulting angular velocity will be affected by external forces at this frame such as friction.
- **Parameters:** - **Parameters:**
- `angular_velocity` (_[carla.Vector3D](#carla.Vector3D)_) - `angular_velocity` (_[carla.Vector3D](#carla.Vector3D)_)
- **Note:** <font color="#8E8E8E">_The update will not be effective until two frames after it is set. - **Note:** <font color="#8E8E8E">_The update will not be effective until two frames after it is set.
@ -93,7 +93,7 @@ Teleports the actor to a given transform (location and rotation).
- `transform` (_[carla.Transform](#carla.Transform)_) - `transform` (_[carla.Transform](#carla.Transform)_)
- **Getter:** _[carla.Actor.get_transform](#carla.Actor.get_transform)_ - **Getter:** _[carla.Actor.get_transform](#carla.Actor.get_transform)_
- <a name="carla.Actor.set_target_velocity"></a>**<font color="#7fb800">set_target_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**velocity**</font>) - <a name="carla.Actor.set_target_velocity"></a>**<font color="#7fb800">set_target_velocity</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**velocity**</font>)
Sets the actor's velocity vector. The modification is instantaneous, and done before physics. The resulting velocity will be affected by external forces over time (such as friction). Sets the actor's velocity vector. The modification will be effective two frames after the setting, and the update between velocities will be sudden. Also, this is applied before the physics step so the resulting velocity will be affected by external forces at this frame such as friction.
- **Parameters:** - **Parameters:**
- `velocity` (_[carla.Vector3D](#carla.Vector3D)_) - `velocity` (_[carla.Vector3D](#carla.Vector3D)_)
- **Note:** <font color="#8E8E8E">_The update will not be effective until two frames after it is set. - **Note:** <font color="#8E8E8E">_The update will not be effective until two frames after it is set.
@ -2813,13 +2813,13 @@ Returns <b>True</b> if both **<font color="#f8805a">timestamp</font>** are diffe
--- ---
## command.ApplyAngularImpulse<a name="command.ApplyAngularImpulse"></a> ## command.ApplyAngularImpulse<a name="command.ApplyAngularImpulse"></a>
Command adaptation of **<font color="#7fb800">add_angular_impulse()</font>** in [carla.Actor](#carla.Actor). Adds angular impulse to an actor. Command adaptation of __<font color="#7fb800">add_angular_impulse()</font>__ in [carla.Actor](#carla.Actor). Applies an angular impulse to an actor.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyAngularImpulse.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyAngularImpulse.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
Actor affected by the command. Actor affected by the command.
- <a name="command.ApplyAngularImpulse.impulse"></a>**<font color="#f8805a">impulse</font>** (_[carla.Vector3D](#carla.Vector3D)<small> – degrees</small>_) - <a name="command.ApplyAngularImpulse.impulse"></a>**<font color="#f8805a">impulse</font>** (_[carla.Vector3D](#carla.Vector3D)<small> – degrees</small>_)
Angular impulse applied to the actor. Determines magnitude and global axis where it is applied. Angular impulse applied to the actor.
<h3>Methods</h3> <h3>Methods</h3>
- <a name="command.ApplyAngularImpulse.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor**</font>, <font color="#00a6ed">**impulse**</font>) - <a name="command.ApplyAngularImpulse.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor**</font>, <font color="#00a6ed">**impulse**</font>)
@ -2829,8 +2829,25 @@ Angular impulse applied to the actor. Determines magnitude and global axis where
--- ---
## command.ApplyForce<a name="command.ApplyForce"></a>
Command adaptation of __<font color="#7fb800">add_force()</font>__ in [carla.Actor](#carla.Actor). Applies a force to an actor.
<h3>Instance Variables</h3>
- <a name="command.ApplyForce.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
Actor affected by the command.
- <a name="command.ApplyForce.force"></a>**<font color="#f8805a">force</font>** (_[carla.Vector3D](#carla.Vector3D)_)
Force applied to the actor over time.
<h3>Methods</h3>
- <a name="command.ApplyForce.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor**</font>, <font color="#00a6ed">**force**</font>)
- **Parameters:**
- `actor` (_[carla.Actor](#carla.Actor) or int_) – Actor or its ID to whom the command will be applied to.
- `force` (_[carla.Vector3D](#carla.Vector3D)_)
---
## command.ApplyImpulse<a name="command.ApplyImpulse"></a> ## command.ApplyImpulse<a name="command.ApplyImpulse"></a>
Command adaptation of **<font color="#7fb800">add_impulse()</font>** in [carla.Actor](#carla.Actor). Adds impulse to an actor. Command adaptation of __<font color="#7fb800">add_impulse()</font>__ in [carla.Actor](#carla.Actor). Applies an impulse to an actor.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyImpulse.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyImpulse.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2847,7 +2864,7 @@ Impulse applied to the actor.
--- ---
## command.ApplyTargetAngularVelocity<a name="command.ApplyTargetAngularVelocity"></a> ## command.ApplyTargetAngularVelocity<a name="command.ApplyTargetAngularVelocity"></a>
Command adaptation of **<font color="#7fb800">set_target_angular_velocity()</font>** in [carla.Actor](#carla.Actor). Sets the actor's angular velocity vector. The modification is instantaneous, and done before physics. The resulting angular velocity will be affected by external forces over time (such as friction). Command adaptation of __<font color="#7fb800">set_target_angular_velocity()</font>__ in [carla.Actor](#carla.Actor). Sets the actor's angular velocity vector.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyTargetAngularVelocity.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyTargetAngularVelocity.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2864,7 +2881,7 @@ The 3D angular velocity that will be applied to the actor.
--- ---
## command.ApplyTargetVelocity<a name="command.ApplyTargetVelocity"></a> ## command.ApplyTargetVelocity<a name="command.ApplyTargetVelocity"></a>
Command adaptation of **<font color="#7fb800">set_target_velocity()</font>** in [carla.Actor](#carla.Actor). Sets the actor's velocity vector. The modification is instantaneous, and done before physics. The resulting velocity will be affected by external forces over time (such as friction). Command adaptation of __<font color="#7fb800">set_target_velocity()</font>__ in [carla.Actor](#carla.Actor).
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyTargetVelocity.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyTargetVelocity.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2880,8 +2897,25 @@ The 3D velocity applied to the actor.
--- ---
## command.ApplyTorque<a name="command.ApplyTorque"></a>
Command adaptation of __<font color="#7fb800">add_torque()</font>__ in [carla.Actor](#carla.Actor). Applies a torque to an actor.
<h3>Instance Variables</h3>
- <a name="command.ApplyTorque.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
Actor affected by the command.
- <a name="command.ApplyTorque.torque"></a>**<font color="#f8805a">torque</font>** (_[carla.Vector3D](#carla.Vector3D)_)
Torque applied to the actor over time.
<h3>Methods</h3>
- <a name="command.ApplyTorque.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**actor**</font>, <font color="#00a6ed">**torque**</font>)
- **Parameters:**
- `actor` (_[carla.Actor](#carla.Actor) or int_) – Actor or its ID to whom the command will be applied to.
- `torque` (_[carla.Vector3D](#carla.Vector3D)_)
---
## command.ApplyTransform<a name="command.ApplyTransform"></a> ## command.ApplyTransform<a name="command.ApplyTransform"></a>
Command adaptation of **<font color="#7fb800">set_transform()</font>** in [carla.Actor](#carla.Actor). Sets a new transform to an actor. Command adaptation of __<font color="#7fb800">set_transform()</font>__ in [carla.Actor](#carla.Actor). Sets a new transform to an actor.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyTransform.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyTransform.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2898,7 +2932,7 @@ Transformation to be applied.
--- ---
## command.ApplyVehicleControl<a name="command.ApplyVehicleControl"></a> ## command.ApplyVehicleControl<a name="command.ApplyVehicleControl"></a>
Command adaptation of **<font color="#7fb800">apply_control()</font>** in [carla.Vehicle](#carla.Vehicle). Applies a certain control to a vehicle. Command adaptation of __<font color="#7fb800">apply_control()</font>__ in [carla.Vehicle](#carla.Vehicle). Applies a certain control to a vehicle.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyVehicleControl.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyVehicleControl.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2915,7 +2949,7 @@ Vehicle control to be applied.
--- ---
## command.ApplyWalkerControl<a name="command.ApplyWalkerControl"></a> ## command.ApplyWalkerControl<a name="command.ApplyWalkerControl"></a>
Command adaptation of **<font color="#7fb800">apply_control()</font>** in [carla.Walker](#carla.Walker). Applies a control to a walker. Command adaptation of __<font color="#7fb800">apply_control()</font>__ in [carla.Walker](#carla.Walker). Applies a control to a walker.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.ApplyWalkerControl.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.ApplyWalkerControl.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2952,7 +2986,7 @@ Speed to be applied.
--- ---
## command.DestroyActor<a name="command.DestroyActor"></a> ## command.DestroyActor<a name="command.DestroyActor"></a>
Command adaptation of **<font color="#7fb800">destroy()</font>** in [carla.Actor](#carla.Actor) that tells the simulator to destroy this actor. It has no effect if the actor was already destroyed. When executed with **<font color="#7fb800">apply_batch_sync()</font>** in [carla.Client](#carla.Client) there will be a <b>command.Response</b> that will return a boolean stating whether the actor was successfully destroyed. Command adaptation of __<font color="#7fb800">destroy()</font>__ in [carla.Actor](#carla.Actor) that tells the simulator to destroy this actor. It has no effect if the actor was already destroyed. When executed with __<font color="#7fb800">apply_batch_sync()</font>__ in [carla.Client](#carla.Client) there will be a <b>command.Response</b> that will return a boolean stating whether the actor was successfully destroyed.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.DestroyActor.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.DestroyActor.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -2982,7 +3016,7 @@ Returns <b>True</b> if the command execution fails, and <b>False</b> if it was s
--- ---
## command.SetAutopilot<a name="command.SetAutopilot"></a> ## command.SetAutopilot<a name="command.SetAutopilot"></a>
Command adaptation of **<font color="#7fb800">set_autopilot()</font>** in [carla.Vehicle](#carla.Vehicle). Turns on/off the vehicle's autopilot mode. Command adaptation of __<font color="#7fb800">set_autopilot()</font>__ in [carla.Vehicle](#carla.Vehicle). Turns on/off the vehicle's autopilot mode.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.SetAutopilot.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.SetAutopilot.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -3002,7 +3036,7 @@ Port of the Traffic Manager where the vehicle is to be registered or unlisted.
--- ---
## command.SetSimulatePhysics<a name="command.SetSimulatePhysics"></a> ## command.SetSimulatePhysics<a name="command.SetSimulatePhysics"></a>
Command adaptation of **<font color="#7fb800">set_simulate_physics()</font>** in [carla.Actor](#carla.Actor). Determines whether an actor will be affected by physics or not. Command adaptation of __<font color="#7fb800">set_simulate_physics()</font>__ in [carla.Actor](#carla.Actor). Determines whether an actor will be affected by physics or not.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.SetSimulatePhysics.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.SetSimulatePhysics.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -3019,7 +3053,7 @@ If physics should be activated or not.
--- ---
## command.SetVehicleLightState<a name="command.SetVehicleLightState"></a> ## command.SetVehicleLightState<a name="command.SetVehicleLightState"></a>
Command adaptation of **<font color="#7fb800">set_light_state()</font>** in [carla.Vehicle](#carla.Vehicle). Sets the light state of a vehicle. Command adaptation of __<font color="#7fb800">set_light_state()</font>__ in [carla.Vehicle](#carla.Vehicle). Sets the light state of a vehicle.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.SetVehicleLightState.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_) - <a name="command.SetVehicleLightState.actor_id"></a>**<font color="#f8805a">actor_id</font>** (_int_)
@ -3036,7 +3070,7 @@ Defines the light state of a vehicle.
--- ---
## command.SpawnActor<a name="command.SpawnActor"></a> ## command.SpawnActor<a name="command.SpawnActor"></a>
Command adaptation of **<font color="#7fb800">spawn_actor()</font>** in [carla.World](#carla.World). Spawns an actor into the world based on the blueprint provided and the transform. If a parent is provided, the actor is attached to it. Command adaptation of __<font color="#7fb800">spawn_actor()</font>__ in [carla.World](#carla.World). Spawns an actor into the world based on the blueprint provided and the transform. If a parent is provided, the actor is attached to it.
<h3>Instance Variables</h3> <h3>Instance Variables</h3>
- <a name="command.SpawnActor.transform"></a>**<font color="#f8805a">transform</font>** (_[carla.Transform](#carla.Transform)_) - <a name="command.SpawnActor.transform"></a>**<font color="#f8805a">transform</font>** (_[carla.Transform](#carla.Transform)_)

34
PythonAPI/docs/actor.yml
View File

@ -37,32 +37,32 @@
methods: methods:
- def_name: add_angular_impulse - def_name: add_angular_impulse
params: params:
- param_name: impulse - param_name: angular_impulse
type: carla.Vector3D type: carla.Vector3D
param_units: N*s param_units: N*s
doc: > doc: >
Angular impulse vector in global coordinates. Angular impulse vector in global coordinates.
doc: > doc: >
Applies an angular impulse at the center of mass of the actor. Angular impulses are instantaneous. Use __<font color="#7fb800">add_torque()</font>__ to apply rotation forces over time. Applies an angular impulse at the center of mass of the actor. Angular impulses only last an instant. Use __<font color="#7fb800">add_torque()</font>__ to apply rotation forces over a period of time.
# --------------------------------------
- def_name: add_impulse
params:
- param_name: impulse
type: carla.Vector3D
param_units: degrees
doc: >
Impulse vector in global coordinates.
doc: >
Applies an impulse at the center of mass of the actor. Impulses are instantaneous. Use __<font color="#7fb800">add_force()</font>__ to apply forces over time.
# -------------------------------------- # --------------------------------------
- def_name: add_force - def_name: add_force
params: params:
- param_name: force - param_name: force
type: carla.Vector3D type: carla.Vector3D
param_units: degrees
doc: > doc: >
Force vector in global coordinates. Force vector in global coordinates.
doc: > doc: >
Applies a force at the center of mass of the actor. The effects of the force depend on the delta time (time between simulation steps) during which it is applied. Use __<font color="#7fb800">add_angular_impulse()</font>__ to apply an instantaneous rotation impulse. Applies a force at the center of mass of the actor. This method should be used for forces that are applied over a certain period of time. Use __<font color="#7fb800">add_impulse()</font>__ to apply an impulse that only lasts an instant.
# --------------------------------------
- def_name: add_impulse
params:
- param_name: impulse
type: carla.Vector3D
doc: >
Impulse vector in global coordinates.
doc: >
Applies an impulse at the center of mass of the actor. Impulses only last an instant. Use __<font color="#7fb800">add_force()</font>__ to apply forces over a period of time.
# -------------------------------------- # --------------------------------------
- def_name: add_torque - def_name: add_torque
params: params:
@ -71,7 +71,7 @@
doc: > doc: >
Torque vector in global coordinates. Torque vector in global coordinates.
doc: > doc: >
Applies a torque at the center of mass of the actor. The effects of the torque depend on the delta time (time between simulation steps) during which it is applied. Use __<font color="#7fb800">add_angular_impulse()</font>__ to apply an instantaneous rotation impulse. Applies a torque at the center of mass of the actor. The effects of the torque depend on the delta time (time between simulation steps) during which it is applied. Use __<font color="#7fb800">add_angular_impulse()</font>__ to apply a rotation impulse that only lasts an instant.
# -------------------------------------- # --------------------------------------
- def_name: destroy - def_name: destroy
return: bool return: bool
@ -91,7 +91,7 @@
doc: > doc: >
Velocity vector in local space. Velocity vector in local space.
doc: > doc: >
Sets the actor's velocity vector to a constant value over time. The modification is instantaneous. The resulting velocity will not be exactly the `velocity` being set. It will be affected by external forces such as friction. Sets the actor's velocity vector to a constant value over time. The resulting velocity will be approximately the `velocity` being set, as with __<font color="#7fb800">set_target_velocity()</font>__.
Note: > Note: >
Only carla.Vehicle actors can use this method. Only carla.Vehicle actors can use this method.
warning: > warning: >
@ -136,7 +136,7 @@
- param_name: angular_velocity - param_name: angular_velocity
type: carla.Vector3D type: carla.Vector3D
doc: > doc: >
Sets the actor's angular velocity vector. The modification is instantaneous, and done before physics. The resulting angular velocity will be affected by external forces over time (such as friction). Sets the actor's angular velocity vector. The modification will be effective two frames after the setting, and the update between angular velocities will be sudden. Also, this is applied before the physics step so the resulting angular velocity will be affected by external forces at this frame such as friction.
note: > note: >
The update will not be effective until two frames after it is set. The update will not be effective until two frames after it is set.
# -------------------------------------- # --------------------------------------
@ -168,7 +168,7 @@
- param_name: velocity - param_name: velocity
type: carla.Vector3D type: carla.Vector3D
doc: > doc: >
Sets the actor's velocity vector. The modification is instantaneous, and done before physics. The resulting velocity will be affected by external forces over time (such as friction). Sets the actor's velocity vector. The modification will be effective two frames after the setting, and the update between velocities will be sudden. Also, this is applied before the physics step so the resulting velocity will be affected by external forces at this frame such as friction.
note: > note: >
The update will not be effective until two frames after it is set. The update will not be effective until two frames after it is set.
# -------------------------------------- # --------------------------------------

78
PythonAPI/docs/commands.yml
View File

@ -29,7 +29,7 @@
- class_name: SpawnActor - class_name: SpawnActor
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">spawn_actor()</font>** in carla.World. Spawns an actor into the world based on the blueprint provided and the transform. If a parent is provided, the actor is attached to it. Command adaptation of __<font color="#7fb800">spawn_actor()</font>__ in carla.World. Spawns an actor into the world based on the blueprint provided and the transform. If a parent is provided, the actor is attached to it.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: transform - var_name: transform
@ -73,7 +73,7 @@
- class_name: DestroyActor - class_name: DestroyActor
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">destroy()</font>** in carla.Actor that tells the simulator to destroy this actor. It has no effect if the actor was already destroyed. When executed with **<font color="#7fb800">apply_batch_sync()</font>** in carla.Client there will be a <b>command.Response</b> that will return a boolean stating whether the actor was successfully destroyed. Command adaptation of __<font color="#7fb800">destroy()</font>__ in carla.Actor that tells the simulator to destroy this actor. It has no effect if the actor was already destroyed. When executed with __<font color="#7fb800">apply_batch_sync()</font>__ in carla.Client there will be a <b>command.Response</b> that will return a boolean stating whether the actor was successfully destroyed.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -93,7 +93,7 @@
- class_name: ApplyVehicleControl - class_name: ApplyVehicleControl
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">apply_control()</font>** in carla.Vehicle. Applies a certain control to a vehicle. Command adaptation of __<font color="#7fb800">apply_control()</font>__ in carla.Vehicle. Applies a certain control to a vehicle.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -119,7 +119,7 @@
- class_name: ApplyWalkerControl - class_name: ApplyWalkerControl
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">apply_control()</font>** in carla.Walker. Applies a control to a walker. Command adaptation of __<font color="#7fb800">apply_control()</font>__ in carla.Walker. Applies a control to a walker.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -145,7 +145,7 @@
- class_name: ApplyTransform - class_name: ApplyTransform
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">set_transform()</font>** in carla.Actor. Sets a new transform to an actor. Command adaptation of __<font color="#7fb800">set_transform()</font>__ in carla.Actor. Sets a new transform to an actor.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -205,7 +205,7 @@
- class_name: ApplyTargetVelocity - class_name: ApplyTargetVelocity
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">set_target_velocity()</font>** in carla.Actor. Sets the actor's velocity vector. The modification is instantaneous, and done before physics. The resulting velocity will be affected by external forces over time (such as friction). Command adaptation of __<font color="#7fb800">set_target_velocity()</font>__ in carla.Actor.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -235,7 +235,7 @@
- class_name: ApplyTargetAngularVelocity - class_name: ApplyTargetAngularVelocity
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">set_target_angular_velocity()</font>** in carla.Actor. Sets the actor's angular velocity vector. The modification is instantaneous, and done before physics. The resulting angular velocity will be affected by external forces over time (such as friction). Command adaptation of __<font color="#7fb800">set_target_angular_velocity()</font>__ in carla.Actor. Sets the actor's angular velocity vector.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -265,7 +265,7 @@
- class_name: ApplyImpulse - class_name: ApplyImpulse
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">add_impulse()</font>** in carla.Actor. Adds impulse to an actor. Command adaptation of __<font color="#7fb800">add_impulse()</font>__ in carla.Actor. Applies an impulse to an actor.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -290,10 +290,36 @@
param_units: N*s param_units: N*s
# -------------------------------------- # --------------------------------------
- class_name: ApplyForce
# - DESCRIPTION ------------------------
doc: >
Command adaptation of __<font color="#7fb800">add_force()</font>__ in carla.Actor. Applies a force to an actor.
# - PROPERTIES -------------------------
instance_variables:
- var_name: actor_id
type: int
doc: >
Actor affected by the command.
- var_name: force
type: carla.Vector3D
doc: >
Force applied to the actor over time.
# - METHODS ----------------------------
methods:
- def_name: __init__
params:
- param_name: actor
type: carla.Actor or int
doc: >
Actor or its ID to whom the command will be applied to.
- param_name: force
type: carla.Vector3D
# --------------------------------------
- class_name: ApplyAngularImpulse - class_name: ApplyAngularImpulse
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">add_angular_impulse()</font>** in carla.Actor. Adds angular impulse to an actor. Command adaptation of __<font color="#7fb800">add_angular_impulse()</font>__ in carla.Actor. Applies an angular impulse to an actor.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -304,7 +330,7 @@
type: carla.Vector3D type: carla.Vector3D
var_units: degrees var_units: degrees
doc: > doc: >
Angular impulse applied to the actor. Determines magnitude and global axis where it is applied. Angular impulse applied to the actor.
# - METHODS ---------------------------- # - METHODS ----------------------------
methods: methods:
- def_name: __init__ - def_name: __init__
@ -318,10 +344,36 @@
param_units: degrees param_units: degrees
# -------------------------------------- # --------------------------------------
- class_name: ApplyTorque
# - DESCRIPTION ------------------------
doc: >
Command adaptation of __<font color="#7fb800">add_torque()</font>__ in carla.Actor. Applies a torque to an actor.
# - PROPERTIES -------------------------
instance_variables:
- var_name: actor_id
type: int
doc: >
Actor affected by the command.
- var_name: torque
type: carla.Vector3D
doc: >
Torque applied to the actor over time.
# - METHODS ----------------------------
methods:
- def_name: __init__
params:
- param_name: actor
type: carla.Actor or int
doc: >
Actor or its ID to whom the command will be applied to.
- param_name: torque
type: carla.Vector3D
# --------------------------------------
- class_name: SetSimulatePhysics - class_name: SetSimulatePhysics
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">set_simulate_physics()</font>** in carla.Actor. Determines whether an actor will be affected by physics or not. Command adaptation of __<font color="#7fb800">set_simulate_physics()</font>__ in carla.Actor. Determines whether an actor will be affected by physics or not.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -347,7 +399,7 @@
- class_name: SetAutopilot - class_name: SetAutopilot
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">set_autopilot()</font>** in carla.Vehicle. Turns on/off the vehicle's autopilot mode. Command adaptation of __<font color="#7fb800">set_autopilot()</font>__ in carla.Vehicle. Turns on/off the vehicle's autopilot mode.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id
@ -382,7 +434,7 @@
- class_name: SetVehicleLightState - class_name: SetVehicleLightState
# - DESCRIPTION ------------------------ # - DESCRIPTION ------------------------
doc: > doc: >
Command adaptation of **<font color="#7fb800">set_light_state()</font>** in carla.Vehicle. Sets the light state of a vehicle. Command adaptation of __<font color="#7fb800">set_light_state()</font>__ in carla.Vehicle. Sets the light state of a vehicle.
# - PROPERTIES ------------------------- # - PROPERTIES -------------------------
instance_variables: instance_variables:
- var_name: actor_id - var_name: actor_id