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: FCDEffectParameterFactory 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 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 Pages</span></a></li> |
---|
16 | </ul></div> |
---|
17 | <div class="tabs"> |
---|
18 | <ul> |
---|
19 | <li><a href="classes.html"><span>Alphabetical List</span></a></li> |
---|
20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
23 | </ul></div> |
---|
24 | <h1>FCDEffectParameterFactory Class Reference<br> |
---|
25 | <small> |
---|
26 | [<a class="el" href="group___f_c_d_effect.html">COLLADA Effect Classes [ColladaFX]</a>]</small> |
---|
27 | </h1><!-- doxytag: class="FCDEffectParameterFactory" -->[INTERNAL] The factory for COLLADA effect parameters. |
---|
28 | <a href="#_details">More...</a> |
---|
29 | <p> |
---|
30 | <code>#include <<a class="el" href="_f_c_d_effect_parameter_factory_8h-source.html">FCDEffectParameterFactory.h</a>></code> |
---|
31 | <p> |
---|
32 | <a href="class_f_c_d_effect_parameter_factory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
33 | <tr><td></td></tr> |
---|
34 | <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
---|
35 | <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_factory.html#c7e977b9b5957d00e7b548bea4004563">Create</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, uint32 type)</td></tr> |
---|
36 | |
---|
37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Creates a new effect parameter, given a type. <a href="#c7e977b9b5957d00e7b548bea4004563"></a><br></td></tr> |
---|
38 | <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_factory.html#d2b73392e38bffd67f7e174fc1f51eed">LoadFromXML</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, xmlNode *parameterNode, <a class="el" href="class_f_u_status.html">FUStatus</a> *status)</td></tr> |
---|
39 | |
---|
40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Generates the effect parameter object for the given XML node tree. <a href="#d2b73392e38bffd67f7e174fc1f51eed"></a><br></td></tr> |
---|
41 | </table> |
---|
42 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
43 | [INTERNAL] The factory for COLLADA effect parameters. |
---|
44 | <p> |
---|
45 | Takes in a COLLADA XML tree and returns a new parameter that represent it, if one is possible. |
---|
46 | <p> |
---|
47 | <hr><h2>Member Function Documentation</h2> |
---|
48 | <a class="anchor" name="c7e977b9b5957d00e7b548bea4004563"></a><!-- doxytag: member="FCDEffectParameterFactory::Create" ref="c7e977b9b5957d00e7b548bea4004563" args="(FCDocument *document, uint32 type)" --><p> |
---|
49 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
50 | <tr> |
---|
51 | <td class="mdRow"> |
---|
52 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
53 | <tr> |
---|
54 | <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterFactory::Create </td> |
---|
55 | <td class="md" valign="top">( </td> |
---|
56 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
57 | <td class="mdname" nowrap> <em>document</em>, </td> |
---|
58 | </tr> |
---|
59 | <tr> |
---|
60 | <td class="md" nowrap align="right"></td> |
---|
61 | <td class="md"></td> |
---|
62 | <td class="md" nowrap>uint32 </td> |
---|
63 | <td class="mdname" nowrap> <em>type</em></td> |
---|
64 | </tr> |
---|
65 | <tr> |
---|
66 | <td class="md"></td> |
---|
67 | <td class="md">) </td> |
---|
68 | <td class="md" colspan="2"><code> [static]</code></td> |
---|
69 | </tr> |
---|
70 | </table> |
---|
71 | </td> |
---|
72 | </tr> |
---|
73 | </table> |
---|
74 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
75 | <tr> |
---|
76 | <td> |
---|
77 | |
---|
78 | </td> |
---|
79 | <td> |
---|
80 | |
---|
81 | <p> |
---|
82 | [INTERNAL] Creates a new effect parameter, given a type. |
---|
83 | <p> |
---|
84 | To create new effect parameters, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#da878b47cabf114c520fdf70bf252a2c">FCDEffectParameterList::AddParameter</a> function. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
85 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
86 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that will own the effect parameter. </td></tr> |
---|
87 | <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The type of effect to create. This value should reflect the <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">FCDEffectParameter::Type</a> enum. </td></tr> |
---|
88 | </table> |
---|
89 | </dl> |
---|
90 | </td> |
---|
91 | </tr> |
---|
92 | </table> |
---|
93 | <a class="anchor" name="d2b73392e38bffd67f7e174fc1f51eed"></a><!-- doxytag: member="FCDEffectParameterFactory::LoadFromXML" ref="d2b73392e38bffd67f7e174fc1f51eed" args="(FCDocument *document, xmlNode *parameterNode, FUStatus *status)" --><p> |
---|
94 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
95 | <tr> |
---|
96 | <td class="mdRow"> |
---|
97 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
98 | <tr> |
---|
99 | <td class="md" nowrap valign="top">static <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterFactory::LoadFromXML </td> |
---|
100 | <td class="md" valign="top">( </td> |
---|
101 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
102 | <td class="mdname" nowrap> <em>document</em>, </td> |
---|
103 | </tr> |
---|
104 | <tr> |
---|
105 | <td class="md" nowrap align="right"></td> |
---|
106 | <td class="md"></td> |
---|
107 | <td class="md" nowrap>xmlNode * </td> |
---|
108 | <td class="mdname" nowrap> <em>parameterNode</em>, </td> |
---|
109 | </tr> |
---|
110 | <tr> |
---|
111 | <td class="md" nowrap align="right"></td> |
---|
112 | <td class="md"></td> |
---|
113 | <td class="md" nowrap><a class="el" href="class_f_u_status.html">FUStatus</a> * </td> |
---|
114 | <td class="mdname" nowrap> <em>status</em></td> |
---|
115 | </tr> |
---|
116 | <tr> |
---|
117 | <td class="md"></td> |
---|
118 | <td class="md">) </td> |
---|
119 | <td class="md" colspan="2"><code> [static]</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 | |
---|
129 | </td> |
---|
130 | <td> |
---|
131 | |
---|
132 | <p> |
---|
133 | [INTERNAL] Generates the effect parameter object for the given XML node tree. |
---|
134 | <p> |
---|
135 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
136 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
137 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that will own the effect parameter. </td></tr> |
---|
138 | <tr><td valign="top"></td><td valign="top"><em>parameterNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
139 | <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>An optional return status. </td></tr> |
---|
140 | </table> |
---|
141 | </dl> |
---|
142 | <dl compact><dt><b>Returns:</b></dt><dd>The new effect parameter. This pointer will be NULL if no parameter can be generated from the given COLLADA XML tree node. </dd></dl> |
---|
143 | </td> |
---|
144 | </tr> |
---|
145 | </table> |
---|
146 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
147 | <li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_factory_8h-source.html">FCDEffectParameterFactory.h</a></ul> |
---|
148 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by |
---|
149 | <a href="http://www.doxygen.org/index.html"> |
---|
150 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
151 | </body> |
---|
152 | </html> |
---|