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_normalize_dot
24 /// @file glm/gtx/normalize_dot.hpp
25 /// @date 2007-09-28 / 2011-06-07
26 /// @author Christophe Riccio
27 ///
28 /// @see core (dependence)
29 /// @see gtx_fast_square_root (dependence)
30 ///
31 /// @defgroup gtx_normalize_dot GLM_GTX_normalize_dot
32 /// @ingroup gtx
33 ///
34 /// @brief Dot product of vectors that need to be normalize with a single square root.
35 ///
36 /// <glm/gtx/normalized_dot.hpp> need to be included to use these functionalities.
37 ///////////////////////////////////////////////////////////////////////////////////
38 
39 #ifndef GLM_GTX_normalize_dot
40 #define GLM_GTX_normalize_dot
41 
42 // Dependency:
43 #include "../glm.hpp"
44 #include "../gtx/fast_square_root.hpp"
45 
46 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
47 #	pragma message("GLM: GLM_GTX_normalize_dot extension included")
48 #endif
49 
50 namespace glm
51 {
52 	/// @addtogroup gtx_normalize_dot
53 	/// @{
54 
55 	//! Normalize parameters and returns the dot product of x and y.
56 	//! It's faster that dot(normalize(x), normalize(y)).
57 	//! From GLM_GTX_normalize_dot extension.
58 	template <typename genType>
59 	GLM_FUNC_DECL typename genType::value_type normalizeDot(
60 		genType const & x,
61 		genType const & y);
62 
63 	//! Normalize parameters and returns the dot product of x and y.
64 	//! Faster that dot(fastNormalize(x), fastNormalize(y)).
65 	//! From GLM_GTX_normalize_dot extension.
66 	template <typename genType>
67 	GLM_FUNC_DECL typename genType::value_type fastNormalizeDot(
68 		genType const & x,
69 		genType const & y);
70 
71 	/// @}
72 }//namespace glm
73 
74 #include "normalize_dot.inl"
75 
76 #endif//GLM_GTX_normalize_dot
77