Skip to content

Commit

Permalink
[doc] Add face definition and order of indices on faces
Browse files Browse the repository at this point in the history
  • Loading branch information
IAmNotHanni committed May 20, 2021
1 parent a24124d commit 03f67c3
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions documentation/source/development/reference/octree-file-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: Name, Normal vector

"left", "(-1, 0, 0)"
"right", "(1, 0, 0)"
"front", "(0, 1, 0)"
"back", "(0, -1, 0)"
"top", "(0, 0, 1)"
"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, Coordinate

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.
Expand Down

0 comments on commit 03f67c3

Please sign in to comment.