File: classCEGUI_1_1Interpolator.html

package info (click to toggle)
cegui-mk2 0.7.6-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 105,384 kB
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (242 lines) | stat: -rw-r--r-- 19,598 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::Interpolator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1Interpolator.html">Interpolator</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::Interpolator Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Interpolator" -->
<p>Defines a 'interpolator' class.  
 <a href="classCEGUI_1_1Interpolator.html#details">More...</a></p>

<p>Inherited by <a class="el" href="classCEGUI_1_1BoolInterpolator.html">CEGUI::BoolInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourInterpolator.html">CEGUI::ColourInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourRectInterpolator.html">CEGUI::ColourRectInterpolator</a>, <a class="el" href="classCEGUI_1_1FloatInterpolator.html">CEGUI::FloatInterpolator</a>, <a class="el" href="classCEGUI_1_1IntInterpolator.html">CEGUI::IntInterpolator</a>, <a class="el" href="classCEGUI_1_1PointInterpolator.html">CEGUI::PointInterpolator</a>, <a class="el" href="classCEGUI_1_1RectInterpolator.html">CEGUI::RectInterpolator</a>, <a class="el" href="classCEGUI_1_1SizeInterpolator.html">CEGUI::SizeInterpolator</a>, <a class="el" href="classCEGUI_1_1StringInterpolator.html">CEGUI::StringInterpolator</a>, <a class="el" href="classCEGUI_1_1UBoxInterpolator.html">CEGUI::UBoxInterpolator</a>, <a class="el" href="classCEGUI_1_1UDimInterpolator.html">CEGUI::UDimInterpolator</a>, <a class="el" href="classCEGUI_1_1UintInterpolator.html">CEGUI::UintInterpolator</a>, <a class="el" href="classCEGUI_1_1URectInterpolator.html">CEGUI::URectInterpolator</a>, <a class="el" href="classCEGUI_1_1UVector2Interpolator.html">CEGUI::UVector2Interpolator</a>, and <a class="el" href="classCEGUI_1_1Vector3Interpolator.html">CEGUI::Vector3Interpolator</a>.</p>

<p><a href="classCEGUI_1_1Interpolator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21c65f81765f06d743e857ce80c34945"></a><!-- doxytag: member="CEGUI::Interpolator::~Interpolator" ref="a21c65f81765f06d743e857ce80c34945" args="(void)" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Interpolator.html#a21c65f81765f06d743e857ce80c34945">~Interpolator</a> (void)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67e805cf1f2331b17ee8949613871923"></a><!-- doxytag: member="CEGUI::Interpolator::getType" ref="a67e805cf1f2331b17ee8949613871923" args="() const =0" -->
virtual const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Interpolator.html#a67e805cf1f2331b17ee8949613871923">getType</a> () const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns type string of this interpolator <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Interpolator.html#a1db29290bea554db224ed8c0b8fe4964">interpolateAbsolute</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value1, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value2, float position)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Interpolator.html#a988f81d414ecb96f7048c04dbcbc5a7d">interpolateRelative</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;base, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value1, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value2, float position)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Interpolator.html#abeba824f60ef5a0137a866535730b7a8">interpolateRelativeMultiply</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;base, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value1, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;value2, float position)=0</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines a 'interpolator' class. </p>
<p><a class="el" href="classCEGUI_1_1Interpolator.html" title="Defines a &#39;interpolator&#39; class.">Interpolator</a> allows you to interpolate between 2 properties. You can jut pass them as strings and <a class="el" href="classCEGUI_1_1Interpolator.html" title="Defines a &#39;interpolator&#39; class.">Interpolator</a> does everything for you.</p>
<p>If you want to define your own interpolator, inherit this class and add it to <a class="el" href="classCEGUI_1_1AnimationManager.html">AnimationManager</a> via <a class="el" href="classCEGUI_1_1AnimationManager.html#a472c448c3924d3974b58c10d8ca7939d" title="Adds interpolator to be available for Affectors.">AnimationManager::addInterpolator</a> to make it available for animations.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classCEGUI_1_1AnimationManager.html">AnimationManager</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1db29290bea554db224ed8c0b8fe4964"></a><!-- doxytag: member="CEGUI::Interpolator::interpolateAbsolute" ref="a1db29290bea554db224ed8c0b8fe4964" args="(const String &amp;value1, const String &amp;value2, float position)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::Interpolator::interpolateAbsolute </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>value1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>value2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>position</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>this is used when <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an &#39;affector&#39; class.">Affector</a> is set to apply values in absolute mode (application method == AM_Absolute) </p>

