/glm/gtx/spline.hpp

 1///////////////////////////////////////////////////////////////////////////////////
 2/// OpenGL Mathematics (glm.g-truc.net)
 3///
 4/// Copyright (c) 2005 - 2012 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_spline
24/// @file glm/gtx/spline.hpp
25/// @date 2007-01-25 / 2011-06-07
26/// @author Christophe Riccio
27///
28/// @see core (dependence)
29///
30/// @defgroup gtx_spline GLM_GTX_spline: Spline
31/// @ingroup gtx
32/// 
33/// @brief Spline functions
34/// 
35/// <glm/gtx/spline.hpp> need to be included to use these functionalities.
36///////////////////////////////////////////////////////////////////////////////////
37
38#ifndef GLM_GTX_spline
39#define GLM_GTX_spline GLM_VERSION
40
41// Dependency:
42#include "../glm.hpp"
43#include "../gtx/optimum_pow.hpp"
44
45#if(defined(GLM_MESSAGES) && !defined(glm_ext))
46#	pragma message("GLM: GLM_GTX_spline extension included")
47#endif
48
49namespace glm
50{
51	/// @addtogroup gtx_spline
52	/// @{
53
54	//! Return a point from a catmull rom curve.
55	//! From GLM_GTX_spline extension.
56	template <typename genType> 
57	genType catmullRom(
58		genType const & v1, 
59		genType const & v2, 
60		genType const & v3, 
61		genType const & v4, 
62		typename genType::value_type const & s);
63		
64	//! Return a point from a hermite curve.
65	//! From GLM_GTX_spline extension.
66    template <typename genType> 
67	genType hermite(
68		genType const & v1, 
69		genType const & t1, 
70		genType const & v2, 
71		genType const & t2, 
72		typename genType::value_type const & s);
73		
74    //! Return a point from a cubic curve. 
75	//! From GLM_GTX_spline extension.
76	template <typename genType> 
77	genType cubic(
78		genType const & v1, 
79		genType const & v2, 
80		genType const & v3, 
81		genType const & v4, 
82		typename genType::value_type const & s);
83
84	/// @}
85}//namespace glm
86
87#include "spline.inl"
88
89#endif//GLM_GTX_spline
90