Merge pull request #684 from threedworld-mit/local_transforms_forward

Improved the documentation of LocalTransforms.get_forward(index)
threedworld-mit · Jan 24, 2024 · 69b024d · 69b024d
2 parents 8a8e9d3 + 72aa7e1
commit 69b024d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/Documentation/Changelog.md b/Documentation/Changelog.md
@@ -34,7 +34,7 @@ To upgrade from TDW v1.11 to v1.12, read [this guide](upgrade_guides/v1.11_to_v1
 | Document | Description |
 | --- | --- |
 | `lessons/visual_perception/occlusion.md` | Updated document to describe the new `Occlusion` data. |
-| `api/output_data.md` | Improved the documentation for all positions and rotations. |
+| `api/output_data.md` | Improved the documentation for all positions and rotations.<br>Improved the documentation of `LocalTransforms.get_forward()` |
 
 ## v1.12.22
 

diff --git a/Documentation/api/output_data.md b/Documentation/api/output_data.md
@@ -628,7 +628,7 @@ Data about the Transform component of objects (position and rotation) relative t
 | `get_num()` | The number of objects. | `int` |
 | `get_id(index)` | The id. | `int` |
 | `get_position(index)` | The position. | `np.ndarray` |
-| `get_forward(index)` | The forward. | `np.ndarray` |
+| `get_forward(index)` | The forward directional vector, in worldspace rotational coordinates. | `np.ndarray` |
 | `get_rotation(index)` | The rotation. | `np.ndarray` |
 | `get_euler_angles(index)` | The `[x, y, z]` Euler angles of each object. | `np.ndarray` |