<p>Implemented in <a class="el" href="classCEGUI_1_1StringInterpolator.html#aa83ace99945cc86d75552e81f8c86c63">CEGUI::StringInterpolator</a>, <a class="el" href="classCEGUI_1_1FloatInterpolator.html#addf5ad07b88aaddeb0c3188dbc536d32">CEGUI::FloatInterpolator</a>, <a class="el" href="classCEGUI_1_1UintInterpolator.html#aa7d64b2e903c8fba5bd03247c912843a">CEGUI::UintInterpolator</a>, <a class="el" href="classCEGUI_1_1IntInterpolator.html#a37bfc4a3c577300b5998f86e43391f23">CEGUI::IntInterpolator</a>, <a class="el" href="classCEGUI_1_1BoolInterpolator.html#addef4011ba5b58c9d0dd2dfe1c32e5ef">CEGUI::BoolInterpolator</a>, <a class="el" href="classCEGUI_1_1SizeInterpolator.html#acda2557603c1145b7c0c9502c20cbdca">CEGUI::SizeInterpolator</a>, <a class="el" href="classCEGUI_1_1PointInterpolator.html#ad02950ee420e8a1aef5bd65afc0dd3d9">CEGUI::PointInterpolator</a>, <a class="el" href="classCEGUI_1_1Vector3Interpolator.html#adaed5f687524d7a502cabe70c4ceb0d3">CEGUI::Vector3Interpolator</a>, <a class="el" href="classCEGUI_1_1RectInterpolator.html#a3a6637b9867aef7371719bdfde0c0b75">CEGUI::RectInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourInterpolator.html#a50c07a32e75a1dfe2b3055c554704505">CEGUI::ColourInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourRectInterpolator.html#a3c9182fd8fbcf99f6b42338caa2d3ca3">CEGUI::ColourRectInterpolator</a>, <a class="el" href="classCEGUI_1_1UDimInterpolator.html#abc286dc06189058e51f0af0515383654">CEGUI::UDimInterpolator</a>, <a class="el" href="classCEGUI_1_1UVector2Interpolator.html#a205de8fb473c13a8c658d0c7cd411fe6">CEGUI::UVector2Interpolator</a>, <a class="el" href="classCEGUI_1_1URectInterpolator.html#af7d49a4c6ec7b0a869d653869ee598e0">CEGUI::URectInterpolator</a>, and <a class="el" href="classCEGUI_1_1UBoxInterpolator.html#a5320c03fec1028787fdf05fa47d4c04d">CEGUI::UBoxInterpolator</a>.</p>

</div>
</div>
<a class="anchor" id="a988f81d414ecb96f7048c04dbcbc5a7d"></a><!-- doxytag: member="CEGUI::Interpolator::interpolateRelative" ref="a988f81d414ecb96f7048c04dbcbc5a7d" args="(const String &amp;base, const String &amp;value1, const String &amp;value2, float position)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::Interpolator::interpolateRelative </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>value1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>value2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>position</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>this is used when <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an &#39;affector&#39; class.">Affector</a> is set to apply values in relative mode (application method == AM_Relative) </p>

<p>Implemented in <a class="el" href="classCEGUI_1_1StringInterpolator.html#ae24375cf956b967c170bdaeccddbb536">CEGUI::StringInterpolator</a>, <a class="el" href="classCEGUI_1_1FloatInterpolator.html#a55442a7b3528101589b7552b17a89a30">CEGUI::FloatInterpolator</a>, <a class="el" href="classCEGUI_1_1UintInterpolator.html#a56d585877459df5842d4b4f19456fdd2">CEGUI::UintInterpolator</a>, <a class="el" href="classCEGUI_1_1IntInterpolator.html#afa0aa11a13e4e35c308f9d19e88fc911">CEGUI::IntInterpolator</a>, <a class="el" href="classCEGUI_1_1BoolInterpolator.html#ab7b194d6357b0d751fbc17da34e5da7c">CEGUI::BoolInterpolator</a>, <a class="el" href="classCEGUI_1_1SizeInterpolator.html#a5bc4a52a3fe224437524640d8d9ca7e8">CEGUI::SizeInterpolator</a>, <a class="el" href="classCEGUI_1_1PointInterpolator.html#a414d6858184cd04275854cf43046aa63">CEGUI::PointInterpolator</a>, <a class="el" href="classCEGUI_1_1Vector3Interpolator.html#a5abfa49ee35969346bdcf1e980d730b3">CEGUI::Vector3Interpolator</a>, <a class="el" href="classCEGUI_1_1RectInterpolator.html#a71580082a05c6fed2811d69d27a9ddb2">CEGUI::RectInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourInterpolator.html#a6c89ba7cdce96c2804a6faddf332adfb">CEGUI::ColourInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourRectInterpolator.html#a8114b31f3f8fe8addbc638ce33ab5569">CEGUI::ColourRectInterpolator</a>, <a class="el" href="classCEGUI_1_1UDimInterpolator.html#adfacdeca33f8bc1ea8f5ae705bbf9a07">CEGUI::UDimInterpolator</a>, <a class="el" href="classCEGUI_1_1UVector2Interpolator.html#a29c5123a1bd11cce08d457e16d063f8a">CEGUI::UVector2Interpolator</a>, <a class="el" href="classCEGUI_1_1URectInterpolator.html#aa28d371a7bf0613aba4344ecede68fc5">CEGUI::URectInterpolator</a>, and <a class="el" href="classCEGUI_1_1UBoxInterpolator.html#a3f0eb46f74e564f7defa98f8f2b86f08">CEGUI::UBoxInterpolator</a>.</p>

