Home | History | Annotate | Download | only in gtx
      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_vector_angle
     24 /// @file glm/gtx/vector_angle.hpp
     25 /// @date 2005-12-30 / 2011-06-07
     26 /// @author Christophe Riccio
     27 ///
     28 /// @see core (dependence)
     29 /// @see gtx_quaternion (dependence)
     30 /// @see gtx_epsilon (dependence)
     31 ///
     32 /// @defgroup gtx_vector_angle GLM_GTX_vector_angle
     33 /// @ingroup gtx
     34 ///
     35 /// @brief Compute angle between vectors
     36 ///
     37 /// <glm/gtx/vector_angle.hpp> need to be included to use these functionalities.
     38 ///////////////////////////////////////////////////////////////////////////////////
     39 
     40 #ifndef GLM_GTX_vector_angle
     41 #define GLM_GTX_vector_angle
     42 
     43 // Dependency:
     44 #include "../glm.hpp"
     45 #include "../gtc/epsilon.hpp"
     46 #include "../gtx/quaternion.hpp"
     47 #include "../gtx/rotate_vector.hpp"
     48 
     49 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
     50 #	pragma message("GLM: GLM_GTX_vector_angle extension included")
     51 #endif
     52 
     53 namespace glm
     54 {
     55 	/// @addtogroup gtx_vector_angle
     56 	/// @{
     57 
     58 	//! Returns the absolute angle between two vectors
     59 	//! Parameters need to be normalized.
     60 	/// @see gtx_vector_angle extension
     61 	template <typename vecType>
     62 	GLM_FUNC_DECL typename vecType::value_type angle(
     63 		vecType const & x,
     64 		vecType const & y);
     65 
     66 	//! Returns the oriented angle between two 2d vectors
     67 	//! Parameters need to be normalized.
     68 	/// @see gtx_vector_angle extension.
     69 	template <typename T, precision P>
     70 	GLM_FUNC_DECL T orientedAngle(
     71 		detail::tvec2<T, P> const & x,
     72 		detail::tvec2<T, P> const & y);
     73 
     74 	//! Returns the oriented angle between two 3d vectors based from a reference axis.
     75 	//! Parameters need to be normalized.
     76 	/// @see gtx_vector_angle extension.
     77 	template <typename T, precision P>
     78 	GLM_FUNC_DECL T orientedAngle(
     79 		detail::tvec3<T, P> const & x,
     80 		detail::tvec3<T, P> const & y,
     81 		detail::tvec3<T, P> const & ref);
     82 
     83 	/// @}
     84 }// namespace glm
     85 
     86 #include "vector_angle.inl"
     87 
     88 #endif//GLM_GTX_vector_angle
     89