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

Revision 964, 18.1 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: FCDTargetedEntity 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>FCDTargetedEntity Class Reference</h1><!-- doxytag: class="FCDTargetedEntity" --><!-- doxytag: inherits="FCDEntity" -->A targeted entity. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_targeted_entity_8h-source.html">FCDTargetedEntity.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDTargetedEntity:
30<p><center><img src="class_f_c_d_targeted_entity.png" usemap="#FCDTargetedEntity_map" border="0" alt=""></center>
31<map name="FCDTargetedEntity_map">
32<area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="64,168,183,192">
33<area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="64,112,183,136">
34<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="64,56,183,80">
35<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="64,0,183,24">
36<area href="class_f_c_d_camera.html" alt="FCDCamera" shape="rect" coords="0,280,119,304">
37<area href="class_f_c_d_light.html" alt="FCDLight" shape="rect" coords="129,280,248,304">
38</map>
39<a href="class_f_c_d_targeted_entity-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_targeted_entity.html#1b8288f98ecd87c6d67c160fdbc84c8e">FCDTargetedEntity</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, const char *baseId)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#1b8288f98ecd87c6d67c160fdbc84c8e"></a><br></td></tr>
45<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_targeted_entity.html#6268c2e97f9ec39be2db72fd12acf7d9">~FCDTargetedEntity</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#6268c2e97f9ec39be2db72fd12acf7d9"></a><br></td></tr>
48<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_targeted_entity.html#a3b365694bdf46b5be98518607b66518">HasTarget</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether a target is defined for this entity.  <a href="#a3b365694bdf46b5be98518607b66518"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_targeted_entity.html#50896d5a2017ab08f63bb499e8c09343">GetTargetNode</a> ()</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the target visual scene node for this entity.  <a href="#50896d5a2017ab08f63bb499e8c09343"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9261ef2dc3b5d387fb62f52ea20efa21"></a><!-- doxytag: member="FCDTargetedEntity::GetTargetNode" ref="9261ef2dc3b5d387fb62f52ea20efa21" args="() const " -->
55const <a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_targeted_entity.html#9261ef2dc3b5d387fb62f52ea20efa21">GetTargetNode</a> () const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
58<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_targeted_entity.html#297fa32e4899f799318e814645772a35">SetTargetNode</a> (<a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *target)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the target visual scene node for this entity.  <a href="#297fa32e4899f799318e814645772a35"></a><br></td></tr>
61<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_targeted_entity.html#d3f0878fe55ef6c5a32702f1977c6aaa">LinkTarget</a> (<a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *sceneRoot)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Links the entity with its target.  <a href="#d3f0878fe55ef6c5a32702f1977c6aaa"></a><br></td></tr>
64<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
65<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_targeted_entity.html#4f67e2a078a3e484119f824f0c74e336">GetTargetId</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves the COLLADA id of the target entity.  <a href="#4f67e2a078a3e484119f824f0c74e336"></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_targeted_entity.html#0b0d7a81862faeb09c0f46d453ff2f26">SetTargetId</a> (const string &amp;_targetId)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Sets the COLLADA id of the target entity.  <a href="#0b0d7a81862faeb09c0f46d453ff2f26"></a><br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="806b1ee20575d1b0139ef0bab7bc1a91"></a><!-- doxytag: member="FCDTargetedEntity::SetTargetId" ref="806b1ee20575d1b0139ef0bab7bc1a91" args="(const char *_targetId)" -->
72void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_targeted_entity.html#806b1ee20575d1b0139ef0bab7bc1a91">SetTargetId</a> (const char *_targetId)</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
75</table>
76<hr><a name="_details"></a><h2>Detailed Description</h2>
77A targeted entity.
78<p>
79COLLADA doesn't have targeted entity. Therefore: the behavior of a targeted entity is application-defined.<p>
80This class is used to support 3dsMax's targeted cameras and lights and we also plan to support Maya's targeted cameras and lights.<p>
81<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="class_f_c_d_camera.html">FCDCamera</a> <a class="el" href="class_f_c_d_light.html">FCDLight</a> </dd></dl>
82
83<p>
84<hr><h2>Constructor &amp; Destructor Documentation</h2>
85<a class="anchor" name="1b8288f98ecd87c6d67c160fdbc84c8e"></a><!-- doxytag: member="FCDTargetedEntity::FCDTargetedEntity" ref="1b8288f98ecd87c6d67c160fdbc84c8e" args="(FCDocument *document, const char *baseId)" --><p>
86<table class="mdTable" cellpadding="2" cellspacing="0">
87  <tr>
88    <td class="mdRow">
89      <table cellpadding="0" cellspacing="0" border="0">
90        <tr>
91          <td class="md" nowrap valign="top">FCDTargetedEntity::FCDTargetedEntity           </td>
92          <td class="md" valign="top">(&nbsp;</td>
93          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
94          <td class="mdname" nowrap> <em>document</em>, </td>
95        </tr>
96        <tr>
97          <td class="md" nowrap align="right"></td>
98          <td class="md"></td>
99          <td class="md" nowrap>const char *&nbsp;</td>
100          <td class="mdname" nowrap> <em>baseId</em></td>
101        </tr>
102        <tr>
103          <td class="md"></td>
104          <td class="md">)&nbsp;</td>
105          <td class="md" colspan="2"></td>
106        </tr>
107      </table>
108    </td>
109  </tr>
110</table>
111<table cellspacing="5" cellpadding="0" border="0">
112  <tr>
113    <td>
114      &nbsp;
115    </td>
116    <td>
117
118<p>
119Constructor: do not use directly.
120<p>
121Instead, create objects of the up-classes. <dl compact><dt><b>Parameters:</b></dt><dd>
122  <table border="0" cellspacing="2" cellpadding="0">
123    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the targeted entity. </td></tr>
124    <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>
125  </table>
126</dl>
127    </td>
128  </tr>
129</table>
130<a class="anchor" name="6268c2e97f9ec39be2db72fd12acf7d9"></a><!-- doxytag: member="FCDTargetedEntity::~FCDTargetedEntity" ref="6268c2e97f9ec39be2db72fd12acf7d9" args="()" --><p>
131<table class="mdTable" cellpadding="2" cellspacing="0">
132  <tr>
133    <td class="mdRow">
134      <table cellpadding="0" cellspacing="0" border="0">
135        <tr>
136          <td class="md" nowrap valign="top">virtual FCDTargetedEntity::~FCDTargetedEntity           </td>
137          <td class="md" valign="top">(&nbsp;</td>
138          <td class="mdname1" valign="top" nowrap>          </td>
139          <td class="md" valign="top">&nbsp;)&nbsp;</td>
140          <td class="md" nowrap><code> [virtual]</code></td>
141        </tr>
142      </table>
143    </td>
144  </tr>
145</table>
146<table cellspacing="5" cellpadding="0" border="0">
147  <tr>
148    <td>
149      &nbsp;
150    </td>
151    <td>
152
153<p>
154Destructor: do not use directly.
155<p>
156Instead, release objects through their libraries or their parent entities.     </td>
157  </tr>
158</table>
159<hr><h2>Member Function Documentation</h2>
160<a class="anchor" name="4f67e2a078a3e484119f824f0c74e336"></a><!-- doxytag: member="FCDTargetedEntity::GetTargetId" ref="4f67e2a078a3e484119f824f0c74e336" 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">const string&amp; FCDTargetedEntity::GetTargetId           </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> [inline, protected]</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>
184[INTERNAL] Retrieves the COLLADA id of the target entity.
185<p>
186The actual resolution of the COLLADA id into a visual scene node happens during the LinkTarget function. <dl compact><dt><b>Returns:</b></dt><dd>The COLLADA id of the target entity. </dd></dl>
187    </td>
188  </tr>
189</table>
190<a class="anchor" name="50896d5a2017ab08f63bb499e8c09343"></a><!-- doxytag: member="FCDTargetedEntity::GetTargetNode" ref="50896d5a2017ab08f63bb499e8c09343" args="()" --><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_c_d_scene_node.html">FCDSceneNode</a>* FCDTargetedEntity::GetTargetNode           </td>
197          <td class="md" valign="top">(&nbsp;</td>
198          <td class="mdname1" valign="top" nowrap>          </td>
199          <td class="md" valign="top">&nbsp;)&nbsp;</td>
200          <td class="md" nowrap><code> [inline]</code></td>
201        </tr>
202      </table>
203    </td>
204  </tr>
205</table>
206<table cellspacing="5" cellpadding="0" border="0">
207  <tr>
208    <td>
209      &nbsp;
210    </td>
211    <td>
212
213<p>
214Retrieves the target visual scene node for this entity.
215<p>
216<dl compact><dt><b>Returns:</b></dt><dd>The target visual scene node. </dd></dl>
217    </td>
218  </tr>
219</table>
220<a class="anchor" name="a3b365694bdf46b5be98518607b66518"></a><!-- doxytag: member="FCDTargetedEntity::HasTarget" ref="a3b365694bdf46b5be98518607b66518" args="() const " --><p>
221<table class="mdTable" 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">bool FCDTargetedEntity::HasTarget           </td>
227          <td class="md" valign="top">(&nbsp;</td>
228          <td class="mdname1" valign="top" nowrap>          </td>
229          <td class="md" valign="top">&nbsp;)&nbsp;</td>
230          <td class="md" nowrap> const<code> [inline]</code></td>
231        </tr>
232      </table>
233    </td>
234  </tr>
235</table>
236<table cellspacing="5" cellpadding="0" border="0">
237  <tr>
238    <td>
239      &nbsp;
240    </td>
241    <td>
242
243<p>
244Retrieves whether a target is defined for this entity.
245<p>
246<dl compact><dt><b>Returns:</b></dt><dd>Whether a target is defined for this entity. </dd></dl>
247    </td>
248  </tr>
249</table>
250<a class="anchor" name="d3f0878fe55ef6c5a32702f1977c6aaa"></a><!-- doxytag: member="FCDTargetedEntity::LinkTarget" ref="d3f0878fe55ef6c5a32702f1977c6aaa" args="(FCDSceneNode *sceneRoot)" --><p>
251<table class="mdTable" cellpadding="2" cellspacing="0">
252  <tr>
253    <td class="mdRow">
254      <table cellpadding="0" cellspacing="0" border="0">
255        <tr>
256          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDTargetedEntity::LinkTarget           </td>
257          <td class="md" valign="top">(&nbsp;</td>
258          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td>
259          <td class="mdname1" valign="top" nowrap> <em>sceneRoot</em>          </td>
260          <td class="md" valign="top">&nbsp;)&nbsp;</td>
261          <td class="md" nowrap></td>
262        </tr>
263      </table>
264    </td>
265  </tr>
266</table>
267<table cellspacing="5" cellpadding="0" border="0">
268  <tr>
269    <td>
270      &nbsp;
271    </td>
272    <td>
273
274<p>
275[INTERNAL] Links the entity with its target.
276<p>
277This function is used during the import of a COLLADA document. <dl compact><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>Modify this function to support multiple visual scenes. </dd></dl>
278<dl compact><dt><b>Parameters:</b></dt><dd>
279  <table border="0" cellspacing="2" cellpadding="0">
280    <tr><td valign="top"></td><td valign="top"><em>sceneRoot</em>&nbsp;</td><td>The root visual scene. </td></tr>
281  </table>
282</dl>
283<dl compact><dt><b>Returns:</b></dt><dd>The status of the linkage. </dd></dl>
284    </td>
285  </tr>
286</table>
287<a class="anchor" name="0b0d7a81862faeb09c0f46d453ff2f26"></a><!-- doxytag: member="FCDTargetedEntity::SetTargetId" ref="0b0d7a81862faeb09c0f46d453ff2f26" args="(const string &amp;_targetId)" --><p>
288<table class="mdTable" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top">void FCDTargetedEntity::SetTargetId           </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
296          <td class="mdname1" valign="top" nowrap> <em>_targetId</em>          </td>
297          <td class="md" valign="top">&nbsp;)&nbsp;</td>
298          <td class="md" nowrap><code> [inline, protected]</code></td>
299        </tr>
300      </table>
301    </td>
302  </tr>
303</table>
304<table cellspacing="5" cellpadding="0" border="0">
305  <tr>
306    <td>
307      &nbsp;
308    </td>
309    <td>
310
311<p>
312[INTERNAL] Sets the COLLADA id of the target entity.
313<p>
314This function is used during the import of a COLLADA document. The actual resolution of the COLLADA id into a visual scene node happens during the LinkTarget function. <dl compact><dt><b>Parameters:</b></dt><dd>
315  <table border="0" cellspacing="2" cellpadding="0">
316    <tr><td valign="top"></td><td valign="top"><em>_targetId</em>&nbsp;</td><td>A COLLADA id. </td></tr>
317  </table>
318</dl>
319    </td>
320  </tr>
321</table>
322<a class="anchor" name="297fa32e4899f799318e814645772a35"></a><!-- doxytag: member="FCDTargetedEntity::SetTargetNode" ref="297fa32e4899f799318e814645772a35" args="(FCDSceneNode *target)" --><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">void FCDTargetedEntity::SetTargetNode           </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> *&nbsp;</td>
331          <td class="mdname1" valign="top" nowrap> <em>target</em>          </td>
332          <td class="md" valign="top">&nbsp;)&nbsp;</td>
333          <td class="md" nowrap></td>
334        </tr>
335      </table>
336    </td>
337  </tr>
338</table>
339<table cellspacing="5" cellpadding="0" border="0">
340  <tr>
341    <td>
342      &nbsp;
343    </td>
344    <td>
345
346<p>
347Sets the target visual scene node for this entity.
348<p>
349<dl compact><dt><b>Parameters:</b></dt><dd>
350  <table border="0" cellspacing="2" cellpadding="0">
351    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The new target node. </td></tr>
352  </table>
353</dl>
354    </td>
355  </tr>
356</table>
357<hr>The documentation for this class was generated from the following file:<ul>
358<li>FCDocument/<a class="el" href="_f_c_d_targeted_entity_8h-source.html">FCDTargetedEntity.h</a></ul>
359<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
360<a href="http://www.doxygen.org/index.html">
361<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
362</body>
363</html>
Note: See TracBrowser for help on using the repository browser.