1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::SimpleSpline class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
4 | <link type="text/css" rel="stylesheet" href="style.css"> |
---|
5 | </head> |
---|
6 | |
---|
7 | <body> |
---|
8 | <!-- Generated by Doxygen 1.3.6 --> |
---|
9 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>Ogre::SimpleSpline Class Reference</h1>A very simple spline class which implements the Catmull-Rom class of splines. |
---|
11 | <a href="#_details">More...</a> |
---|
12 | <p> |
---|
13 | <code>#include <<a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a>></code> |
---|
14 | <p> |
---|
15 | <a href="classOgre_1_1SimpleSpline-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
---|
16 | <tr><td></td></tr> |
---|
17 | <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
---|
18 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea0">SimpleSpline</a> ()</td></tr> |
---|
19 | |
---|
20 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea1">~SimpleSpline</a> ()</td></tr> |
---|
21 | |
---|
22 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea2">addPoint</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &p)</td></tr> |
---|
23 | |
---|
24 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a control point to the end of the spline. <a href="#Ogre_1_1SimpleSplinea2"></a><br><br></td></tr> |
---|
25 | <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea3">getPoint</a> (unsigned short index) const </td></tr> |
---|
26 | |
---|
27 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the detail of one of the control points of the spline. <a href="#Ogre_1_1SimpleSplinea3"></a><br><br></td></tr> |
---|
28 | <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned short </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea4">getNumPoints</a> (void) const </td></tr> |
---|
29 | |
---|
30 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of control points in the spline. <a href="#Ogre_1_1SimpleSplinea4"></a><br><br></td></tr> |
---|
31 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea5">clear</a> (void)</td></tr> |
---|
32 | |
---|
33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Clears all the points in the spline. <a href="#Ogre_1_1SimpleSplinea5"></a><br><br></td></tr> |
---|
34 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea6">updatePoint</a> (unsigned short index, const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &value)</td></tr> |
---|
35 | |
---|
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Updates a single point in the spline. <a href="#Ogre_1_1SimpleSplinea6"></a><br><br></td></tr> |
---|
37 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea7">interpolate</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> t)</td></tr> |
---|
38 | |
---|
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an interpolated point based on a parametric value over the whole series. <a href="#Ogre_1_1SimpleSplinea7"></a><br><br></td></tr> |
---|
40 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea8">interpolate</a> (unsigned int fromIndex, <a class="el" href="namespaceOgre.html#a465">Real</a> t)</td></tr> |
---|
41 | |
---|
42 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Interpolates a single segment of the spline given a parametric value. <a href="#Ogre_1_1SimpleSplinea8"></a><br><br></td></tr> |
---|
43 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea9">setAutoCalculate</a> (bool autoCalc)</td></tr> |
---|
44 | |
---|
45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the spline whether it should automatically calculate tangents on demand as points are added. <a href="#Ogre_1_1SimpleSplinea9"></a><br><br></td></tr> |
---|
46 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinea10">recalcTangents</a> (void)</td></tr> |
---|
47 | |
---|
48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Recalculates the tangents associated with this spline. <a href="#Ogre_1_1SimpleSplinea10"></a><br><br></td></tr> |
---|
49 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
50 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep0">mAutoCalc</a></td></tr> |
---|
51 | |
---|
52 | <tr><td class="memItemLeft" nowrap align=right valign=top>std::vector< <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep1">mPoints</a></td></tr> |
---|
53 | |
---|
54 | <tr><td class="memItemLeft" nowrap align=right valign=top>std::vector< <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep2">mTangents</a></td></tr> |
---|
55 | |
---|
56 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep3">mCoeffs</a></td></tr> |
---|
57 | |
---|
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Matrix of coefficients. <a href="#Ogre_1_1SimpleSplinep3"></a><br><br></td></tr> |
---|
59 | </table> |
---|
60 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
61 | A very simple spline class which implements the Catmull-Rom class of splines. |
---|
62 | <p> |
---|
63 | <dl compact><dt><b>Remarks:</b></dt><dd>Splines are bendy lines. You define a series of points, and the spline forms a smoother line between the points to eliminate the sharp angles. </dd></dl> |
---|
64 | <dl compact><dt><b></b></dt><dd>Catmull-Rom splines are a specialisation of the general Hermite spline. With a Hermite spline, you define the start and end point of the line, and 2 tangents, one at the start of the line and one at the end. The Catmull-Rom spline simplifies this by just asking you to define a series of points, and the tangents are created for you. </dd></dl> |
---|
65 | |
---|
66 | <p> |
---|
67 | |
---|
68 | <p> |
---|
69 | Definition at line <a class="el" href="OgreSimpleSpline_8h-source.html#l00047">47</a> of file <a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> |
---|
70 | <a class="anchor" name="Ogre_1_1SimpleSplinea0" doxytag="Ogre::SimpleSpline::SimpleSpline" ></a><p> |
---|
71 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
72 | <tr> |
---|
73 | <td class="mdRow"> |
---|
74 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
75 | <tr> |
---|
76 | <td class="md" nowrap valign="top"> Ogre::SimpleSpline::SimpleSpline </td> |
---|
77 | <td class="md" valign="top">( </td> |
---|
78 | <td class="mdname1" valign="top" nowrap> </td> |
---|
79 | <td class="md" valign="top"> ) </td> |
---|
80 | <td class="md" nowrap></td> |
---|
81 | </tr> |
---|
82 | |
---|
83 | </table> |
---|
84 | </td> |
---|
85 | </tr> |
---|
86 | </table> |
---|
87 | <table cellspacing=5 cellpadding=0 border=0> |
---|
88 | <tr> |
---|
89 | <td> |
---|
90 | |
---|
91 | </td> |
---|
92 | <td> |
---|
93 | |
---|
94 | <p> |
---|
95 | </td> |
---|
96 | </tr> |
---|
97 | </table> |
---|
98 | <a class="anchor" name="Ogre_1_1SimpleSplinea1" doxytag="Ogre::SimpleSpline::~SimpleSpline" ></a><p> |
---|
99 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
100 | <tr> |
---|
101 | <td class="mdRow"> |
---|
102 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
103 | <tr> |
---|
104 | <td class="md" nowrap valign="top"> Ogre::SimpleSpline::~<a class="el" href="classOgre_1_1SimpleSpline.html">SimpleSpline</a> </td> |
---|
105 | <td class="md" valign="top">( </td> |
---|
106 | <td class="mdname1" valign="top" nowrap> </td> |
---|
107 | <td class="md" valign="top"> ) </td> |
---|
108 | <td class="md" nowrap></td> |
---|
109 | </tr> |
---|
110 | |
---|
111 | </table> |
---|
112 | </td> |
---|
113 | </tr> |
---|
114 | </table> |
---|
115 | <table cellspacing=5 cellpadding=0 border=0> |
---|
116 | <tr> |
---|
117 | <td> |
---|
118 | |
---|
119 | </td> |
---|
120 | <td> |
---|
121 | |
---|
122 | <p> |
---|
123 | </td> |
---|
124 | </tr> |
---|
125 | </table> |
---|
126 | <hr><h2>Member Function Documentation</h2> |
---|
127 | <a class="anchor" name="Ogre_1_1SimpleSplinea2" doxytag="Ogre::SimpleSpline::addPoint" ></a><p> |
---|
128 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
129 | <tr> |
---|
130 | <td class="mdRow"> |
---|
131 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
132 | <tr> |
---|
133 | <td class="md" nowrap valign="top"> void Ogre::SimpleSpline::addPoint </td> |
---|
134 | <td class="md" valign="top">( </td> |
---|
135 | <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td> |
---|
136 | <td class="mdname1" valign="top" nowrap> <em>p</em> </td> |
---|
137 | <td class="md" valign="top"> ) </td> |
---|
138 | <td class="md" nowrap></td> |
---|
139 | </tr> |
---|
140 | |
---|
141 | </table> |
---|
142 | </td> |
---|
143 | </tr> |
---|
144 | </table> |
---|
145 | <table cellspacing=5 cellpadding=0 border=0> |
---|
146 | <tr> |
---|
147 | <td> |
---|
148 | |
---|
149 | </td> |
---|
150 | <td> |
---|
151 | |
---|
152 | <p> |
---|
153 | Adds a control point to the end of the spline. |
---|
154 | <p> |
---|
155 | </td> |
---|
156 | </tr> |
---|
157 | </table> |
---|
158 | <a class="anchor" name="Ogre_1_1SimpleSplinea5" doxytag="Ogre::SimpleSpline::clear" ></a><p> |
---|
159 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
160 | <tr> |
---|
161 | <td class="mdRow"> |
---|
162 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
163 | <tr> |
---|
164 | <td class="md" nowrap valign="top"> void Ogre::SimpleSpline::clear </td> |
---|
165 | <td class="md" valign="top">( </td> |
---|
166 | <td class="md" nowrap valign="top">void </td> |
---|
167 | <td class="mdname1" valign="top" nowrap> </td> |
---|
168 | <td class="md" valign="top"> ) </td> |
---|
169 | <td class="md" nowrap></td> |
---|
170 | </tr> |
---|
171 | |
---|
172 | </table> |
---|
173 | </td> |
---|
174 | </tr> |
---|
175 | </table> |
---|
176 | <table cellspacing=5 cellpadding=0 border=0> |
---|
177 | <tr> |
---|
178 | <td> |
---|
179 | |
---|
180 | </td> |
---|
181 | <td> |
---|
182 | |
---|
183 | <p> |
---|
184 | Clears all the points in the spline. |
---|
185 | <p> |
---|
186 | </td> |
---|
187 | </tr> |
---|
188 | </table> |
---|
189 | <a class="anchor" name="Ogre_1_1SimpleSplinea4" doxytag="Ogre::SimpleSpline::getNumPoints" ></a><p> |
---|
190 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
191 | <tr> |
---|
192 | <td class="mdRow"> |
---|
193 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
194 | <tr> |
---|
195 | <td class="md" nowrap valign="top"> unsigned short Ogre::SimpleSpline::getNumPoints </td> |
---|
196 | <td class="md" valign="top">( </td> |
---|
197 | <td class="md" nowrap valign="top">void </td> |
---|
198 | <td class="mdname1" valign="top" nowrap> </td> |
---|
199 | <td class="md" valign="top"> ) </td> |
---|
200 | <td class="md" nowrap> const</td> |
---|
201 | </tr> |
---|
202 | |
---|
203 | </table> |
---|
204 | </td> |
---|
205 | </tr> |
---|
206 | </table> |
---|
207 | <table cellspacing=5 cellpadding=0 border=0> |
---|
208 | <tr> |
---|
209 | <td> |
---|
210 | |
---|
211 | </td> |
---|
212 | <td> |
---|
213 | |
---|
214 | <p> |
---|
215 | Gets the number of control points in the spline. |
---|
216 | <p> |
---|
217 | </td> |
---|
218 | </tr> |
---|
219 | </table> |
---|
220 | <a class="anchor" name="Ogre_1_1SimpleSplinea3" doxytag="Ogre::SimpleSpline::getPoint" ></a><p> |
---|
221 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
222 | <tr> |
---|
223 | <td class="mdRow"> |
---|
224 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
225 | <tr> |
---|
226 | <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>& Ogre::SimpleSpline::getPoint </td> |
---|
227 | <td class="md" valign="top">( </td> |
---|
228 | <td class="md" nowrap valign="top">unsigned short </td> |
---|
229 | <td class="mdname1" valign="top" nowrap> <em>index</em> </td> |
---|
230 | <td class="md" valign="top"> ) </td> |
---|
231 | <td class="md" nowrap> const</td> |
---|
232 | </tr> |
---|
233 | |
---|
234 | </table> |
---|
235 | </td> |
---|
236 | </tr> |
---|
237 | </table> |
---|
238 | <table cellspacing=5 cellpadding=0 border=0> |
---|
239 | <tr> |
---|
240 | <td> |
---|
241 | |
---|
242 | </td> |
---|
243 | <td> |
---|
244 | |
---|
245 | <p> |
---|
246 | Gets the detail of one of the control points of the spline. |
---|
247 | <p> |
---|
248 | </td> |
---|
249 | </tr> |
---|
250 | </table> |
---|
251 | <a class="anchor" name="Ogre_1_1SimpleSplinea8" doxytag="Ogre::SimpleSpline::interpolate" ></a><p> |
---|
252 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
253 | <tr> |
---|
254 | <td class="mdRow"> |
---|
255 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
256 | <tr> |
---|
257 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::SimpleSpline::interpolate </td> |
---|
258 | <td class="md" valign="top">( </td> |
---|
259 | <td class="md" nowrap valign="top">unsigned int </td> |
---|
260 | <td class="mdname" nowrap> <em>fromIndex</em>, </td> |
---|
261 | </tr> |
---|
262 | <tr> |
---|
263 | <td class="md" nowrap align="right"></td> |
---|
264 | <td></td> |
---|
265 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a> </td> |
---|
266 | <td class="mdname" nowrap> <em>t</em></td> |
---|
267 | </tr> |
---|
268 | <tr> |
---|
269 | <td></td> |
---|
270 | <td class="md">) </td> |
---|
271 | <td class="md" colspan="2"></td> |
---|
272 | </tr> |
---|
273 | |
---|
274 | </table> |
---|
275 | </td> |
---|
276 | </tr> |
---|
277 | </table> |
---|
278 | <table cellspacing=5 cellpadding=0 border=0> |
---|
279 | <tr> |
---|
280 | <td> |
---|
281 | |
---|
282 | </td> |
---|
283 | <td> |
---|
284 | |
---|
285 | <p> |
---|
286 | Interpolates a single segment of the spline given a parametric value. |
---|
287 | <p> |
---|
288 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
289 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
290 | <tr><td valign=top><em>fromIndex</em> </td><td>The point index to treat as t=0. fromIndex + 1 is deemed to be t=1 </td></tr> |
---|
291 | <tr><td valign=top><em>t</em> </td><td>Parametric value </td></tr> |
---|
292 | </table> |
---|
293 | </dl> |
---|
294 | </td> |
---|
295 | </tr> |
---|
296 | </table> |
---|
297 | <a class="anchor" name="Ogre_1_1SimpleSplinea7" doxytag="Ogre::SimpleSpline::interpolate" ></a><p> |
---|
298 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
299 | <tr> |
---|
300 | <td class="mdRow"> |
---|
301 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
302 | <tr> |
---|
303 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> Ogre::SimpleSpline::interpolate </td> |
---|
304 | <td class="md" valign="top">( </td> |
---|
305 | <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a> </td> |
---|
306 | <td class="mdname1" valign="top" nowrap> <em>t</em> </td> |
---|
307 | <td class="md" valign="top"> ) </td> |
---|
308 | <td class="md" nowrap></td> |
---|
309 | </tr> |
---|
310 | |
---|
311 | </table> |
---|
312 | </td> |
---|
313 | </tr> |
---|
314 | </table> |
---|
315 | <table cellspacing=5 cellpadding=0 border=0> |
---|
316 | <tr> |
---|
317 | <td> |
---|
318 | |
---|
319 | </td> |
---|
320 | <td> |
---|
321 | |
---|
322 | <p> |
---|
323 | Returns an interpolated point based on a parametric value over the whole series. |
---|
324 | <p> |
---|
325 | <dl compact><dt><b>Remarks:</b></dt><dd>Given a t value between 0 and 1 representing the parametric distance along the whole length of the spline, this method returns an interpolated point. </dd></dl> |
---|
326 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
327 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
328 | <tr><td valign=top><em>t</em> </td><td>Parametric value. </td></tr> |
---|
329 | </table> |
---|
330 | </dl> |
---|
331 | </td> |
---|
332 | </tr> |
---|
333 | </table> |
---|
334 | <a class="anchor" name="Ogre_1_1SimpleSplinea10" doxytag="Ogre::SimpleSpline::recalcTangents" ></a><p> |
---|
335 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
336 | <tr> |
---|
337 | <td class="mdRow"> |
---|
338 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
339 | <tr> |
---|
340 | <td class="md" nowrap valign="top"> void Ogre::SimpleSpline::recalcTangents </td> |
---|
341 | <td class="md" valign="top">( </td> |
---|
342 | <td class="md" nowrap valign="top">void </td> |
---|
343 | <td class="mdname1" valign="top" nowrap> </td> |
---|
344 | <td class="md" valign="top"> ) </td> |
---|
345 | <td class="md" nowrap></td> |
---|
346 | </tr> |
---|
347 | |
---|
348 | </table> |
---|
349 | </td> |
---|
350 | </tr> |
---|
351 | </table> |
---|
352 | <table cellspacing=5 cellpadding=0 border=0> |
---|
353 | <tr> |
---|
354 | <td> |
---|
355 | |
---|
356 | </td> |
---|
357 | <td> |
---|
358 | |
---|
359 | <p> |
---|
360 | Recalculates the tangents associated with this spline. |
---|
361 | <p> |
---|
362 | <dl compact><dt><b>Remarks:</b></dt><dd>If you tell the spline not to update on demand by calling setAutoCalculate(false) then you must call this after completing your updates to the spline points. </dd></dl> |
---|
363 | </td> |
---|
364 | </tr> |
---|
365 | </table> |
---|
366 | <a class="anchor" name="Ogre_1_1SimpleSplinea9" doxytag="Ogre::SimpleSpline::setAutoCalculate" ></a><p> |
---|
367 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
368 | <tr> |
---|
369 | <td class="mdRow"> |
---|
370 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
371 | <tr> |
---|
372 | <td class="md" nowrap valign="top"> void Ogre::SimpleSpline::setAutoCalculate </td> |
---|
373 | <td class="md" valign="top">( </td> |
---|
374 | <td class="md" nowrap valign="top">bool </td> |
---|
375 | <td class="mdname1" valign="top" nowrap> <em>autoCalc</em> </td> |
---|
376 | <td class="md" valign="top"> ) </td> |
---|
377 | <td class="md" nowrap></td> |
---|
378 | </tr> |
---|
379 | |
---|
380 | </table> |
---|
381 | </td> |
---|
382 | </tr> |
---|
383 | </table> |
---|
384 | <table cellspacing=5 cellpadding=0 border=0> |
---|
385 | <tr> |
---|
386 | <td> |
---|
387 | |
---|
388 | </td> |
---|
389 | <td> |
---|
390 | |
---|
391 | <p> |
---|
392 | Tells the spline whether it should automatically calculate tangents on demand as points are added. |
---|
393 | <p> |
---|
394 | <dl compact><dt><b>Remarks:</b></dt><dd>The spline calculates tangents at each point automatically based on the input points. Normally it does this every time a point changes. However, if you have a lot of points to add in one go, you probably don't want to incur this overhead and would prefer to defer the calculation until you are finished setting all the points. You can do this by calling this method with a parameter of 'false'. Just remember to manually call the recalcTangents method when you are done. </dd></dl> |
---|
395 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
396 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
397 | <tr><td valign=top><em>autoCalc</em> </td><td>If true, tangents are calculated for you whenever a point changes. If false, you must call reclacTangents to recalculate them when it best suits. </td></tr> |
---|
398 | </table> |
---|
399 | </dl> |
---|
400 | </td> |
---|
401 | </tr> |
---|
402 | </table> |
---|
403 | <a class="anchor" name="Ogre_1_1SimpleSplinea6" doxytag="Ogre::SimpleSpline::updatePoint" ></a><p> |
---|
404 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
405 | <tr> |
---|
406 | <td class="mdRow"> |
---|
407 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
408 | <tr> |
---|
409 | <td class="md" nowrap valign="top"> void Ogre::SimpleSpline::updatePoint </td> |
---|
410 | <td class="md" valign="top">( </td> |
---|
411 | <td class="md" nowrap valign="top">unsigned short </td> |
---|
412 | <td class="mdname" nowrap> <em>index</em>, </td> |
---|
413 | </tr> |
---|
414 | <tr> |
---|
415 | <td class="md" nowrap align="right"></td> |
---|
416 | <td></td> |
---|
417 | <td class="md" nowrap>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td> |
---|
418 | <td class="mdname" nowrap> <em>value</em></td> |
---|
419 | </tr> |
---|
420 | <tr> |
---|
421 | <td></td> |
---|
422 | <td class="md">) </td> |
---|
423 | <td class="md" colspan="2"></td> |
---|
424 | </tr> |
---|
425 | |
---|
426 | </table> |
---|
427 | </td> |
---|
428 | </tr> |
---|
429 | </table> |
---|
430 | <table cellspacing=5 cellpadding=0 border=0> |
---|
431 | <tr> |
---|
432 | <td> |
---|
433 | |
---|
434 | </td> |
---|
435 | <td> |
---|
436 | |
---|
437 | <p> |
---|
438 | Updates a single point in the spline. |
---|
439 | <p> |
---|
440 | <dl compact><dt><b>Remarks:</b></dt><dd>This point must already exist in the spline. </dd></dl> |
---|
441 | </td> |
---|
442 | </tr> |
---|
443 | </table> |
---|
444 | <hr><h2>Member Data Documentation</h2> |
---|
445 | <a class="anchor" name="Ogre_1_1SimpleSplinep0" doxytag="Ogre::SimpleSpline::mAutoCalc" ></a><p> |
---|
446 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
447 | <tr> |
---|
448 | <td class="mdRow"> |
---|
449 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
450 | <tr> |
---|
451 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep0">Ogre::SimpleSpline::mAutoCalc</a><code> [protected]</code> |
---|
452 | </table> |
---|
453 | </td> |
---|
454 | </tr> |
---|
455 | </table> |
---|
456 | <table cellspacing=5 cellpadding=0 border=0> |
---|
457 | <tr> |
---|
458 | <td> |
---|
459 | |
---|
460 | </td> |
---|
461 | <td> |
---|
462 | |
---|
463 | <p> |
---|
464 | |
---|
465 | <p> |
---|
466 | Definition at line <a class="el" href="OgreSimpleSpline_8h-source.html#l00109">109</a> of file <a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a>. </td> |
---|
467 | </tr> |
---|
468 | </table> |
---|
469 | <a class="anchor" name="Ogre_1_1SimpleSplinep3" doxytag="Ogre::SimpleSpline::mCoeffs" ></a><p> |
---|
470 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
471 | <tr> |
---|
472 | <td class="mdRow"> |
---|
473 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
474 | <tr> |
---|
475 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Matrix4.html">Matrix4</a> <a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep3">Ogre::SimpleSpline::mCoeffs</a><code> [protected]</code> |
---|
476 | </table> |
---|
477 | </td> |
---|
478 | </tr> |
---|
479 | </table> |
---|
480 | <table cellspacing=5 cellpadding=0 border=0> |
---|
481 | <tr> |
---|
482 | <td> |
---|
483 | |
---|
484 | </td> |
---|
485 | <td> |
---|
486 | |
---|
487 | <p> |
---|
488 | Matrix of coefficients. |
---|
489 | <p> |
---|
490 | |
---|
491 | <p> |
---|
492 | Definition at line <a class="el" href="OgreSimpleSpline_8h-source.html#l00115">115</a> of file <a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a>. </td> |
---|
493 | </tr> |
---|
494 | </table> |
---|
495 | <a class="anchor" name="Ogre_1_1SimpleSplinep1" doxytag="Ogre::SimpleSpline::mPoints" ></a><p> |
---|
496 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
497 | <tr> |
---|
498 | <td class="mdRow"> |
---|
499 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
500 | <tr> |
---|
501 | <td class="md" nowrap valign="top"> std::vector<<a class="el" href="classOgre_1_1Vector3.html">Vector3</a>> <a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep1">Ogre::SimpleSpline::mPoints</a><code> [protected]</code> |
---|
502 | </table> |
---|
503 | </td> |
---|
504 | </tr> |
---|
505 | </table> |
---|
506 | <table cellspacing=5 cellpadding=0 border=0> |
---|
507 | <tr> |
---|
508 | <td> |
---|
509 | |
---|
510 | </td> |
---|
511 | <td> |
---|
512 | |
---|
513 | <p> |
---|
514 | |
---|
515 | <p> |
---|
516 | Definition at line <a class="el" href="OgreSimpleSpline_8h-source.html#l00111">111</a> of file <a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a>. </td> |
---|
517 | </tr> |
---|
518 | </table> |
---|
519 | <a class="anchor" name="Ogre_1_1SimpleSplinep2" doxytag="Ogre::SimpleSpline::mTangents" ></a><p> |
---|
520 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
521 | <tr> |
---|
522 | <td class="mdRow"> |
---|
523 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
524 | <tr> |
---|
525 | <td class="md" nowrap valign="top"> std::vector<<a class="el" href="classOgre_1_1Vector3.html">Vector3</a>> <a class="el" href="classOgre_1_1SimpleSpline.html#Ogre_1_1SimpleSplinep2">Ogre::SimpleSpline::mTangents</a><code> [protected]</code> |
---|
526 | </table> |
---|
527 | </td> |
---|
528 | </tr> |
---|
529 | </table> |
---|
530 | <table cellspacing=5 cellpadding=0 border=0> |
---|
531 | <tr> |
---|
532 | <td> |
---|
533 | |
---|
534 | </td> |
---|
535 | <td> |
---|
536 | |
---|
537 | <p> |
---|
538 | |
---|
539 | <p> |
---|
540 | Definition at line <a class="el" href="OgreSimpleSpline_8h-source.html#l00112">112</a> of file <a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a>. </td> |
---|
541 | </tr> |
---|
542 | </table> |
---|
543 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
544 | <li><a class="el" href="OgreSimpleSpline_8h-source.html">OgreSimpleSpline.h</a></ul> |
---|
545 | <hr> |
---|
546 | <p> |
---|
547 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
548 | <!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/> |
---|
549 | This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/> |
---|
550 | <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> |
---|
551 | <Work rdf:about=""> |
---|
552 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
553 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
554 | </Work> |
---|
555 | <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> --> |
---|
556 | |
---|
557 | Last modified Sun Mar 12 14:44:18 2006 |
---|
558 | </p> |
---|
559 | </body> |
---|
560 | </html> |
---|