</div>
</div>
<a class="anchor" id="abeba824f60ef5a0137a866535730b7a8"></a><!-- doxytag: member="CEGUI::Interpolator::interpolateRelativeMultiply" ref="abeba824f60ef5a0137a866535730b7a8" args="(const String &amp;base, const String &amp;value1, const String &amp;value2, float position)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::Interpolator::interpolateRelativeMultiply </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>value1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>value2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>position</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>this is used when <a class="el" href="classCEGUI_1_1Affector.html" title="Defines an &#39;affector&#39; class.">Affector</a> is set to apply values in relative multiply mode (application method == AM_RelativeMultiply) </p>

<p>Implemented in <a class="el" href="classCEGUI_1_1StringInterpolator.html#a03fb1bb743f91a44abd947ecb261a05e">CEGUI::StringInterpolator</a>, <a class="el" href="classCEGUI_1_1FloatInterpolator.html#ac72d33a1cc7f986e9c26b80949bc059a">CEGUI::FloatInterpolator</a>, <a class="el" href="classCEGUI_1_1UintInterpolator.html#ae8f8ff5ce123d42142134d88f348b5f0">CEGUI::UintInterpolator</a>, <a class="el" href="classCEGUI_1_1IntInterpolator.html#a8a12126f630d2086e2734aae43d46270">CEGUI::IntInterpolator</a>, <a class="el" href="classCEGUI_1_1BoolInterpolator.html#ab2734b06e4821985c4f25f9f150db3dd">CEGUI::BoolInterpolator</a>, <a class="el" href="classCEGUI_1_1SizeInterpolator.html#a9884760c25549fbd7bb901e8b37015bd">CEGUI::SizeInterpolator</a>, <a class="el" href="classCEGUI_1_1PointInterpolator.html#a3c8b14a1201bfdb925d7559633377ef1">CEGUI::PointInterpolator</a>, <a class="el" href="classCEGUI_1_1Vector3Interpolator.html#a601547a3d04cf8a5ebae16f96163296f">CEGUI::Vector3Interpolator</a>, <a class="el" href="classCEGUI_1_1RectInterpolator.html#ac3ed42ec5af87a8710b436b626f74156">CEGUI::RectInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourInterpolator.html#ad284eb988a536c04dcb516630dab129b">CEGUI::ColourInterpolator</a>, <a class="el" href="classCEGUI_1_1ColourRectInterpolator.html#a85c11376e808bad00d6604f13a61d0b7">CEGUI::ColourRectInterpolator</a>, <a class="el" href="classCEGUI_1_1UDimInterpolator.html#a3c7f2f22ed560940299290664e99f68a">CEGUI::UDimInterpolator</a>, <a class="el" href="classCEGUI_1_1UVector2Interpolator.html#abd06c3ed76174f063281f4dbd0c2b586">CEGUI::UVector2Interpolator</a>, <a class="el" href="classCEGUI_1_1URectInterpolator.html#a3f0b4bc379bd74d6487652b68b9b60a7">CEGUI::URectInterpolator</a>, and <a class="el" href="classCEGUI_1_1UBoxInterpolator.html#a85330ded90e289672c7c5cbdb1f29443">CEGUI::UBoxInterpolator</a>.</p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>