• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_bit
24 /// @file glm/gtx/bit.hpp
25 /// @date 2005-12-30 / 2011-06-07
26 /// @author Christophe Riccio
27 ///
28 /// @see core (dependence)
29 ///
30 /// @defgroup gtx_closest_point GLM_GTX_closest_point
31 /// @ingroup gtx
32 ///
33 /// @brief Find the point on a straight line which is the closet of a point.
34 ///
35 /// <glm/gtx/closest_point.hpp> need to be included to use these functionalities.
36 ///////////////////////////////////////////////////////////////////////////////////
37 
38 #ifndef GLM_GTX_closest_point
39 #define GLM_GTX_closest_point
40 
41 // Dependency:
42 #include "../glm.hpp"
43 
44 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
45 #	pragma message("GLM: GLM_GTX_closest_point extension included")
46 #endif
47 
48 namespace glm
49 {
50 	/// @addtogroup gtx_closest_point
51 	/// @{
52 
53 	/// Find the point on a straight line which is the closet of a point.
54 	/// @see gtx_closest_point
55 	template <typename T, precision P>
56 	GLM_FUNC_DECL detail::tvec3<T, P> closestPointOnLine(
57 		detail::tvec3<T, P> const & point,
58 		detail::tvec3<T, P> const & a,
59 		detail::tvec3<T, P> const & b);
60 
61 	/// @}
62 }// namespace glm
63 
64 #include "closest_point.inl"
65 
66 #endif//GLM_GTX_closest_point
67