From c4552e04e1271a9210a934233beae5be1943d034 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 7 Jun 2023 14:34:14 +0200
Subject: Writing User guide and use cases section.

---
 .../areas_of_interest/aoi_scene_description.md     | 57 ++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 docs/user_guide/areas_of_interest/aoi_scene_description.md

(limited to 'docs/user_guide/areas_of_interest/aoi_scene_description.md')

diff --git a/docs/user_guide/areas_of_interest/aoi_scene_description.md b/docs/user_guide/areas_of_interest/aoi_scene_description.md
new file mode 100644
index 0000000..dcda74b
--- /dev/null
+++ b/docs/user_guide/areas_of_interest/aoi_scene_description.md
@@ -0,0 +1,57 @@
+---
+title: AOI scene description
+---
+
+AOI scene description
+=====================
+
+An AOI3D scene is built from a 3D model with all AOI as 3D planes and loaded through OBJ file format. 
+Notice that plane normals are not needed and planes are not necessary 4 vertices shapes.
+
+``` obj
+o PIC_ND
+v 6.513238 -27.113548 -25.163900
+v 22.994461 -27.310783 -24.552130
+v 6.718690 -6.467261 -26.482569
+v 23.252594 -6.592890 -25.873484
+f 1 2 4 3
+o PIC_ND_Aircraft
+v 6.994747 -21.286463 -24.727146
+v 22.740919 -21.406120 -24.147078
+v 7.086208 -12.096219 -25.314123
+v 22.832380 -12.215876 -24.734055
+f 5 6 8 7
+o PIC_ND_Wind
+v 7.086199 -11.769333 -25.335127
+v 12.081032 -11.807289 -25.151123
+v 7.115211 -8.854101 -25.521320
+v 12.110044 -8.892057 -25.337317
+f 9 10 12 11
+o PIC_ND_Waypoint
+v 17.774197 -11.819057 -24.943428
+v 22.769030 -11.857013 -24.759424
+v 17.803209 -8.903825 -25.129622
+v 22.798042 -8.941781 -24.945618
+f 13 14 16 15
+...
+o Thrust_Lever
+v 19.046124 15.523837 4.774072
+v 18.997263 -0.967944 5.701000
+v 18.988382 15.923470 -13.243046
+v 18.921808 -0.417994 -17.869610
+v 19.032232 19.241346 -3.040264
+v 19.020988 6.392717 5.872663
+v 18.945322 6.876906 -17.699480
+s off
+f 185 190 186 188 191 187 189
+...
+```
+
+Here is a sample of code to show the loading of an AOI3D scene from an OBJ file description:
+
+``` python
+from argaze.AreaOfInterest import AOI3DScene
+
+# Load an AOI3D scene from OBJ file
+aoi3D_scene = AOI3DScene.AOI3DScene.from_obj('./aoi_scene.obj')
+```
-- 
cgit v1.1