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

Revision 964, 15.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: FCDObjectWithId 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>FCDObjectWithId Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_document.html">COLLADA Document Object Model.</a>]</small>
27</h1><!-- doxytag: class="FCDObjectWithId" --><!-- doxytag: inherits="FCDObject" -->A basic COLLADA object which has a unique COLLADA id. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_object_8h-source.html">FCDObject.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDObjectWithId:
33<p><center><img src="class_f_c_d_object_with_id.png" usemap="#FCDObjectWithId_map" border="0" alt=""></center>
34<map name="FCDObjectWithId_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="71,56,204,80">
36<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="71,0,204,24">
37<area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="0,168,133,192">
38<area href="class_f_c_d_geometry_source.html" alt="FCDGeometrySource" shape="rect" coords="143,168,276,192">
39<area href="class_f_c_d_animation.html" alt="FCDAnimation" shape="rect" coords="143,224,276,248">
40<area href="class_f_c_d_controller.html" alt="FCDController" shape="rect" coords="143,280,276,304">
41<area href="class_f_c_d_effect.html" alt="FCDEffect" shape="rect" coords="143,336,276,360">
42<area href="class_f_c_d_geometry.html" alt="FCDGeometry" shape="rect" coords="143,392,276,416">
43<area href="class_f_c_d_image.html" alt="FCDImage" shape="rect" coords="143,448,276,472">
44<area href="class_f_c_d_material.html" alt="FCDMaterial" shape="rect" coords="143,504,276,528">
45<area href="class_f_c_d_scene_node.html" alt="FCDSceneNode" shape="rect" coords="143,560,276,584">
46<area href="class_f_c_d_targeted_entity.html" alt="FCDTargetedEntity" shape="rect" coords="143,616,276,640">
47<area href="class_f_c_d_texture.html" alt="FCDTexture" shape="rect" coords="143,672,276,696">
48</map>
49<a href="class_f_c_d_object_with_id-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
50<tr><td></td></tr>
51<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object_with_id.html#985fbb2e196c9fab8cbc2832be31ebab">FCDObjectWithId</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, const char *baseId=&quot;ObjectWithID&quot;)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: sets the prefix COLLADA id to be used if no COLLADA id is provided.  <a href="#985fbb2e196c9fab8cbc2832be31ebab"></a><br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="073f8487210e8aa70f83d912e0a3ac0f"></a><!-- doxytag: member="FCDObjectWithId::~FCDObjectWithId" ref="073f8487210e8aa70f83d912e0a3ac0f" args="()" -->
56virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object_with_id.html#073f8487210e8aa70f83d912e0a3ac0f">~FCDObjectWithId</a> ()</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top">const string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object_with_id.html#f26de99d532dd2a3e2ca31631b566427">GetDaeId</a> () const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the unique COLLADA id for this object.  <a href="#f26de99d532dd2a3e2ca31631b566427"></a><br></td></tr>
62<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_object_with_id.html#3f24fdada7c3b3fb44e02be2dd3bb59a">SetDaeId</a> (const string &amp;id)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the COLLADA id for this object.  <a href="#3f24fdada7c3b3fb44e02be2dd3bb59a"></a><br></td></tr>
65<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_object_with_id.html#a8a0c443e392a1d1c63b5c5f422ff499">SetDaeId</a> (string &amp;id)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the COLLADA id for this object.  <a href="#a8a0c443e392a1d1c63b5c5f422ff499"></a><br></td></tr>
68<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_object_with_id.html#1075bd8450623f83343ce6a698da06e1">RemoveDaeId</a> ()</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Release the unique COLLADA id of an object.  <a href="#1075bd8450623f83343ce6a698da06e1"></a><br></td></tr>
71<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_object_with_id.html#ea836eca56429cb5607903c2bf9ac111">Clone</a> (<a class="el" href="class_f_c_d_object_with_id.html">FCDObjectWithId</a> *clone) const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Clones the object.  <a href="#ea836eca56429cb5607903c2bf9ac111"></a><br></td></tr>
74</table>
75<hr><a name="_details"></a><h2>Detailed Description</h2>
76A basic COLLADA object which has a unique COLLADA id.
77<p>
78Many COLLADA structures such as entities and sources need a unique COLLADA id. The COLLADA document contains a map of all the COLLADA ids known in its scope. The interface of the <a class="el" href="class_f_c_d_object_with_id.html">FCDObjectWithId</a> class allows for the retrieval and the modification of the unique COLLADA id attached to these objects.<p>
79A unique COLLADA id is built, if none are provided, using the 'baseId' field of the constructor. A unique COLLADA id is generated only on demand.
80<p>
81<hr><h2>Constructor &amp; Destructor Documentation</h2>
82<a class="anchor" name="985fbb2e196c9fab8cbc2832be31ebab"></a><!-- doxytag: member="FCDObjectWithId::FCDObjectWithId" ref="985fbb2e196c9fab8cbc2832be31ebab" args="(FCDocument *document, const char *baseId=&quot;ObjectWithID&quot;)" --><p>
83<table class="mdTable" cellpadding="2" cellspacing="0">
84  <tr>
85    <td class="mdRow">
86      <table cellpadding="0" cellspacing="0" border="0">
87        <tr>
88          <td class="md" nowrap valign="top">FCDObjectWithId::FCDObjectWithId           </td>
89          <td class="md" valign="top">(&nbsp;</td>
90          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
91          <td class="mdname" nowrap> <em>document</em>, </td>
92        </tr>
93        <tr>
94          <td class="md" nowrap align="right"></td>
95          <td class="md"></td>
96          <td class="md" nowrap>const char *&nbsp;</td>
97          <td class="mdname" nowrap> <em>baseId</em> = <code>&quot;ObjectWithID&quot;</code></td>
98        </tr>
99        <tr>
100          <td class="md"></td>
101          <td class="md">)&nbsp;</td>
102          <td class="md" colspan="2"></td>
103        </tr>
104      </table>
105    </td>
106  </tr>
107</table>
108<table cellspacing="5" cellpadding="0" border="0">
109  <tr>
110    <td>
111      &nbsp;
112    </td>
113    <td>
114
115<p>
116Constructor: sets the prefix COLLADA id to be used if no COLLADA id is provided.
117<p>
118<dl compact><dt><b>Parameters:</b></dt><dd>
119  <table border="0" cellspacing="2" cellpadding="0">
120    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document which owns this object. </td></tr>
121    <tr><td valign="top"></td><td valign="top"><em>baseId</em>&nbsp;</td><td>The prefix COLLADA id to be used if no COLLADA id is provided. </td></tr>
122  </table>
123</dl>
124    </td>
125  </tr>
126</table>
127<hr><h2>Member Function Documentation</h2>
128<a class="anchor" name="ea836eca56429cb5607903c2bf9ac111"></a><!-- doxytag: member="FCDObjectWithId::Clone" ref="ea836eca56429cb5607903c2bf9ac111" args="(FCDObjectWithId *clone) const " --><p>
129<table class="mdTable" cellpadding="2" cellspacing="0">
130  <tr>
131    <td class="mdRow">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" nowrap valign="top">void FCDObjectWithId::Clone           </td>
135          <td class="md" valign="top">(&nbsp;</td>
136          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_object_with_id.html">FCDObjectWithId</a> *&nbsp;</td>
137          <td class="mdname1" valign="top" nowrap> <em>clone</em>          </td>
138          <td class="md" valign="top">&nbsp;)&nbsp;</td>
139          <td class="md" nowrap> const</td>
140        </tr>
141      </table>
142    </td>
143  </tr>
144</table>
145<table cellspacing="5" cellpadding="0" border="0">
146  <tr>
147    <td>
148      &nbsp;
149    </td>
150    <td>
151
152<p>
153[INTERNAL] Clones the object.
154<p>
155The unique COLLADA id will be copied over to the clone object. Use carefully: when a cloned object with an id is released, it does remove the unique COLLADA id from the unique name map. <dl compact><dt><b>Parameters:</b></dt><dd>
156  <table border="0" cellspacing="2" cellpadding="0">
157    <tr><td valign="top"></td><td valign="top"><em>clone</em>&nbsp;</td><td>The object clone. </td></tr>
158  </table>
159</dl>
160    </td>
161  </tr>
162</table>
163<a class="anchor" name="f26de99d532dd2a3e2ca31631b566427"></a><!-- doxytag: member="FCDObjectWithId::GetDaeId" ref="f26de99d532dd2a3e2ca31631b566427" args="() const " --><p>
164<table class="mdTable" cellpadding="2" cellspacing="0">
165  <tr>
166    <td class="mdRow">
167      <table cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td class="md" nowrap valign="top">const string&amp; FCDObjectWithId::GetDaeId           </td>
170          <td class="md" valign="top">(&nbsp;</td>
171          <td class="mdname1" valign="top" nowrap>          </td>
172          <td class="md" valign="top">&nbsp;)&nbsp;</td>
173          <td class="md" nowrap> const</td>
174        </tr>
175      </table>
176    </td>
177  </tr>
178</table>
179<table cellspacing="5" cellpadding="0" border="0">
180  <tr>
181    <td>
182      &nbsp;
183    </td>
184    <td>
185
186<p>
187Retrieves the unique COLLADA id for this object.
188<p>
189If no unique COLLADA id has been previously generated or provided, this function has the side-effect of generating a unique COLLADA id. <dl compact><dt><b>Returns:</b></dt><dd>The unique COLLADA id. </dd></dl>
190    </td>
191  </tr>
192</table>
193<a class="anchor" name="1075bd8450623f83343ce6a698da06e1"></a><!-- doxytag: member="FCDObjectWithId::RemoveDaeId" ref="1075bd8450623f83343ce6a698da06e1" args="()" --><p>
194<table class="mdTable" cellpadding="2" cellspacing="0">
195  <tr>
196    <td class="mdRow">
197      <table cellpadding="0" cellspacing="0" border="0">
198        <tr>
199          <td class="md" nowrap valign="top">void FCDObjectWithId::RemoveDaeId           </td>
200          <td class="md" valign="top">(&nbsp;</td>
201          <td class="mdname1" valign="top" nowrap>          </td>
202          <td class="md" valign="top">&nbsp;)&nbsp;</td>
203          <td class="md" nowrap></td>
204        </tr>
205      </table>
206    </td>
207  </tr>
208</table>
209<table cellspacing="5" cellpadding="0" border="0">
210  <tr>
211    <td>
212      &nbsp;
213    </td>
214    <td>
215
216<p>
217[INTERNAL] Release the unique COLLADA id of an object.
218<p>
219Use this function wisely, as it leaves the object id-less and without a way to automatically generate a COLLADA id.     </td>
220  </tr>
221</table>
222<a class="anchor" name="a8a0c443e392a1d1c63b5c5f422ff499"></a><!-- doxytag: member="FCDObjectWithId::SetDaeId" ref="a8a0c443e392a1d1c63b5c5f422ff499" args="(string &amp;id)" --><p>
223<table class="mdTable" cellpadding="2" cellspacing="0">
224  <tr>
225    <td class="mdRow">
226      <table cellpadding="0" cellspacing="0" border="0">
227        <tr>
228          <td class="md" nowrap valign="top">void FCDObjectWithId::SetDaeId           </td>
229          <td class="md" valign="top">(&nbsp;</td>
230          <td class="md" nowrap valign="top">string &amp;&nbsp;</td>
231          <td class="mdname1" valign="top" nowrap> <em>id</em>          </td>
232          <td class="md" valign="top">&nbsp;)&nbsp;</td>
233          <td class="md" nowrap></td>
234        </tr>
235      </table>
236    </td>
237  </tr>
238</table>
239<table cellspacing="5" cellpadding="0" border="0">
240  <tr>
241    <td>
242      &nbsp;
243    </td>
244    <td>
245
246<p>
247Sets the COLLADA id for this object.
248<p>
249There is no guarantee that the given COLLADA id will be used, as it may not be unique. <dl compact><dt><b>Parameters:</b></dt><dd>
250  <table border="0" cellspacing="2" cellpadding="0">
251    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The wanted COLLADA id for this object. This COLLADA id does not need to be unique. If the COLLADA id is not unique, a new unique COLLADA id will be generated and this formal variable will be modified to contain the new COLLADA id. </td></tr>
252  </table>
253</dl>
254    </td>
255  </tr>
256</table>
257<a class="anchor" name="3f24fdada7c3b3fb44e02be2dd3bb59a"></a><!-- doxytag: member="FCDObjectWithId::SetDaeId" ref="3f24fdada7c3b3fb44e02be2dd3bb59a" args="(const string &amp;id)" --><p>
258<table class="mdTable" cellpadding="2" cellspacing="0">
259  <tr>
260    <td class="mdRow">
261      <table cellpadding="0" cellspacing="0" border="0">
262        <tr>
263          <td class="md" nowrap valign="top">void FCDObjectWithId::SetDaeId           </td>
264          <td class="md" valign="top">(&nbsp;</td>
265          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
266          <td class="mdname1" valign="top" nowrap> <em>id</em>          </td>
267          <td class="md" valign="top">&nbsp;)&nbsp;</td>
268          <td class="md" nowrap></td>
269        </tr>
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing="5" cellpadding="0" border="0">
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282Sets the COLLADA id for this object.
283<p>
284There is no guarantee that the given COLLADA id will be used, as it may not be unique. You can call the GetDaeId function after this call to retrieve the final, unique COLLADA id. <dl compact><dt><b>Parameters:</b></dt><dd>
285  <table border="0" cellspacing="2" cellpadding="0">
286    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The wanted COLLADA id for this object. This COLLADA id does not need to be unique. If the COLLADA id is not unique, a new unique COLLADA id will be generated. </td></tr>
287  </table>
288</dl>
289    </td>
290  </tr>
291</table>
292<hr>The documentation for this class was generated from the following file:<ul>
293<li>FCDocument/<a class="el" href="_f_c_d_object_8h-source.html">FCDObject.h</a></ul>
294<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
295<a href="http://www.doxygen.org/index.html">
296<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
297</body>
298</html>
Note: See TracBrowser for help on using the repository browser.