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_perpendicular
24 /// @file glm/gtx/perpendicular.hpp
25 /// @date 2005-12-21 / 2011-06-07
26 /// @author Christophe Riccio
27 ///
28 /// @see core (dependence)
29 /// @see gtx_projection (dependence)
30 ///
31 /// @defgroup gtx_perpendicular GLM_GTX_perpendicular
32 /// @ingroup gtx
33 ///
34 /// @brief Perpendicular of a vector from other one
35 ///
36 /// <glm/gtx/perpendicular.hpp> need to be included to use these functionalities.
37 ///////////////////////////////////////////////////////////////////////////////////
38 
39 #ifndef GLM_GTX_perpendicular
40 #define GLM_GTX_perpendicular
41 
42 // Dependency:
43 #include "../glm.hpp"
44 #include "../gtx/projection.hpp"
45 
46 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
47 #	pragma message("GLM: GLM_GTX_perpendicular extension included")
48 #endif
49 
50 namespace glm
51 {
52 	/// @addtogroup gtx_perpendicular
53 	/// @{
54 
55 	//! Projects x a perpendicular axis of Normal.
56 	//! From GLM_GTX_perpendicular extension.
57 	template <typename vecType>
58 	GLM_FUNC_DECL vecType perp(
59 		vecType const & x,
60 		vecType const & Normal);
61 
62 	/// @}
63 }//namespace glm
64 
65 #include "perpendicular.inl"
66 
67 #endif//GLM_GTX_perpendicular
68