source: NonGTP/FCollada/Documentation/class_f_c_d_geometry_spline.html @ 964

Revision 964, 31.5 KB checked in by igarcia, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FCDGeometrySpline Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
14    <li><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FCDGeometrySpline Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_d_geometry.html">COLLADA Document Geometry Entity</a>]</small>
27</h1><!-- doxytag: class="FCDGeometrySpline" --><!-- doxytag: inherits="FCDObject" -->A COLLADA geometric spline. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_geometry_spline_8h-source.html">FCDGeometrySpline.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDGeometrySpline:
33<p><center><img src="class_f_c_d_geometry_spline.png" usemap="#FCDGeometrySpline_map" border="0" alt=""></center>
34<map name="FCDGeometrySpline_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,127,80">
36<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,127,24">
37</map>
38<a href="class_f_c_d_geometry_spline-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
39<tr><td></td></tr>
40<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#38ba060aef184caf6bc732a087715bee">FCDGeometrySpline</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *parent)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#38ba060aef184caf6bc732a087715bee"></a><br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#aefa701bde5a9bee27ff26b489020ceb">~FCDGeometrySpline</a> ()</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#aefa701bde5a9bee27ff26b489020ceb"></a><br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#dab00f51a9fd1721b0cb3fde8f21559b">GetParent</a> ()</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the parent of this geometric spline: the geometry entity.  <a href="#dab00f51a9fd1721b0cb3fde8f21559b"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="995a455064951b00735d4357add0dd95"></a><!-- doxytag: member="FCDGeometrySpline::GetParent" ref="995a455064951b00735d4357add0dd95" args="() const " -->
51const <a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#995a455064951b00735d4357add0dd95">GetParent</a> () const </td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDCVs</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#a9dcc6310674d79a637e01239e7eb18d">GetCVs</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of control points for the spline.  <a href="#a9dcc6310674d79a637e01239e7eb18d"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="93e1a86206d8bb6a5c18d63110ddeddd"></a><!-- doxytag: member="FCDGeometrySpline::GetCVs" ref="93e1a86206d8bb6a5c18d63110ddeddd" args="() const " -->
58const <a class="el" href="classvector.html">FCDCVs</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#93e1a86206d8bb6a5c18d63110ddeddd">GetCVs</a> () const </td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#e588022ad71486ee6935e9da6b0758fe">GetCVCount</a> () const </td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of control points for the spline.  <a href="#e588022ad71486ee6935e9da6b0758fe"></a><br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_m_vector3.html">FMVector3</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#6115b44501695655936b5e0223bc0fad">GetCV</a> (size_t index)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a specific control point of the spline.  <a href="#6115b44501695655936b5e0223bc0fad"></a><br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="092ab14f828b54d549b453dab742bc35"></a><!-- doxytag: member="FCDGeometrySpline::GetCV" ref="092ab14f828b54d549b453dab742bc35" args="(size_t index) const " -->
68const <a class="el" href="class_f_m_vector3.html">FMVector3</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#092ab14f828b54d549b453dab742bc35">GetCV</a> (size_t index) const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDKnots</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#5879949df942f4f0d23ab849e685661f">GetKnots</a> ()</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of knots for the spline.  <a href="#5879949df942f4f0d23ab849e685661f"></a><br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33dfc6dda0c0f358b9b71f5ce3f76348"></a><!-- doxytag: member="FCDGeometrySpline::GetKnots" ref="33dfc6dda0c0f358b9b71f5ce3f76348" args="() const " -->
75const <a class="el" href="classvector.html">FCDKnots</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#33dfc6dda0c0f358b9b71f5ce3f76348">GetKnots</a> () const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#8f178d85f5cc50def06a3f3740756c2b">GetKnotCount</a> () const </td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of knots for the spline.  <a href="#8f178d85f5cc50def06a3f3740756c2b"></a><br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#617de8471e390f165e5ce5bff56f3e05">GetKnot</a> (size_t index) const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a specific knot of the spline.  <a href="#617de8471e390f165e5ce5bff56f3e05"></a><br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#e75c74bf4abd7d6475a12e83a400b8d7">IsClosed</a> () const </td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether this spline is closed.  <a href="#e75c74bf4abd7d6475a12e83a400b8d7"></a><br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#7ed77000c2fca608fb3069656e4bdceb">IsOpen</a> () const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether this spline is open.  <a href="#7ed77000c2fca608fb3069656e4bdceb"></a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#112dba264d954fd2106c060994e46636">SetCVs</a> (const <a class="el" href="classvector.html">FCDCVs</a> &amp;_cvs)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overwrites the list of control points for this spline with a new ordered list of control points.  <a href="#112dba264d954fd2106c060994e46636"></a><br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#a996b1e780c808ab346d615365c84bdf">SetKnots</a> (const <a class="el" href="classvector.html">FCDKnots</a> &amp;_knots)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overwrites the list of knots for this spline with a new ordered list of knots.  <a href="#a996b1e780c808ab346d615365c84bdf"></a><br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#fff3851f291fe6a4e75607b29c25151b">SetClosed</a> (bool _isClosed)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the spline closed state.  <a href="#fff3851f291fe6a4e75607b29c25151b"></a><br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#5d78403df15eff12dacfc83c0d0c1ad9">LoadFromXML</a> (xmlNode *splineNode)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the &lt;spline&gt; element from a given COLLADA XML tree node.  <a href="#5d78403df15eff12dacfc83c0d0c1ad9"></a><br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top">xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_geometry_spline.html#cdf9a775b991ddd5cbd9a7d60af58f50">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the &lt;spline&gt; element to the given COLLADA XML tree node.  <a href="#cdf9a775b991ddd5cbd9a7d60af58f50"></a><br></td></tr>
105</table>
106<hr><a name="_details"></a><h2>Detailed Description</h2>
107A COLLADA geometric spline.
108<p>
109A COLLADA spline contains a list of control points (CVs) that define an ordered list of 3D coordinates that influence the spline. The spline also contains a matching list of knots: there should be as many control points as there are knots.<p>
110A COLLADA spline may be closed or open. If the spline is closed, then the first control point should be re-used when evaluating the last control point: the result should be a continuous curve, while an open spline will result in a discontinuity at each end.<p>
111<dl compact><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>: Insert the mathematical formula to calculate the spline position.</dd></dl>
112
113<p>
114<hr><h2>Constructor &amp; Destructor Documentation</h2>
115<a class="anchor" name="38ba060aef184caf6bc732a087715bee"></a><!-- doxytag: member="FCDGeometrySpline::FCDGeometrySpline" ref="38ba060aef184caf6bc732a087715bee" args="(FCDocument *document, FCDGeometry *parent)" --><p>
116<table class="mdTable" cellpadding="2" cellspacing="0">
117  <tr>
118    <td class="mdRow">
119      <table cellpadding="0" cellspacing="0" border="0">
120        <tr>
121          <td class="md" nowrap valign="top">FCDGeometrySpline::FCDGeometrySpline           </td>
122          <td class="md" valign="top">(&nbsp;</td>
123          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
124          <td class="mdname" nowrap> <em>document</em>, </td>
125        </tr>
126        <tr>
127          <td class="md" nowrap align="right"></td>
128          <td class="md"></td>
129          <td class="md" nowrap><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> *&nbsp;</td>
130          <td class="mdname" nowrap> <em>parent</em></td>
131        </tr>
132        <tr>
133          <td class="md"></td>
134          <td class="md">)&nbsp;</td>
135          <td class="md" colspan="2"></td>
136        </tr>
137      </table>
138    </td>
139  </tr>
140</table>
141<table cellspacing="5" cellpadding="0" border="0">
142  <tr>
143    <td>
144      &nbsp;
145    </td>
146    <td>
147
148<p>
149Constructor: do not use directly.
150<p>
151Use the <a class="el" href="class_f_c_d_geometry.html#80d2488705610b031d25815db0cb92d5">FCDGeometry::CreateMesh</a> function instead. <dl compact><dt><b>Parameters:</b></dt><dd>
152  <table border="0" cellspacing="2" cellpadding="0">
153    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the new spline. </td></tr>
154    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The geometry entity that contains the new spline. </td></tr>
155  </table>
156</dl>
157    </td>
158  </tr>
159</table>
160<a class="anchor" name="aefa701bde5a9bee27ff26b489020ceb"></a><!-- doxytag: member="FCDGeometrySpline::~FCDGeometrySpline" ref="aefa701bde5a9bee27ff26b489020ceb" args="()" --><p>
161<table class="mdTable" cellpadding="2" cellspacing="0">
162  <tr>
163    <td class="mdRow">
164      <table cellpadding="0" cellspacing="0" border="0">
165        <tr>
166          <td class="md" nowrap valign="top">virtual FCDGeometrySpline::~FCDGeometrySpline           </td>
167          <td class="md" valign="top">(&nbsp;</td>
168          <td class="mdname1" valign="top" nowrap>          </td>
169          <td class="md" valign="top">&nbsp;)&nbsp;</td>
170          <td class="md" nowrap><code> [virtual]</code></td>
171        </tr>
172      </table>
173    </td>
174  </tr>
175</table>
176<table cellspacing="5" cellpadding="0" border="0">
177  <tr>
178    <td>
179      &nbsp;
180    </td>
181    <td>
182
183<p>
184Destructor: do not use directly.
185<p>
186All geometric splines are released with the geometry that they belong to.     </td>
187  </tr>
188</table>
189<hr><h2>Member Function Documentation</h2>
190<a class="anchor" name="6115b44501695655936b5e0223bc0fad"></a><!-- doxytag: member="FCDGeometrySpline::GetCV" ref="6115b44501695655936b5e0223bc0fad" args="(size_t index)" --><p>
191<table class="mdTable" cellpadding="2" cellspacing="0">
192  <tr>
193    <td class="mdRow">
194      <table cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td class="md" nowrap valign="top"><a class="el" href="class_f_m_vector3.html">FMVector3</a>* FCDGeometrySpline::GetCV           </td>
197          <td class="md" valign="top">(&nbsp;</td>
198          <td class="md" nowrap valign="top">size_t&nbsp;</td>
199          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
200          <td class="md" valign="top">&nbsp;)&nbsp;</td>
201          <td class="md" nowrap><code> [inline]</code></td>
202        </tr>
203      </table>
204    </td>
205  </tr>
206</table>
207<table cellspacing="5" cellpadding="0" border="0">
208  <tr>
209    <td>
210      &nbsp;
211    </td>
212    <td>
213
214<p>
215Retrieves a specific control point of the spline.
216<p>
217<dl compact><dt><b>Parameters:</b></dt><dd>
218  <table border="0" cellspacing="2" cellpadding="0">
219    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the control point. The index should always be less than the number of control point. </td></tr>
220  </table>
221</dl>
222<dl compact><dt><b>Returns:</b></dt><dd>The control point. </dd></dl>
223    </td>
224  </tr>
225</table>
226<a class="anchor" name="e588022ad71486ee6935e9da6b0758fe"></a><!-- doxytag: member="FCDGeometrySpline::GetCVCount" ref="e588022ad71486ee6935e9da6b0758fe" args="() const " --><p>
227<table class="mdTable" cellpadding="2" cellspacing="0">
228  <tr>
229    <td class="mdRow">
230      <table cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td class="md" nowrap valign="top">size_t FCDGeometrySpline::GetCVCount           </td>
233          <td class="md" valign="top">(&nbsp;</td>
234          <td class="mdname1" valign="top" nowrap>          </td>
235          <td class="md" valign="top">&nbsp;)&nbsp;</td>
236          <td class="md" nowrap> const<code> [inline]</code></td>
237        </tr>
238      </table>
239    </td>
240  </tr>
241</table>
242<table cellspacing="5" cellpadding="0" border="0">
243  <tr>
244    <td>
245      &nbsp;
246    </td>
247    <td>
248
249<p>
250Retrieves the number of control points for the spline.
251<p>
252<dl compact><dt><b>Returns:</b></dt><dd>The control point count. </dd></dl>
253    </td>
254  </tr>
255</table>
256<a class="anchor" name="a9dcc6310674d79a637e01239e7eb18d"></a><!-- doxytag: member="FCDGeometrySpline::GetCVs" ref="a9dcc6310674d79a637e01239e7eb18d" args="()" --><p>
257<table class="mdTable" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDCVs</a>&amp; FCDGeometrySpline::GetCVs           </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="mdname1" valign="top" nowrap>          </td>
265          <td class="md" valign="top">&nbsp;)&nbsp;</td>
266          <td class="md" nowrap><code> [inline]</code></td>
267        </tr>
268      </table>
269    </td>
270  </tr>
271</table>
272<table cellspacing="5" cellpadding="0" border="0">
273  <tr>
274    <td>
275      &nbsp;
276    </td>
277    <td>
278
279<p>
280Retrieves the list of control points for the spline.
281<p>
282<dl compact><dt><b>Returns:</b></dt><dd>The list of control points. </dd></dl>
283    </td>
284  </tr>
285</table>
286<a class="anchor" name="617de8471e390f165e5ce5bff56f3e05"></a><!-- doxytag: member="FCDGeometrySpline::GetKnot" ref="617de8471e390f165e5ce5bff56f3e05" args="(size_t index) const " --><p>
287<table class="mdTable" cellpadding="2" cellspacing="0">
288  <tr>
289    <td class="mdRow">
290      <table cellpadding="0" cellspacing="0" border="0">
291        <tr>
292          <td class="md" nowrap valign="top">double FCDGeometrySpline::GetKnot           </td>
293          <td class="md" valign="top">(&nbsp;</td>
294          <td class="md" nowrap valign="top">size_t&nbsp;</td>
295          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
296          <td class="md" valign="top">&nbsp;)&nbsp;</td>
297          <td class="md" nowrap> const<code> [inline]</code></td>
298        </tr>
299      </table>
300    </td>
301  </tr>
302</table>
303<table cellspacing="5" cellpadding="0" border="0">
304  <tr>
305    <td>
306      &nbsp;
307    </td>
308    <td>
309
310<p>
311Retrieves a specific knot of the spline.
312<p>
313<dl compact><dt><b>Parameters:</b></dt><dd>
314  <table border="0" cellspacing="2" cellpadding="0">
315    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the knot. The index should always be less than the number of knots. </td></tr>
316  </table>
317</dl>
318<dl compact><dt><b>Returns:</b></dt><dd>The knot value. </dd></dl>
319    </td>
320  </tr>
321</table>
322<a class="anchor" name="8f178d85f5cc50def06a3f3740756c2b"></a><!-- doxytag: member="FCDGeometrySpline::GetKnotCount" ref="8f178d85f5cc50def06a3f3740756c2b" args="() const " --><p>
323<table class="mdTable" cellpadding="2" cellspacing="0">
324  <tr>
325    <td class="mdRow">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top">size_t FCDGeometrySpline::GetKnotCount           </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="mdname1" valign="top" nowrap>          </td>
331          <td class="md" valign="top">&nbsp;)&nbsp;</td>
332          <td class="md" nowrap> const<code> [inline]</code></td>
333        </tr>
334      </table>
335    </td>
336  </tr>
337</table>
338<table cellspacing="5" cellpadding="0" border="0">
339  <tr>
340    <td>
341      &nbsp;
342    </td>
343    <td>
344
345<p>
346Retrieves the number of knots for the spline.
347<p>
348<dl compact><dt><b>Returns:</b></dt><dd>The knot count. </dd></dl>
349    </td>
350  </tr>
351</table>
352<a class="anchor" name="5879949df942f4f0d23ab849e685661f"></a><!-- doxytag: member="FCDGeometrySpline::GetKnots" ref="5879949df942f4f0d23ab849e685661f" args="()" --><p>
353<table class="mdTable" cellpadding="2" cellspacing="0">
354  <tr>
355    <td class="mdRow">
356      <table cellpadding="0" cellspacing="0" border="0">
357        <tr>
358          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDKnots</a>&amp; FCDGeometrySpline::GetKnots           </td>
359          <td class="md" valign="top">(&nbsp;</td>
360          <td class="mdname1" valign="top" nowrap>          </td>
361          <td class="md" valign="top">&nbsp;)&nbsp;</td>
362          <td class="md" nowrap><code> [inline]</code></td>
363        </tr>
364      </table>
365    </td>
366  </tr>
367</table>
368<table cellspacing="5" cellpadding="0" border="0">
369  <tr>
370    <td>
371      &nbsp;
372    </td>
373    <td>
374
375<p>
376Retrieves the list of knots for the spline.
377<p>
378<dl compact><dt><b>Returns:</b></dt><dd>The list of knots. </dd></dl>
379    </td>
380  </tr>
381</table>
382<a class="anchor" name="dab00f51a9fd1721b0cb3fde8f21559b"></a><!-- doxytag: member="FCDGeometrySpline::GetParent" ref="dab00f51a9fd1721b0cb3fde8f21559b" args="()" --><p>
383<table class="mdTable" cellpadding="2" cellspacing="0">
384  <tr>
385    <td class="mdRow">
386      <table cellpadding="0" cellspacing="0" border="0">
387        <tr>
388          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a>* FCDGeometrySpline::GetParent           </td>
389          <td class="md" valign="top">(&nbsp;</td>
390          <td class="mdname1" valign="top" nowrap>          </td>
391          <td class="md" valign="top">&nbsp;)&nbsp;</td>
392          <td class="md" nowrap><code> [inline]</code></td>
393        </tr>
394      </table>
395    </td>
396  </tr>
397</table>
398<table cellspacing="5" cellpadding="0" border="0">
399  <tr>
400    <td>
401      &nbsp;
402    </td>
403    <td>
404
405<p>
406Retrieve the parent of this geometric spline: the geometry entity.
407<p>
408<dl compact><dt><b>Returns:</b></dt><dd>The geometry entity that this spline belongs to. </dd></dl>
409    </td>
410  </tr>
411</table>
412<a class="anchor" name="e75c74bf4abd7d6475a12e83a400b8d7"></a><!-- doxytag: member="FCDGeometrySpline::IsClosed" ref="e75c74bf4abd7d6475a12e83a400b8d7" args="() const " --><p>
413<table class="mdTable" cellpadding="2" cellspacing="0">
414  <tr>
415    <td class="mdRow">
416      <table cellpadding="0" cellspacing="0" border="0">
417        <tr>
418          <td class="md" nowrap valign="top">bool FCDGeometrySpline::IsClosed           </td>
419          <td class="md" valign="top">(&nbsp;</td>
420          <td class="mdname1" valign="top" nowrap>          </td>
421          <td class="md" valign="top">&nbsp;)&nbsp;</td>
422          <td class="md" nowrap> const<code> [inline]</code></td>
423        </tr>
424      </table>
425    </td>
426  </tr>
427</table>
428<table cellspacing="5" cellpadding="0" border="0">
429  <tr>
430    <td>
431      &nbsp;
432    </td>
433    <td>
434
435<p>
436Retrieves whether this spline is closed.
437<p>
438<dl compact><dt><b>Returns:</b></dt><dd>Whether the spline is closed. </dd></dl>
439    </td>
440  </tr>
441</table>
442<a class="anchor" name="7ed77000c2fca608fb3069656e4bdceb"></a><!-- doxytag: member="FCDGeometrySpline::IsOpen" ref="7ed77000c2fca608fb3069656e4bdceb" args="() const " --><p>
443<table class="mdTable" cellpadding="2" cellspacing="0">
444  <tr>
445    <td class="mdRow">
446      <table cellpadding="0" cellspacing="0" border="0">
447        <tr>
448          <td class="md" nowrap valign="top">bool FCDGeometrySpline::IsOpen           </td>
449          <td class="md" valign="top">(&nbsp;</td>
450          <td class="mdname1" valign="top" nowrap>          </td>
451          <td class="md" valign="top">&nbsp;)&nbsp;</td>
452          <td class="md" nowrap> const<code> [inline]</code></td>
453        </tr>
454      </table>
455    </td>
456  </tr>
457</table>
458<table cellspacing="5" cellpadding="0" border="0">
459  <tr>
460    <td>
461      &nbsp;
462    </td>
463    <td>
464
465<p>
466Retrieves whether this spline is open.
467<p>
468<dl compact><dt><b>Returns:</b></dt><dd>Whether the spline is open. </dd></dl>
469    </td>
470  </tr>
471</table>
472<a class="anchor" name="5d78403df15eff12dacfc83c0d0c1ad9"></a><!-- doxytag: member="FCDGeometrySpline::LoadFromXML" ref="5d78403df15eff12dacfc83c0d0c1ad9" args="(xmlNode *splineNode)" --><p>
473<table class="mdTable" cellpadding="2" cellspacing="0">
474  <tr>
475    <td class="mdRow">
476      <table cellpadding="0" cellspacing="0" border="0">
477        <tr>
478          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDGeometrySpline::LoadFromXML           </td>
479          <td class="md" valign="top">(&nbsp;</td>
480          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
481          <td class="mdname1" valign="top" nowrap> <em>splineNode</em>          </td>
482          <td class="md" valign="top">&nbsp;)&nbsp;</td>
483          <td class="md" nowrap></td>
484        </tr>
485      </table>
486    </td>
487  </tr>
488</table>
489<table cellspacing="5" cellpadding="0" border="0">
490  <tr>
491    <td>
492      &nbsp;
493    </td>
494    <td>
495
496<p>
497[INTERNAL] Reads in the &lt;spline&gt; element from a given COLLADA XML tree node.
498<p>
499<dl compact><dt><b>Parameters:</b></dt><dd>
500  <table border="0" cellspacing="2" cellpadding="0">
501    <tr><td valign="top"></td><td valign="top"><em>splineNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
502  </table>
503</dl>
504<dl compact><dt><b>Returns:</b></dt><dd>The status of the import. If the status is not successful, it may be dangerous to extract information from the spline. </dd></dl>
505    </td>
506  </tr>
507</table>
508<a class="anchor" name="fff3851f291fe6a4e75607b29c25151b"></a><!-- doxytag: member="FCDGeometrySpline::SetClosed" ref="fff3851f291fe6a4e75607b29c25151b" args="(bool _isClosed)" --><p>
509<table class="mdTable" cellpadding="2" cellspacing="0">
510  <tr>
511    <td class="mdRow">
512      <table cellpadding="0" cellspacing="0" border="0">
513        <tr>
514          <td class="md" nowrap valign="top">void FCDGeometrySpline::SetClosed           </td>
515          <td class="md" valign="top">(&nbsp;</td>
516          <td class="md" nowrap valign="top">bool&nbsp;</td>
517          <td class="mdname1" valign="top" nowrap> <em>_isClosed</em>          </td>
518          <td class="md" valign="top">&nbsp;)&nbsp;</td>
519          <td class="md" nowrap><code> [inline]</code></td>
520        </tr>
521      </table>
522    </td>
523  </tr>
524</table>
525<table cellspacing="5" cellpadding="0" border="0">
526  <tr>
527    <td>
528      &nbsp;
529    </td>
530    <td>
531
532<p>
533Sets the spline closed state.
534<p>
535<dl compact><dt><b>Parameters:</b></dt><dd>
536  <table border="0" cellspacing="2" cellpadding="0">
537    <tr><td valign="top"></td><td valign="top"><em>_isClosed</em>&nbsp;</td><td>The new closed state. </td></tr>
538  </table>
539</dl>
540    </td>
541  </tr>
542</table>
543<a class="anchor" name="112dba264d954fd2106c060994e46636"></a><!-- doxytag: member="FCDGeometrySpline::SetCVs" ref="112dba264d954fd2106c060994e46636" args="(const FCDCVs &amp;_cvs)" --><p>
544<table class="mdTable" cellpadding="2" cellspacing="0">
545  <tr>
546    <td class="mdRow">
547      <table cellpadding="0" cellspacing="0" border="0">
548        <tr>
549          <td class="md" nowrap valign="top">void FCDGeometrySpline::SetCVs           </td>
550          <td class="md" valign="top">(&nbsp;</td>
551          <td class="md" nowrap valign="top">const <a class="el" href="classvector.html">FCDCVs</a> &amp;&nbsp;</td>
552          <td class="mdname1" valign="top" nowrap> <em>_cvs</em>          </td>
553          <td class="md" valign="top">&nbsp;)&nbsp;</td>
554          <td class="md" nowrap><code> [inline]</code></td>
555        </tr>
556      </table>
557    </td>
558  </tr>
559</table>
560<table cellspacing="5" cellpadding="0" border="0">
561  <tr>
562    <td>
563      &nbsp;
564    </td>
565    <td>
566
567<p>
568Overwrites the list of control points for this spline with a new ordered list of control points.
569<p>
570<dl compact><dt><b>Parameters:</b></dt><dd>
571  <table border="0" cellspacing="2" cellpadding="0">
572    <tr><td valign="top"></td><td valign="top"><em>_cvs</em>&nbsp;</td><td>The new control points. </td></tr>
573  </table>
574</dl>
575    </td>
576  </tr>
577</table>
578<a class="anchor" name="a996b1e780c808ab346d615365c84bdf"></a><!-- doxytag: member="FCDGeometrySpline::SetKnots" ref="a996b1e780c808ab346d615365c84bdf" args="(const FCDKnots &amp;_knots)" --><p>
579<table class="mdTable" cellpadding="2" cellspacing="0">
580  <tr>
581    <td class="mdRow">
582      <table cellpadding="0" cellspacing="0" border="0">
583        <tr>
584          <td class="md" nowrap valign="top">void FCDGeometrySpline::SetKnots           </td>
585          <td class="md" valign="top">(&nbsp;</td>
586          <td class="md" nowrap valign="top">const <a class="el" href="classvector.html">FCDKnots</a> &amp;&nbsp;</td>
587          <td class="mdname1" valign="top" nowrap> <em>_knots</em>          </td>
588          <td class="md" valign="top">&nbsp;)&nbsp;</td>
589          <td class="md" nowrap><code> [inline]</code></td>
590        </tr>
591      </table>
592    </td>
593  </tr>
594</table>
595<table cellspacing="5" cellpadding="0" border="0">
596  <tr>
597    <td>
598      &nbsp;
599    </td>
600    <td>
601
602<p>
603Overwrites the list of knots for this spline with a new ordered list of knots.
604<p>
605<dl compact><dt><b>Parameters:</b></dt><dd>
606  <table border="0" cellspacing="2" cellpadding="0">
607    <tr><td valign="top"></td><td valign="top"><em>_knots</em>&nbsp;</td><td>The new knots. </td></tr>
608  </table>
609</dl>
610    </td>
611  </tr>
612</table>
613<a class="anchor" name="cdf9a775b991ddd5cbd9a7d60af58f50"></a><!-- doxytag: member="FCDGeometrySpline::WriteToXML" ref="cdf9a775b991ddd5cbd9a7d60af58f50" args="(xmlNode *parentNode) const " --><p>
614<table class="mdTable" cellpadding="2" cellspacing="0">
615  <tr>
616    <td class="mdRow">
617      <table cellpadding="0" cellspacing="0" border="0">
618        <tr>
619          <td class="md" nowrap valign="top">xmlNode* FCDGeometrySpline::WriteToXML           </td>
620          <td class="md" valign="top">(&nbsp;</td>
621          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
622          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
623          <td class="md" valign="top">&nbsp;)&nbsp;</td>
624          <td class="md" nowrap> const</td>
625        </tr>
626      </table>
627    </td>
628  </tr>
629</table>
630<table cellspacing="5" cellpadding="0" border="0">
631  <tr>
632    <td>
633      &nbsp;
634    </td>
635    <td>
636
637<p>
638[INTERNAL] Writes out the &lt;spline&gt; element to the given COLLADA XML tree node.
639<p>
640<dl compact><dt><b>Parameters:</b></dt><dd>
641  <table border="0" cellspacing="2" cellpadding="0">
642    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the spline information. </td></tr>
643  </table>
644</dl>
645<dl compact><dt><b>Returns:</b></dt><dd>The created &lt;spline&gt; element XML tree node. </dd></dl>
646    </td>
647  </tr>
648</table>
649<hr>The documentation for this class was generated from the following file:<ul>
650<li>FCDocument/<a class="el" href="_f_c_d_geometry_spline_8h-source.html">FCDGeometrySpline.h</a></ul>
651<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
652<a href="http://www.doxygen.org/index.html">
653<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
654</body>
655</html>
Note: See TracBrowser for help on using the repository browser.