1///////////////////////////////////////////////////////////////////////////////////
2/// OpenGL Mathematics (glm.g-truc.net)
3///
4/// Copyright (c) 2005 - 2014 G-Truc Creation (www.g-truc.net)
5/// Permission is hereby granted, free of charge, to any person obtaining a copy
6/// of this software and associated documentation files (the "Software"), to deal
7/// in the Software without restriction, including without limitation the rights
8/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9/// copies of the Software, and to permit persons to whom the Software is
10/// furnished to do so, subject to the following conditions:
11///
12/// The above copyright notice and this permission notice shall be included in
13/// all copies or substantial portions of the Software.
14///
15/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21/// THE SOFTWARE.
22///
23/// @ref gtx_rotate_vector
24/// @file glm/gtx/rotate_vector.hpp
25/// @date 2006-11-02 / 2011-06-07
26/// @author Christophe Riccio
27///
28/// @see core (dependence)
29/// @see gtx_transform (dependence)
30///
31/// @defgroup gtx_rotate_vector GLM_GTX_rotate_vector
32/// @ingroup gtx
33///
34/// @brief Function to directly rotate a vector
35///
36/// <glm/gtx/rotate_vector.hpp> need to be included to use these functionalities.
37///////////////////////////////////////////////////////////////////////////////////
38
39#ifndef GLM_GTX_rotate_vector
40#define GLM_GTX_rotate_vector
41
42// Dependency:
43#include "../glm.hpp"
44#include "../gtx/transform.hpp"
45
46#if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
47#	pragma message("GLM: GLM_GTX_rotate_vector extension included")
48#endif
49
50namespace glm
51{
52	/// @addtogroup gtx_rotate_vector
53	/// @{
54
55	//! Rotate a two dimensional vector.
56	//! From GLM_GTX_rotate_vector extension.
57	template <typename T, precision P>
58	GLM_FUNC_DECL detail::tvec2<T, P> rotate(
59		detail::tvec2<T, P> const & v,
60		T const & angle);
61
62	//! Rotate a three dimensional vector around an axis.
63	//! From GLM_GTX_rotate_vector extension.
64	template <typename T, precision P>
65	GLM_FUNC_DECL detail::tvec3<T, P> rotate(
66		detail::tvec3<T, P> const & v,
67		T const & angle,
68		detail::tvec3<T, P> const & normal);
69
70	//! Rotate a four dimensional vector around an axis.
71	//! From GLM_GTX_rotate_vector extension.
72	template <typename T, precision P>
73	GLM_FUNC_DECL detail::tvec4<T, P> rotate(
74		detail::tvec4<T, P> const & v,
75		T const & angle,
76		detail::tvec3<T, P> const & normal);
77
78	//! Rotate a three dimensional vector around the X axis.
79	//! From GLM_GTX_rotate_vector extension.
80	template <typename T, precision P>
81	GLM_FUNC_DECL detail::tvec3<T, P> rotateX(
82		detail::tvec3<T, P> const & v,
83		T const & angle);
84
85	//! Rotate a three dimensional vector around the Y axis.
86	//! From GLM_GTX_rotate_vector extension.
87	template <typename T, precision P>
88	GLM_FUNC_DECL detail::tvec3<T, P> rotateY(
89		detail::tvec3<T, P> const & v,
90		T const & angle);
91
92	//! Rotate a three dimensional vector around the Z axis.
93	//! From GLM_GTX_rotate_vector extension.
94	template <typename T, precision P>
95	GLM_FUNC_DECL detail::tvec3<T, P> rotateZ(
96		detail::tvec3<T, P> const & v,
97		T const & angle);
98
99	//! Rotate a four dimentionnals vector around the X axis.
100	//! From GLM_GTX_rotate_vector extension.
101	template <typename T, precision P>
102	GLM_FUNC_DECL detail::tvec4<T, P> rotateX(
103		detail::tvec4<T, P> const & v,
104		T const & angle);
105
106	//! Rotate a four dimensional vector around the X axis.
107	//! From GLM_GTX_rotate_vector extension.
108	template <typename T, precision P>
109	GLM_FUNC_DECL detail::tvec4<T, P> rotateY(
110		detail::tvec4<T, P> const & v,
111		T const & angle);
112
113	//! Rotate a four dimensional vector around the X axis.
114	//! From GLM_GTX_rotate_vector extension.
115	template <typename T, precision P>
116	GLM_FUNC_DECL detail::tvec4<T, P> rotateZ(
117		detail::tvec4<T, P> const & v,
118		T const & angle);
119
120	//! Build a rotation matrix from a normal and a up vector.
121	//! From GLM_GTX_rotate_vector extension.
122	template <typename T, precision P>
123	GLM_FUNC_DECL detail::tmat4x4<T, P> orientation(
124		detail::tvec3<T, P> const & Normal,
125		detail::tvec3<T, P> const & Up);
126
127	/// @}
128}//namespace glm
129
130#include "rotate_vector.inl"
131
132#endif//GLM_GTX_rotate_vector
133