Cortex  10.0.0-a4
Spline.h
1 //
3 // Copyright (c) 2008-2011, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECORE_SPLINE_H
36 #define IECORE_SPLINE_H
37 
38 #include "IECore/CubicBasis.h"
39 
40 #include "OpenEXR/ImathColor.h"
41 
42 #include "boost/numeric/interval.hpp"
43 
44 #include <map>
45 
46 namespace IECore
47 {
48 
52 template<typename X, typename Y>
53 class Spline
54 {
55 
56  public :
57 
58  typedef X XType;
59  typedef Y YType;
60  typedef boost::numeric::interval<XType> XInterval;
61 
62  typedef CubicBasis<XType> Basis;
63  typedef std::multimap<X, Y> PointContainer;
64  typedef typename PointContainer::value_type Point;
65 
69  Basis basis;
70  PointContainer points;
71 
72  Spline( const Basis &basis=Basis::catmullRom() );
73  Spline( const Basis &basis, const PointContainer &points );
74 
76  XInterval interval() const;
77 
83  inline X solve( X x, typename PointContainer::const_iterator &segment ) const;
85  inline X solve( X x, Y segment[4] ) const;
86 
88  inline Y operator() ( X x ) const;
89 
91  inline Y derivative( X x ) const;
92 
94  inline Y integral( X x0, X x1 ) const;
95 
97  inline Y integral() const;
98 
99  inline bool operator==( const Spline &rhs ) const;
100  inline bool operator!=( const Spline &rhs ) const;
101 
102  private :
103 
104  inline Y integral( X t0, X t1, typename PointContainer::const_iterator segment ) const;
105  inline Y integral( X t0, typename PointContainer::const_iterator segment0, X t1, typename PointContainer::const_iterator segment1 ) const;
106  inline typename PointContainer::const_iterator lastValidSegment() const;
107 };
108 
111 
114 
115 } // namespace IECore
116 
117 #include "IECore/Spline.inl"
118 
119 #endif // IECORE_SPLINE_H
Y operator()(X x) const
Uses solve() to evaluate the y value for a given x position.
Y integral() const
Returns the integral Y with respect to X over the spline domain.
Definition: Spline.h:53
XInterval interval() const
Returns the range of the spline in the X direction.
X solve(X x, typename PointContainer::const_iterator &segment) const
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43
Y derivative(X x) const
Returns dY/dX at given X.
Basis basis
Definition: Spline.h:69