[doc] Added reference page about octree collision

inexorgame · Jun 9, 2021 · 8d177ec · 8d177ec
1 parent 142323c
commit 8d177ec
Show file tree

Hide file tree

Showing 14 changed files with 216 additions and 0 deletions.
diff --git a/documentation/source/development/reference/main.rst b/documentation/source/development/reference/main.rst
@@ -9,3 +9,4 @@ Reference
     binary-format-specification
     keyboard-mouse-input
     octree-file-format
+    octree-collision
diff --git a/documentation/source/development/reference/octree-collision.rst b/documentation/source/development/reference/octree-collision.rst
diff --git a/documentation/source/development/reference/octree-file-format.rst b/documentation/source/development/reference/octree-file-format.rst
@@ -34,6 +34,34 @@ If blocks or corners are ordered, they use this order.
     6, "(1, 1, 0)"
     7, "(1, 1, 1)"
 
+**Order of Faces**
+
+The following order of faces is used:
+
+.. csv-table:: Order of Face
+    :header: ID, Name, Normal vector
+
+    0, "left", "(-1, 0, 0)"
+    1, "right", "(1, 0, 0)"
+    2, "front", "(0, 1, 0)"
+    3, "back", "(0, -1, 0)"
+    4, "top", "(0, 0, 1)"
+    5, "bottom", "(0, 0, -1)"
+
+**Order of Indices on Face**
+
+The following corner indices are associated to the faces:
+
+.. csv-table:: Order of Indices on Face
+    :header: ID, Indices
+
+    0, "0, 1, 2, 3"
+    1, "4, 5, 6, 7"
+    2, "0, 1, 4, 5"
+    3, "2, 3, 6, 7"
+    4, "1, 3, 5, 7"
+    5, "0, 2, 4, 6"
+
 **Edge Order**
 
 - All edges are going into the positive direction of the axis.

diff --git a/...source/development/reference/octree_collision_boundin_sphere_false_positive.jpg b/...source/development/reference/octree_collision_boundin_sphere_false_positive.jpg
diff --git a/...mentation/source/development/reference/octree_collision_camera_view_blocked.jpg b/...mentation/source/development/reference/octree_collision_camera_view_blocked.jpg
diff --git a/documentation/source/development/reference/octree_collision_cases.jpg b/documentation/source/development/reference/octree_collision_cases.jpg
diff --git a/documentation/source/development/reference/octree_collision_cube_facing_camera.jpg b/documentation/source/development/reference/octree_collision_cube_facing_camera.jpg
diff --git a/documentation/source/development/reference/octree_collision_filled.jpg b/documentation/source/development/reference/octree_collision_filled.jpg
diff --git a/documentation/source/development/reference/octree_collision_multiple_octrees.jpg b/documentation/source/development/reference/octree_collision_multiple_octrees.jpg
diff --git a/documentation/source/development/reference/octree_collision_nearest_corner.jpg b/documentation/source/development/reference/octree_collision_nearest_corner.jpg
diff --git a/documentation/source/development/reference/octree_collision_octant.jpg b/documentation/source/development/reference/octree_collision_octant.jpg
diff --git a/...ntation/source/development/reference/octree_collision_only_front_collisions.jpg b/...ntation/source/development/reference/octree_collision_only_front_collisions.jpg
diff --git a/documentation/source/development/reference/octree_collision_real_face.jpg b/documentation/source/development/reference/octree_collision_real_face.jpg
diff --git a/documentation/source/development/reference/octree_collision_sizes.jpg b/documentation/source/development/reference/octree_collision_sizes.jpg