Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
admercs committed Feb 6, 2024
1 parent b2b4b27 commit 4dbddb9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
4 changes: 1 addition & 3 deletions docs/pages/autonomysim/meshes.md
Original file line number Diff line number Diff line change
@@ -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<float> vertices;
std::vector<uint32_t> indices;
std::string name;
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/autonomysim/modify_recording_data.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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 +
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/autonomysim/multi_vehicle.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 4dbddb9

Please sign in to comment.