Document bounding box in player measurements

This commit is contained in:
nsubiron 2018-05-24 12:11:51 +02:00
parent 998e2421c9
commit 2a55c207dd
1 changed files with 21 additions and 11 deletions

View File

@ -28,8 +28,9 @@ Player measurements
------------------- -------------------
Key | Type | Units | Description Key | Type | Units | Description
-------------------------- | --------- | ------ | ------------ -------------------------- | ----------- | ------ | ------------
transform | Transform | | World transform of the player (contains a locations and a rotation). transform | Transform | | World transform of the player (contains a locations and a rotation).
bounding_box | BoundingBox | | Bounding box of the player.
acceleration | Vector3D | m/s^2 | Current acceleration of the player. acceleration | Vector3D | m/s^2 | Current acceleration of the player.
forward_speed | float | m/s | Forward speed of the player. forward_speed | float | m/s | Forward speed of the player.
collision_vehicles | float | kg*m/s | Collision intensity with other vehicles. collision_vehicles | float | kg*m/s | Collision intensity with other vehicles.
@ -49,6 +50,15 @@ location | Vector3D | m | World location.
orientation *[deprecated]* | Vector3D | | Orientation in Cartesian coordinates. orientation *[deprecated]* | Vector3D | | Orientation in Cartesian coordinates.
rotation | Rotation3D | degrees | Pitch, roll, and yaw. rotation | Rotation3D | degrees | Pitch, roll, and yaw.
<h4>BoundingBox</h4>
Contains the transform and extent of a bounding box.
Key | Type | Units | Description
-------------------------- | ---------- | ------- | ------------
transform | Transform | | Transform of the bounding box relative to the vehicle.
extent | Vector3D | m | Radii dimensions of the bounding box (half-box).
<h4>Collision</h4> <h4>Collision</h4>
Collision variables keep an accumulation of all the collisions occurred during Collision variables keep an accumulation of all the collisions occurred during