Merge pull request #65 from tier4/feature/docs

Feature/docs
tier4 · Jan 17, 2023 · 3f25cd8 · 3f25cd8
2 parents c0cd77e + a4dbc3c
commit 3f25cd8
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 2 deletions.
diff --git a/docs/Components/Traffic/NPC/NPC Pedestrian/index.md b/docs/Components/Traffic/NPC/NPC Pedestrian/index.md
@@ -31,8 +31,8 @@ The following section describes the API of `NPCPedestrian.cs` script.
 
 |API|type|feature|
 |:--|:--|:--|
-|SetPosition|Vector3|Move NPC pedestrian so that the reference point is at the specified coordinates.|
-|SetRotation|Vector3|Rotate NPC pedestrian so that the orientation of the reference point becomes the specified one.|
+|SetPosition|Vector3|Move the NPC pedestrian so that the reference point is at the specified coordinates.|
+|SetRotation|Vector3|Rotate the NPC pedestrian so that the orientation of the reference point becomes the specified one.|
 
 
 
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/image_0.png b/docs/Components/Traffic/NPC/NPC Vehicle/image_0.png
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/image_1.png b/docs/Components/Traffic/NPC/NPC Vehicle/image_1.png
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/image_2.png b/docs/Components/Traffic/NPC/NPC Vehicle/image_2.png
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/image_3.png b/docs/Components/Traffic/NPC/NPC Vehicle/image_3.png
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/image_4.png b/docs/Components/Traffic/NPC/NPC Vehicle/image_4.png
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/image_5.png b/docs/Components/Traffic/NPC/NPC Vehicle/image_5.png
diff --git a/docs/Components/Traffic/NPC/NPC Vehicle/index.md b/docs/Components/Traffic/NPC/NPC Vehicle/index.md
@@ -0,0 +1,33 @@
+# NPC Vehicle
+
+The `NPC Vehicle` is a non-playable vehicle object and used for simulation traffic flows. 
+
+<img src=image_0.png width=500px>
+
+The following prefab files are placed under `AWSIM\Assets\AWSIM\Prefabs\NPCs\Vehicles` directory.
+
+<img src="image_1.png" title="Hatchback.prefab" width="130" height="130"> <img src="image_2.png" title="SmallCar.prefab"  width="130" height="130"> <img src="image_3.png" title="Taxi.prefab" width="130" height="130"> <img src="image_4.png" title="Truck_2t.prefab" width="130" height="130">
+<img src="image_5.png" title="Van.prefab" width="130" height="130">
+
+Supported features:
+
+- Move inverse kinematically based on `Vector3 position`.
+- Rotate inverse kinematically based on `Vector3 rotation`.
+
+## Sample scene
+
+The sample scene that simulates the behavior of NPC Vehicle is placed under `AWSIM\Assets\AWSIM\Scenes\Samples` directory.
+
+## NPC Vehicle control scripts
+
+`NPCVehicle.cs` script that controls the vehicle's behavior are placed under `AWSIM\Assets\AWSIM\Scripts\NPCs\Vehicles` directory.
+
+
+## NPC Vehicle API
+
+The following section describes the API of `NPCVehicle.cs` script.
+
+|API|type|feature|
+|:--|:--|:--|
+|SetPosition|Vector3|Move the NPC Vehicle so that its x, z coodinates are same as the specified coordinates.|
+|SetRotation|Vector3|Rotate the NPC Vehicle so that its yaw becomes equal to the specified one.|
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -52,6 +52,7 @@ nav:
         - Add Random Traffic Environment: Components/Traffic/RandomTraffic/AddRandomTrafficEnvironment/index.md
       - NPC:
         - NPC Pedestrian: Components/Traffic/NPC/NPC Pedestrian/index.md
+        - NPC Vehicle: Components/Traffic/NPC/NPC Vehicle/index.md
     - ROS2:
       - ROS2 topic list: Components/ROS2/ROS2TopicList/index.md
       - Add custom ROS2 msg type: Components/ROS2/AddCustomROS2MessageType/index.md