vector_angle.hpp 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. /// @ref gtx_vector_angle
  2. /// @file glm/gtx/vector_angle.hpp
  3. ///
  4. /// @see core (dependence)
  5. /// @see gtx_quaternion (dependence)
  6. /// @see gtx_epsilon (dependence)
  7. ///
  8. /// @defgroup gtx_vector_angle GLM_GTX_vector_angle
  9. /// @ingroup gtx
  10. ///
  11. /// Include <glm/gtx/vector_angle.hpp> to use the features of this extension.
  12. ///
  13. /// Compute angle between vectors
  14. #pragma once
  15. // Dependency:
  16. #include "../glm.hpp"
  17. #include "../gtc/epsilon.hpp"
  18. #include "../gtx/quaternion.hpp"
  19. #include "../gtx/rotate_vector.hpp"
  20. #ifndef GLM_ENABLE_EXPERIMENTAL
  21. # error "GLM: GLM_GTX_vector_angle is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."
  22. #elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  23. # pragma message("GLM: GLM_GTX_vector_angle extension included")
  24. #endif
  25. namespace glm
  26. {
  27. /// @addtogroup gtx_vector_angle
  28. /// @{
  29. //! Returns the absolute angle between two vectors.
  30. //! Parameters need to be normalized.
  31. /// @see gtx_vector_angle extension.
  32. template<length_t L, typename T, qualifier Q>
  33. GLM_FUNC_DECL T angle(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
  34. //! Returns the oriented angle between two 2d vectors.
  35. //! Parameters need to be normalized.
  36. /// @see gtx_vector_angle extension.
  37. template<typename T, qualifier Q>
  38. GLM_FUNC_DECL T orientedAngle(vec<2, T, Q> const& x, vec<2, T, Q> const& y);
  39. //! Returns the oriented angle between two 3d vectors based from a reference axis.
  40. //! Parameters need to be normalized.
  41. /// @see gtx_vector_angle extension.
  42. template<typename T, qualifier Q>
  43. GLM_FUNC_DECL T orientedAngle(vec<3, T, Q> const& x, vec<3, T, Q> const& y, vec<3, T, Q> const& ref);
  44. /// @}
  45. }// namespace glm
  46. #include "vector_angle.inl"