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

Revision 964, 12.1 KB checked in by igarcia, 19 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: FCDETechnique 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>FCDETechnique 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="FCDETechnique" --><!-- doxytag: inherits="FCDENode" -->A COLLADA extra tree technique. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_extra_8h-source.html">FCDExtra.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDETechnique:
33<p><center><img src="class_f_c_d_e_technique.png" usemap="#FCDETechnique_map" border="0" alt=""></center>
34<map name="FCDETechnique_map">
35<area href="class_f_c_d_e_node.html" alt="FCDENode" shape="rect" coords="0,112,104,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,104,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,104,24">
38</map>
39<a href="class_f_c_d_e_technique-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_e_technique.html#0e369f1e11ea245d3bee1917b13f4304">FCDETechnique</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, const char *profile)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#0e369f1e11ea245d3bee1917b13f4304"></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_e_technique.html#6819c734ecb04b4a9715b5c5d2f0ad4d">~FCDETechnique</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#6819c734ecb04b4a9715b5c5d2f0ad4d"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_e_technique.html#f70bf2e36a2e43d218d9ef40d84d00c0">GetProfile</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the name of the application-specific profile of the technique.  <a href="#f70bf2e36a2e43d218d9ef40d84d00c0"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <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_e_technique.html#1c2ecc107e0660b2324e7ba16a84e1d6">LoadFromXML</a> (xmlNode *techniqueNode)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the extra tree technique from a given COLLADA XML tree node.  <a href="#1c2ecc107e0660b2324e7ba16a84e1d6"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_e_technique.html#547d38a7e34cad2a3961ec57800aba3b">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the extra tree technique to the given COLLADA XML tree node.  <a href="#547d38a7e34cad2a3961ec57800aba3b"></a><br></td></tr>
57</table>
58<hr><a name="_details"></a><h2>Detailed Description</h2>
59A COLLADA extra tree technique.
60<p>
61For convenience, this extra tree technique is based on top of the <a class="el" href="class_f_c_d_e_node.html">FCDENode</a> class. An extra tree technique is the root of the extra tree specific to the profile of an application.
62<p>
63<hr><h2>Constructor &amp; Destructor Documentation</h2>
64<a class="anchor" name="0e369f1e11ea245d3bee1917b13f4304"></a><!-- doxytag: member="FCDETechnique::FCDETechnique" ref="0e369f1e11ea245d3bee1917b13f4304" args="(FCDocument *document, const char *profile)" --><p>
65<table class="mdTable" cellpadding="2" cellspacing="0">
66  <tr>
67    <td class="mdRow">
68      <table cellpadding="0" cellspacing="0" border="0">
69        <tr>
70          <td class="md" nowrap valign="top">FCDETechnique::FCDETechnique           </td>
71          <td class="md" valign="top">(&nbsp;</td>
72          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
73          <td class="mdname" nowrap> <em>document</em>, </td>
74        </tr>
75        <tr>
76          <td class="md" nowrap align="right"></td>
77          <td class="md"></td>
78          <td class="md" nowrap>const char *&nbsp;</td>
79          <td class="mdname" nowrap> <em>profile</em></td>
80        </tr>
81        <tr>
82          <td class="md"></td>
83          <td class="md">)&nbsp;</td>
84          <td class="md" colspan="2"></td>
85        </tr>
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing="5" cellpadding="0" border="0">
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98Constructor: do not use directly.
99<p>
100Instead, use the <a class="el" href="class_f_c_d_extra.html#eaffbb73087542692d96246d46f6ac8a">FCDExtra::AddTechnique</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
101  <table border="0" cellspacing="2" cellpadding="0">
102    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the technique. </td></tr>
103    <tr><td valign="top"></td><td valign="top"><em>profile</em>&nbsp;</td><td>The application-specific profile name. </td></tr>
104  </table>
105</dl>
106    </td>
107  </tr>
108</table>
109<a class="anchor" name="6819c734ecb04b4a9715b5c5d2f0ad4d"></a><!-- doxytag: member="FCDETechnique::~FCDETechnique" ref="6819c734ecb04b4a9715b5c5d2f0ad4d" args="()" --><p>
110<table class="mdTable" cellpadding="2" cellspacing="0">
111  <tr>
112    <td class="mdRow">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top">virtual FCDETechnique::~FCDETechnique           </td>
116          <td class="md" valign="top">(&nbsp;</td>
117          <td class="mdname1" valign="top" nowrap>          </td>
118          <td class="md" valign="top">&nbsp;)&nbsp;</td>
119          <td class="md" nowrap><code> [virtual]</code></td>
120        </tr>
121      </table>
122    </td>
123  </tr>
124</table>
125<table cellspacing="5" cellpadding="0" border="0">
126  <tr>
127    <td>
128      &nbsp;
129    </td>
130    <td>
131
132<p>
133Destructor: do not use directly.
134<p>
135Instead, release a technique using the <a class="el" href="class_f_c_d_extra.html#6d27ff69f7e2e1adb2c7e5f18251df88">FCDExtra::ReleaseTechnique</a> function.     </td>
136  </tr>
137</table>
138<hr><h2>Member Function Documentation</h2>
139<a class="anchor" name="f70bf2e36a2e43d218d9ef40d84d00c0"></a><!-- doxytag: member="FCDETechnique::GetProfile" ref="f70bf2e36a2e43d218d9ef40d84d00c0" args="() const " --><p>
140<table class="mdTable" cellpadding="2" cellspacing="0">
141  <tr>
142    <td class="mdRow">
143      <table cellpadding="0" cellspacing="0" border="0">
144        <tr>
145          <td class="md" nowrap valign="top">const char* FCDETechnique::GetProfile           </td>
146          <td class="md" valign="top">(&nbsp;</td>
147          <td class="mdname1" valign="top" nowrap>          </td>
148          <td class="md" valign="top">&nbsp;)&nbsp;</td>
149          <td class="md" nowrap> const<code> [inline]</code></td>
150        </tr>
151      </table>
152    </td>
153  </tr>
154</table>
155<table cellspacing="5" cellpadding="0" border="0">
156  <tr>
157    <td>
158      &nbsp;
159    </td>
160    <td>
161
162<p>
163Retrieves the name of the application-specific profile of the technique.
164<p>
165<dl compact><dt><b>Returns:</b></dt><dd>The name of the application-specific profile. </dd></dl>
166    </td>
167  </tr>
168</table>
169<a class="anchor" name="1c2ecc107e0660b2324e7ba16a84e1d6"></a><!-- doxytag: member="FCDETechnique::LoadFromXML" ref="1c2ecc107e0660b2324e7ba16a84e1d6" args="(xmlNode *techniqueNode)" --><p>
170<table class="mdTable" cellpadding="2" cellspacing="0">
171  <tr>
172    <td class="mdRow">
173      <table cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDETechnique::LoadFromXML           </td>
176          <td class="md" valign="top">(&nbsp;</td>
177          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
178          <td class="mdname1" valign="top" nowrap> <em>techniqueNode</em>          </td>
179          <td class="md" valign="top">&nbsp;)&nbsp;</td>
180          <td class="md" nowrap><code> [virtual]</code></td>
181        </tr>
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing="5" cellpadding="0" border="0">
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194[INTERNAL] Reads in the extra tree technique from a given COLLADA XML tree node.
195<p>
196<dl compact><dt><b>Parameters:</b></dt><dd>
197  <table border="0" cellspacing="2" cellpadding="0">
198    <tr><td valign="top"></td><td valign="top"><em>techniqueNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
199  </table>
200</dl>
201<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 extra tree technique. </dd></dl>
202
203<p>
204Reimplemented from <a class="el" href="class_f_c_d_e_node.html#b557706fe76d8f16648300b5e4b76143">FCDENode</a>.    </td>
205  </tr>
206</table>
207<a class="anchor" name="547d38a7e34cad2a3961ec57800aba3b"></a><!-- doxytag: member="FCDETechnique::WriteToXML" ref="547d38a7e34cad2a3961ec57800aba3b" args="(xmlNode *parentNode) const " --><p>
208<table class="mdTable" cellpadding="2" cellspacing="0">
209  <tr>
210    <td class="mdRow">
211      <table cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td class="md" nowrap valign="top">virtual xmlNode* FCDETechnique::WriteToXML           </td>
214          <td class="md" valign="top">(&nbsp;</td>
215          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
216          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
217          <td class="md" valign="top">&nbsp;)&nbsp;</td>
218          <td class="md" nowrap> const<code> [virtual]</code></td>
219        </tr>
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing="5" cellpadding="0" border="0">
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232[INTERNAL] Writes out the extra tree technique to the given COLLADA XML tree node.
233<p>
234<dl compact><dt><b>Parameters:</b></dt><dd>
235  <table border="0" cellspacing="2" cellpadding="0">
236    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the extra tree technique. </td></tr>
237  </table>
238</dl>
239<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
240
241<p>
242Reimplemented from <a class="el" href="class_f_c_d_e_node.html#c108d9afc91036dfed87ca5088322862">FCDENode</a>.    </td>
243  </tr>
244</table>
245<hr>The documentation for this class was generated from the following file:<ul>
246<li>FCDocument/<a class="el" href="_f_c_d_extra_8h-source.html">FCDExtra.h</a></ul>
247<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
248<a href="http://www.doxygen.org/index.html">
249<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
250</body>
251</html>
Note: See TracBrowser for help on using the repository browser.