From 72aa7e1ba59bf37c443840a3d2b396e3f034b564 Mon Sep 17 00:00:00 2001 From: Seth Alter Date: Wed, 24 Jan 2024 14:42:41 -0500 Subject: [PATCH] Improved the documentation of LocalTransforms.get_forward(index) --- Documentation/Changelog.md | 2 +- Documentation/api/output_data.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Changelog.md b/Documentation/Changelog.md index 97dc2907..d27ddd16 100644 --- 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.
Improved the documentation of `LocalTransforms.get_forward()` | ## v1.12.22 diff --git a/Documentation/api/output_data.md b/Documentation/api/output_data.md index 644674d6..96ecaf78 100644 --- 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` |