solstice

commit 1117c5bd4b8e08f07d8dd0715b2bd4f3ffc66255
parent 71652469aeaed31962a3e725fb73eac3273d1bd2
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 10 May 2017 22:31:35 +0200

Add a transform sub-section to the entity part of the solstice-input man

Diffstat:
M
doc/solstice-input.5.ronn
 | 
22
+++++++++++++++++++++-

1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/doc/solstice-input.5.ronn b/doc/solstice-input.5.ronn
@@ -622,7 +622,27 @@ following example, the entities `entity0.level0.level1` and
     - entity: {name: entity0, child: [*my-template]}
     - entity: {name: entity1, child: [*my-template]}
 
-## EXAMPLES
+### Transform
+
+A `transform` can be applied to a `geometry` or an `entity` to move them in
+space. Its `rotation` parameter list 3 angles in degrees defining the rotation
+to perform around the X, Y and Z axis. The `translation` attribute describes
+the offsets to apply along the X, Y and Z axis. Let the local repair `p` of an
+geometry, `p` is transformed in `p'` with respect to its associated `transform`
+as follow:
+
+    p' = Rx * Ry * Rz * (T + p)
+
+with `T` the `translation` vector and `Rx`, `Ry` and `Rz` the rotation matrices
+around the X, Y and Z axis defined as:
+
+         | 1  0   0 |        | cY  0 sY |        | cZ -sZ  0 |
+    Rx = | 0 cX -sX |;  Ry = |  0  1  0 |;  Rz = | sZ  cZ  0 |
+         | 0 sX  cX |        |-sY  0 cY |        |  0   0  1 |
+
+where `c<X|Y|Z>` and `s<X|Y|Z>` are the cosine and the sinus, respectively, of
+the rotation angles around the `X`, `Y` and `Z` axis defined by the `rotation`
+vector.
 
 ## NOTES