Crazy Eddies GUI System  0.7.8
CEGUIInterpolator.h
1 /***********************************************************************
2  filename: CEGUIInterpolator.h
3  created: 7/8/2010
4  author: Martin Preisler
5 
6  purpose: Defines the interface for the abstract Interpolator class
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to deal in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _CEGUIInterpolator_h_
31 #define _CEGUIInterpolator_h_
32 
33 #include "CEGUIBase.h"
34 
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
39 
54 class CEGUIEXPORT Interpolator
55 {
56 public:
58  virtual ~Interpolator(void) {};
59 
61  virtual const String& getType() const = 0;
62 
63  // interpolate methods aren't const, because the interpolator could provide
64  // some sort of caching mechanism if converting properties is too expensive
65  // that it is worth it
66 
70  virtual String interpolateAbsolute(const String& value1,
71  const String& value2,
72  float position) = 0;
73 
77  virtual String interpolateRelative(const String& base,
78  const String& value1,
79  const String& value2,
80  float position) = 0;
81 
85  virtual String interpolateRelativeMultiply(const String& base,
86  const String& value1,
87  const String& value2,
88  float position) = 0;
89 
90 };
91 
92 } // End of CEGUI namespace section
93 
94 #endif // end of guard _CEGUIInterpolator_h_
95