From 4dbddb920edf2c6f745e2110383da2b9b8bdb02b Mon Sep 17 00:00:00 2001 From: admercs Date: Mon, 5 Feb 2024 19:00:34 -0800 Subject: [PATCH] update docs --- docs/pages/autonomysim/meshes.md | 4 +--- docs/pages/autonomysim/modify_recording_data.md | 6 +++--- docs/pages/autonomysim/multi_vehicle.md | 4 ++-- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/pages/autonomysim/meshes.md b/docs/pages/autonomysim/meshes.md index 38c0aba3..5f8dbcfb 100644 --- a/docs/pages/autonomysim/meshes.md +++ b/docs/pages/autonomysim/meshes.md @@ -1,16 +1,14 @@ # How to Access Meshes in AutonomySim -AutonomySim supports the ability to access the static meshes that make up the scene. +`AutonomySim` supports the ability to access the static meshes that make up the scene. ## Mesh structure Each mesh is represented with the below struct. ```cpp struct MeshPositionVertexBuffersResponse { - Vector3r position; Quaternionr orientation; - std::vector vertices; std::vector indices; std::string name; diff --git a/docs/pages/autonomysim/modify_recording_data.md b/docs/pages/autonomysim/modify_recording_data.md index 2434dd32..f5b87cf4 100644 --- a/docs/pages/autonomysim/modify_recording_data.md +++ b/docs/pages/autonomysim/modify_recording_data.md @@ -1,6 +1,6 @@ # Modifying Recording Data -AutonomySim has a [Recording feature](settings.md#recording) to easily collect data and images. The [Recording APIs](apis.md#recording-apis) also allows starting and stopping the recording using API. +`AutonomySim` has a [Recording feature](settings.md#recording) to easily collect data and images. The [Recording APIs](apis.md#recording-apis) also allows starting and stopping the recording using API. However, the data recorded by default might not be sufficient for your use cases, and it might be preferable to record additional data such as IMU, GPS sensors, Rotor speed for copters, etc. You can use the existing Python and C++ APIs to get the information and store it as required, especially for Lidar. Another option for adding small fields such as GPS or internal data such as Unreal position or something else is possible through modifying the recording methods inside AutonomySim. This page describes the specific methods which you might need to change. @@ -30,8 +30,8 @@ E.g. recording GPS, IMU and Barometer data also for multirotor - ```cpp // MultirotorPawnSimApi.cpp -std::string MultirotorPawnSimApi::getRecordFileLine(bool is_header_line) const -{ +std::string MultirotorPawnSimApi::getRecordFileLine(bool is_header_line) const { + std::string common_line = PawnSimApi::getRecordFileLine(is_header_line); if (is_header_line) { return common_line + diff --git a/docs/pages/autonomysim/multi_vehicle.md b/docs/pages/autonomysim/multi_vehicle.md index da863f21..1850bf0e 100644 --- a/docs/pages/autonomysim/multi_vehicle.md +++ b/docs/pages/autonomysim/multi_vehicle.md @@ -1,6 +1,6 @@ -# Multiple Vehicles in AutonomySim +# Multiple Vehicles -Since release 1.2, AutonomySim is fully enabled for multiple vehicles. This capability allows you to create multiple vehicles easily and use APIs to control them. +Since release 1.2, `AutonomySim` is fully enabled for multiple vehicles. This capability allows you to create multiple vehicles easily and use APIs to control them. ## Creating Multiple Vehicles