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_intersect
     24 /// @file glm/gtx/intersect.hpp
     25 /// @date 2007-04-03 / 2011-06-07
     26 /// @author Christophe Riccio
     27 ///
     28 /// @see core (dependence)
     29 /// @see gtx_closest_point (dependence)
     30 ///
     31 /// @defgroup gtx_intersect GLM_GTX_intersect
     32 /// @ingroup gtx
     33 ///
     34 /// @brief Add intersection functions
     35 ///
     36 /// <glm/gtx/intersect.hpp> need to be included to use these functionalities.
     37 ///////////////////////////////////////////////////////////////////////////////////
     38 
     39 #ifndef GLM_GTX_intersect
     40 #define GLM_GTX_intersect
     41 
     42 // Dependency:
     43 #include "../glm.hpp"
     44 #include "../gtx/closest_point.hpp"
     45 
     46 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
     47 #	pragma message("GLM: GLM_GTX_closest_point extension included")
     48 #endif
     49 
     50 namespace glm
     51 {
     52 	/// @addtogroup gtx_intersect
     53 	/// @{
     54 
     55 	//! Compute the intersection of a ray and a triangle.
     56 	//! Ray direction and plane normal must be unit length.
     57 	//! From GLM_GTX_intersect extension.
     58 	template <typename genType>
     59 	GLM_FUNC_DECL bool intersectRayPlane(
     60 		genType const & orig, genType const & dir,
     61 		genType const & planeOrig, genType const & planeNormal,
     62 		typename genType::value_type & intersectionDistance);
     63 
     64 	//! Compute the intersection of a ray and a triangle.
     65 	//! From GLM_GTX_intersect extension.
     66 	template <typename genType>
     67 	GLM_FUNC_DECL bool intersectRayTriangle(
     68 		genType const & orig, genType const & dir,
     69 		genType const & vert0, genType const & vert1, genType const & vert2,
     70 		genType & baryPosition);
     71 
     72 	//! Compute the intersection of a line and a triangle.
     73 	//! From GLM_GTX_intersect extension.
     74 	template <typename genType>
     75 	GLM_FUNC_DECL bool intersectLineTriangle(
     76 		genType const & orig, genType const & dir,
     77 		genType const & vert0, genType const & vert1, genType const & vert2,
     78 		genType & position);
     79 
     80 	//! Compute the intersection distance of a ray and a sphere.
     81 	//! The ray direction vector is unit length.
     82 	//! From GLM_GTX_intersect extension.
     83 	template <typename genType>
     84 	GLM_FUNC_DECL bool intersectRaySphere(
     85 		genType const & rayStarting, genType const & rayNormalizedDirection,
     86 		genType const & sphereCenter, typename genType::value_type const sphereRadiusSquered,
     87 		typename genType::value_type & intersectionDistance);
     88 
     89 	//! Compute the intersection of a ray and a sphere.
     90 	//! From GLM_GTX_intersect extension.
     91 	template <typename genType>
     92 	GLM_FUNC_DECL bool intersectRaySphere(
     93 		genType const & rayStarting, genType const & rayNormalizedDirection,
     94 		genType const & sphereCenter, const typename genType::value_type sphereRadius,
     95 		genType & intersectionPosition, genType & intersectionNormal);
     96 
     97 	//! Compute the intersection of a line and a sphere.
     98 	//! From GLM_GTX_intersect extension
     99 	template <typename genType>
    100 	GLM_FUNC_DECL bool intersectLineSphere(
    101 		genType const & point0, genType const & point1,
    102 		genType const & sphereCenter, typename genType::value_type sphereRadius,
    103 		genType & intersectionPosition1, genType & intersectionNormal1,
    104 		genType & intersectionPosition2 = genType(), genType & intersectionNormal2 = genType());
    105 
    106 	/// @}
    107 }//namespace glm
    108 
    109 #include "intersect.inl"
    110 
    111 #endif//GLM_GTX_intersect
    112