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_polar_coordinates
24 /// @file glm/gtx/polar_coordinates.hpp
25 /// @date 2007-03-06 / 2011-06-07
26 /// @author Christophe Riccio
27 ///
28 /// @see core (dependence)
29 ///
30 /// @defgroup gtx_polar_coordinates GLM_GTX_polar_coordinates
31 /// @ingroup gtx
32 ///
33 /// @brief Conversion from Euclidean space to polar space and revert.
34 ///
35 /// <glm/gtx/polar_coordinates.hpp> need to be included to use these functionalities.
36 ///////////////////////////////////////////////////////////////////////////////////
37 
38 #ifndef GLM_GTX_polar_coordinates
39 #define GLM_GTX_polar_coordinates
40 
41 // Dependency:
42 #include "../glm.hpp"
43 
44 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
45 #	pragma message("GLM: GLM_GTX_polar_coordinates extension included")
46 #endif
47 
48 namespace glm
49 {
50 	/// @addtogroup gtx_polar_coordinates
51 	/// @{
52 
53 	/// Convert Euclidean to Polar coordinates, x is the xz distance, y, the latitude and z the longitude.
54 	///
55 	/// @see gtx_polar_coordinates
56 	template <typename T, precision P>
57 	GLM_FUNC_DECL detail::tvec3<T, P> polar(
58 		detail::tvec3<T, P> const & euclidean);
59 
60 	/// Convert Polar to Euclidean coordinates.
61 	///
62 	/// @see gtx_polar_coordinates
63 	template <typename T, precision P>
64 	GLM_FUNC_DECL detail::tvec3<T, P> euclidean(
65 		detail::tvec2<T, P> const & polar);
66 
67 	/// @}
68 }//namespace glm
69 
70 #include "polar_coordinates.inl"
71 
72 #endif//GLM_GTX_polar_coordinates
73