@@ -187,35 +187,58 @@ One (possibly both) of them may change to resolve this.
187
187
An ` Orientation ` object describes the orientation of a marker.
188
188
189
189
rot_x
190
- : Rotation of the marker about the cartesian x-axis, in radians.
190
+ : Rotation of the marker about the cartesian x-axis, in radians. This is a
191
+ pitch-like rotation.
191
192
192
193
Leaning a marker towards the camera increases the value of `rot_x`, while
193
194
leaning it away from the camera decreases it. A value of either π or -π
194
195
indicates that the marker is upright (there is a discontinuity in the value
195
196
at π and -π, as both values represent the same position).
196
197
197
198
rot_y
198
- : Rotation of the marker about the cartesian y-axis, in radians.
199
+ : Rotation of the marker about the cartesian y-axis, in radians. This is a
200
+ yaw-like rotation.
199
201
200
202
Turning a marker clockwise (as viewed from above) decreases the value of
201
203
`rot_y`, while turning it anticlockwise increases it. A value of 0 means
202
204
that the marker is perpendicular to the line of sight of the camera.
203
205
204
206
rot_z
205
- : Rotation of the marker about the cartesian z-axis, in radians.
207
+ : Rotation of the marker about the cartesian z-axis, in radians. This is a
208
+ roll-like rotation.
206
209
207
210
Turning a marker anticlockwise (as viewed from the camera) increases the
208
211
value of `rot_z`, while turning it clockwise decreases it. A value of 0
209
212
indicates that the marker is upright.
210
213
211
- roll
212
- : An alias for ` rot_x ` .
214
+ There are additional attributes for the [ principal axis rotations] ( https://en.wikipedia.org/wiki/Aircraft_principal_axes ) of the marker.
215
+
216
+ yaw
217
+ : A rotation about the about the vertical axis, in radians (an axis top to
218
+ bottom through the token). Turning a marker clockwise (as viewed from above)
219
+ increases the value of ` yaw ` , while turning it anticlockwise decreases it. A
220
+ value of 0 means that the marker is perpendicular to the line of sight of
221
+ the camera.
222
+
223
+ This differs from `rot_y` in the direction that increases the value.
213
224
214
225
pitch
215
- : An alias for ` rot_y ` .
226
+ : A rotation about the transverse axis, in radians (an axis right to left
227
+ across the token). Tilting the marker backward increases the value of
228
+ ` pitch ` , while tilting it forwards decreases it. A value of 0 indicates that
229
+ the marker is facing the camera square-on.
230
+
231
+ This differs from `rot_x` in the zero point and direction to increase the value.
232
+
233
+ roll
234
+ : A rotation about the longitudinal axis, in radians (an axis normal from the
235
+ apparent front to the back of the token, normal to the marker). Rotating the
236
+ marker anti-clockwise (from the perspective of the camera) increases the
237
+ value of ` roll ` , while rotating it clockwise decreases it. A value of 0
238
+ indicates that the marker is upright.
239
+
240
+ This differs from `rot_x` in the zero point and direction to increase the value.
216
241
217
- yaw
218
- : An alias for ` rot_z ` .
219
242
220
243
rotation_matrix
221
244
: The rotation matrix represented by this orientation. A list of 3 lists, each with 3 items.
0 commit comments