glm/glm/gtx/vector_query.hpp

67 lines
2.2 KiB
C++

/// @ref gtx_vector_query
/// @file glm/gtx/vector_query.hpp
///
/// @see core (dependence)
///
/// @defgroup gtx_vector_query GLM_GTX_vector_query
/// @ingroup gtx
///
/// @brief Query informations of vector types
///
/// <glm/gtx/vector_query.hpp> need to be included to use these functionalities.
#pragma once
// Dependency:
#include "../glm.hpp"
#include <cfloat>
#include <limits>
#ifndef GLM_ENABLE_EXPERIMENTAL
# error "GLM: GLM_GTX_vector_query 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."
#endif
#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_GTX_vector_query extension included")
#endif
namespace glm
{
/// @addtogroup gtx_vector_query
/// @{
//! Check whether two vectors are collinears.
/// @see gtx_vector_query extensions.
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL bool areCollinear(vec<L, T, Q> const& v0, vec<L, T, Q> const& v1, T const& epsilon);
//! Check whether two vectors are orthogonals.
/// @see gtx_vector_query extensions.
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL bool areOrthogonal(vec<L, T, Q> const& v0, vec<L, T, Q> const& v1, T const& epsilon);
//! Check whether a vector is normalized.
/// @see gtx_vector_query extensions.
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL bool isNormalized(vec<L, T, Q> const& v, T const& epsilon);
//! Check whether a vector is null.
/// @see gtx_vector_query extensions.
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL bool isNull(vec<L, T, Q> const& v, T const& epsilon);
//! Check whether a each component of a vector is null.
/// @see gtx_vector_query extensions.
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL vec<L, bool, Q> isCompNull(vec<L, T, Q> const& v, T const& epsilon);
//! Check whether two vectors are orthonormal.
/// @see gtx_vector_query extensions.
template<length_t L, typename T, qualifier Q>
GLM_FUNC_DECL bool areOrthonormal(vec<L, T, Q> const& v0, vec<L, T, Q> const& v1, T const& epsilon);
/// @}
}// namespace glm
#include "vector_query.inl"