quaternion: clarify that from_to result is normalised

This commit is contained in:
Danny Robson 2020-01-30 15:06:36 +11:00
parent 44509498b7
commit c6bce64af3

View File

@ -46,6 +46,8 @@ namespace cruft {
/// Constructs a quaternion that represents the rotation of a unit /// Constructs a quaternion that represents the rotation of a unit
/// vector `a` to the unit vector `b`. /// vector `a` to the unit vector `b`.
///
/// The return value is guaranteed to be normalised.
static quaternion from_to (vector<3,T> a, vector<3,T> b); static quaternion from_to (vector<3,T> a, vector<3,T> b);
/// Constructs a quaternion that represents the rotation needed to /// Constructs a quaternion that represents the rotation needed to