nerdcruft/libcruft-util
1
0
Fork 0
Code Issues Releases Activity

quaternion: add docstrings

Browse Source
This commit is contained in:
Danny Robson 2018-04-13 18:49:09 +10:00
parent 00515078f9
commit 64ea4fb6d4
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
quaternion.hpp
View File

@ -11,7 +11,7 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
* *
* Copyright 2011-2016 Danny Robson <danny@nerdcruft.net> * Copyright 2011-2018 Danny Robson <danny@nerdcruft.net>
*/ */
#ifndef __UTIL_QUATERNION_HPP #ifndef __UTIL_QUATERNION_HPP
@ -44,13 +44,18 @@ namespace util {
static quaternion angle_axis (T radians, vector<3,T> axis); static quaternion angle_axis (T radians, vector<3,T> axis);
static quaternion from_euler (vector<3,T>); static quaternion from_euler (vector<3,T>);
static quaternion from_to (vector<3,T>, vector<3,T>); /// build a quaternion that represents the rotation from a to b
static quaternion from_to (vector<3,T> a, vector<3,T> b);
/// build a quaternion that represents the rotation needed to look at
/// a direction with a given up direction
static quaternion look (vector<3,T> fwd, vector<3,T> up); static quaternion look (vector<3,T> fwd, vector<3,T> up);
matrix4<T> as_matrix (void) const; matrix4<T> as_matrix (void) const;
static constexpr static constexpr
quaternion<T> identity (void) quaternion<T>
identity (void)
{ {
return { 1, 0, 0, 0 }; return { 1, 0, 0, 0 };
} }