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: FCDEffectParameter 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>FCDEffectParameter 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="FCDEffectParameter" --><!-- doxytag: inherits="FCDObject" -->A COLLADA effect parameter. |
---|
28 | <a href="#_details">More...</a> |
---|
29 | <p> |
---|
30 | <code>#include <<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a>></code> |
---|
31 | <p> |
---|
32 | <p>Inheritance diagram for FCDEffectParameter: |
---|
33 | <p><center><img src="class_f_c_d_effect_parameter.png" usemap="#FCDEffectParameter_map" border="0" alt=""></center> |
---|
34 | <map name="FCDEffectParameter_map"> |
---|
35 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,175,80"> |
---|
36 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,175,24"> |
---|
37 | <area href="class_f_c_d_effect_parameter_bool.html" alt="FCDEffectParameterBool" shape="rect" coords="185,168,360,192"> |
---|
38 | <area href="class_f_c_d_effect_parameter_float.html" alt="FCDEffectParameterFloat" shape="rect" coords="185,224,360,248"> |
---|
39 | <area href="class_f_c_d_effect_parameter_float2.html" alt="FCDEffectParameterFloat2" shape="rect" coords="185,280,360,304"> |
---|
40 | <area href="class_f_c_d_effect_parameter_float3.html" alt="FCDEffectParameterFloat3" shape="rect" coords="185,336,360,360"> |
---|
41 | <area href="class_f_c_d_effect_parameter_int.html" alt="FCDEffectParameterInt" shape="rect" coords="185,392,360,416"> |
---|
42 | <area href="class_f_c_d_effect_parameter_matrix.html" alt="FCDEffectParameterMatrix" shape="rect" coords="185,448,360,472"> |
---|
43 | <area href="class_f_c_d_effect_parameter_sampler.html" alt="FCDEffectParameterSampler" shape="rect" coords="185,504,360,528"> |
---|
44 | <area href="class_f_c_d_effect_parameter_string.html" alt="FCDEffectParameterString" shape="rect" coords="185,560,360,584"> |
---|
45 | <area href="class_f_c_d_effect_parameter_surface.html" alt="FCDEffectParameterSurface" shape="rect" coords="185,616,360,640"> |
---|
46 | <area href="class_f_c_d_effect_parameter_vector.html" alt="FCDEffectParameterVector" shape="rect" coords="185,672,360,696"> |
---|
47 | </map> |
---|
48 | <a href="class_f_c_d_effect_parameter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
49 | <tr><td></td></tr> |
---|
50 | <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
---|
51 | <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> { <br> |
---|
52 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b088f5ddd923615701f05a30158b80f56ec">SAMPLER</a>, |
---|
53 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08dd655617aa5a92725480964718122182">INTEGER</a>, |
---|
54 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08d40197d51fa800a31facae92a9dca91a">BOOLEAN</a>, |
---|
55 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b0887e8166fffd6cc3a8d39671b1346e469">FLOAT</a>, |
---|
56 | <br> |
---|
57 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b086d83a40ca335905a8a6877f001e6b52c">FLOAT2</a>, |
---|
58 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08a94c8dfc96b419a36c1de7ca2b6413c1">FLOAT3</a>, |
---|
59 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b084e0256ca9cff99b253d54ca218fde0f9">VECTOR</a>, |
---|
60 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08660e596914f88e50d5853b2131ad225a">MATRIX</a>, |
---|
61 | <br> |
---|
62 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b081b235e6d5cb68e8bcd13443795252e0a">STRING</a>, |
---|
63 | <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08217a1f4ad8b74ced28de295ab6de116b">SURFACE</a> |
---|
64 | <br> |
---|
65 | }</td></tr> |
---|
66 | |
---|
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The type of the effect parameter class. <a href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">More...</a><br></td></tr> |
---|
68 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
69 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#ab5e11cc5f59d90be17fd8db28146826">FCDEffectParameter</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
70 | |
---|
71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#ab5e11cc5f59d90be17fd8db28146826"></a><br></td></tr> |
---|
72 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#80eeeb7eb1d1e957d850da0409e7752c">~FCDEffectParameter</a> ()</td></tr> |
---|
73 | |
---|
74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#80eeeb7eb1d1e957d850da0409e7752c"></a><br></td></tr> |
---|
75 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">GetType</a> () const =0</td></tr> |
---|
76 | |
---|
77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of effect parameter class. <a href="#5858946f333ea4486ca30c4c1b104871"></a><br></td></tr> |
---|
78 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#9bf5fa613c3374f7a0ecbf0795df311f">GetReference</a> () const </td></tr> |
---|
79 | |
---|
80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reference for this effect parameter. <a href="#9bf5fa613c3374f7a0ecbf0795df311f"></a><br></td></tr> |
---|
81 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#6aab49ab02fb2f1b7393fd5e8d929008">GetSemantic</a> () const </td></tr> |
---|
82 | |
---|
83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the semantic for this effect parameter. <a href="#6aab49ab02fb2f1b7393fd5e8d929008"></a><br></td></tr> |
---|
84 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#bc0f7d843a976115d5b413c59700a230">SetSemantic</a> (const string &_semantic)</td></tr> |
---|
85 | |
---|
86 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the semantic for this effect parameter. <a href="#bc0f7d843a976115d5b413c59700a230"></a><br></td></tr> |
---|
87 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#a77e878bbff4b0d7a85c3f08e46bb206">IsGenerator</a> () const </td></tr> |
---|
88 | |
---|
89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether this effect parameter is a parameter generator. <a href="#a77e878bbff4b0d7a85c3f08e46bb206"></a><br></td></tr> |
---|
90 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#f0270639bc9e73ca45c15fbbebdc8066">IsModifier</a> () const </td></tr> |
---|
91 | |
---|
92 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether this effect parameter is a parameter modifier. <a href="#f0270639bc9e73ca45c15fbbebdc8066"></a><br></td></tr> |
---|
93 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#b621789fd1af2279c712b83efb35f807">GetBindSymbol</a> () const </td></tr> |
---|
94 | |
---|
95 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#ad32aa763bceb364a6bb7bf9dba8292f">SetBindSymbol</a> (const string &_bindSymbol)</td></tr> |
---|
96 | |
---|
97 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#15272d55d87c60f603049caa2b96c4f4">IsFragment</a> () const </td></tr> |
---|
98 | |
---|
99 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#61f99760b80147aabb65d01051509347">SetFragment</a> (bool _isFragment)</td></tr> |
---|
100 | |
---|
101 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <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.html#760f178513367b602f7c3363a158b76e">Clone</a> ()=0</td></tr> |
---|
102 | |
---|
103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a full copy of the effect parameter. <a href="#760f178513367b602f7c3363a158b76e"></a><br></td></tr> |
---|
104 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr> |
---|
105 | |
---|
106 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter. <a href="#016be91dbd27ff3c8c30f759f00b8c53"></a><br></td></tr> |
---|
107 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">LoadFromXML</a> (xmlNode *parameterNode)</td></tr> |
---|
108 | |
---|
109 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. <a href="#c9dacd1e9af15e71f54daf59b3f142fd"></a><br></td></tr> |
---|
110 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
111 | |
---|
112 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. <a href="#71aaa548d040bdae0af136f250262ea5"></a><br></td></tr> |
---|
113 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
114 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter.html#d9356add6ab8b9c57907aceeaaeac4df">Clone</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *clone)</td></tr> |
---|
115 | |
---|
116 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Copies into the given effect parameters, the variables held by the <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> interface. <a href="#d9356add6ab8b9c57907aceeaaeac4df"></a><br></td></tr> |
---|
117 | </table> |
---|
118 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
119 | A COLLADA effect parameter. |
---|
120 | <p> |
---|
121 | This interface class is used to define all the valid ColladaFX parameter types. There are many types of parameters: integers, booleans, floating-point values, 2D, 3D and 4D vectors of floating-point values, matrices, strings, surfaces and their samplers.<p> |
---|
122 | A COLLADA effect parameter may generate a new effect parameter, in which case it will declare a semantic and a reference: to represent it within the COLLADA document. |
---|
123 | <p> |
---|
124 | <hr><h2>Member Enumeration Documentation</h2> |
---|
125 | <a class="anchor" name="1efe74553d2ed199435085c171743b08"></a><!-- doxytag: member="FCDEffectParameter::Type" ref="1efe74553d2ed199435085c171743b08" args="" --><p> |
---|
126 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
127 | <tr> |
---|
128 | <td class="mdRow"> |
---|
129 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
130 | <tr> |
---|
131 | <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">FCDEffectParameter::Type</a> </td> |
---|
132 | </tr> |
---|
133 | </table> |
---|
134 | </td> |
---|
135 | </tr> |
---|
136 | </table> |
---|
137 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
138 | <tr> |
---|
139 | <td> |
---|
140 | |
---|
141 | </td> |
---|
142 | <td> |
---|
143 | |
---|
144 | <p> |
---|
145 | The type of the effect parameter class. |
---|
146 | <p> |
---|
147 | <dl compact><dt><b>Enumerator: </b></dt><dd> |
---|
148 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
149 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b088f5ddd923615701f05a30158b80f56ec"></a><!-- doxytag: member="SAMPLER" ref="1efe74553d2ed199435085c171743b088f5ddd923615701f05a30158b80f56ec" args="" -->SAMPLER</em> </td><td> |
---|
150 | A sampler effect parameter. |
---|
151 | <p> |
---|
152 | Points towards a surface parameter and adds extra texturing parameters. </td></tr> |
---|
153 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b08dd655617aa5a92725480964718122182"></a><!-- doxytag: member="INTEGER" ref="1efe74553d2ed199435085c171743b08dd655617aa5a92725480964718122182" args="" -->INTEGER</em> </td><td> |
---|
154 | A single integer effect parameter. </td></tr> |
---|
155 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b08d40197d51fa800a31facae92a9dca91a"></a><!-- doxytag: member="BOOLEAN" ref="1efe74553d2ed199435085c171743b08d40197d51fa800a31facae92a9dca91a" args="" -->BOOLEAN</em> </td><td> |
---|
156 | A single boolean effect parameter. </td></tr> |
---|
157 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b0887e8166fffd6cc3a8d39671b1346e469"></a><!-- doxytag: member="FLOAT" ref="1efe74553d2ed199435085c171743b0887e8166fffd6cc3a8d39671b1346e469" args="" -->FLOAT</em> </td><td> |
---|
158 | A single floating-pointer value effect parameter. </td></tr> |
---|
159 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b086d83a40ca335905a8a6877f001e6b52c"></a><!-- doxytag: member="FLOAT2" ref="1efe74553d2ed199435085c171743b086d83a40ca335905a8a6877f001e6b52c" args="" -->FLOAT2</em> </td><td> |
---|
160 | A 2D vector of floating-pointer values. </td></tr> |
---|
161 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b08a94c8dfc96b419a36c1de7ca2b6413c1"></a><!-- doxytag: member="FLOAT3" ref="1efe74553d2ed199435085c171743b08a94c8dfc96b419a36c1de7ca2b6413c1" args="" -->FLOAT3</em> </td><td> |
---|
162 | A 3D vector of floating-pointer values. </td></tr> |
---|
163 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b084e0256ca9cff99b253d54ca218fde0f9"></a><!-- doxytag: member="VECTOR" ref="1efe74553d2ed199435085c171743b084e0256ca9cff99b253d54ca218fde0f9" args="" -->VECTOR</em> </td><td> |
---|
164 | A 4D vector of floating-pointer values. </td></tr> |
---|
165 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b08660e596914f88e50d5853b2131ad225a"></a><!-- doxytag: member="MATRIX" ref="1efe74553d2ed199435085c171743b08660e596914f88e50d5853b2131ad225a" args="" -->MATRIX</em> </td><td> |
---|
166 | A 4x4 matrix. </td></tr> |
---|
167 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b081b235e6d5cb68e8bcd13443795252e0a"></a><!-- doxytag: member="STRING" ref="1efe74553d2ed199435085c171743b081b235e6d5cb68e8bcd13443795252e0a" args="" -->STRING</em> </td><td> |
---|
168 | A string effect parameter. </td></tr> |
---|
169 | <tr><td valign="top"><em><a class="anchor" name="1efe74553d2ed199435085c171743b08217a1f4ad8b74ced28de295ab6de116b"></a><!-- doxytag: member="SURFACE" ref="1efe74553d2ed199435085c171743b08217a1f4ad8b74ced28de295ab6de116b" args="" -->SURFACE</em> </td><td> |
---|
170 | A surface effect parameter. |
---|
171 | <p> |
---|
172 | Contains a COLLADA image pointer. </td></tr> |
---|
173 | </table> |
---|
174 | </dl> |
---|
175 | </td> |
---|
176 | </tr> |
---|
177 | </table> |
---|
178 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
179 | <a class="anchor" name="ab5e11cc5f59d90be17fd8db28146826"></a><!-- doxytag: member="FCDEffectParameter::FCDEffectParameter" ref="ab5e11cc5f59d90be17fd8db28146826" args="(FCDocument *document)" --><p> |
---|
180 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
181 | <tr> |
---|
182 | <td class="mdRow"> |
---|
183 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
184 | <tr> |
---|
185 | <td class="md" nowrap valign="top">FCDEffectParameter::FCDEffectParameter </td> |
---|
186 | <td class="md" valign="top">( </td> |
---|
187 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
188 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
189 | <td class="md" valign="top"> ) </td> |
---|
190 | <td class="md" nowrap></td> |
---|
191 | </tr> |
---|
192 | </table> |
---|
193 | </td> |
---|
194 | </tr> |
---|
195 | </table> |
---|
196 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
197 | <tr> |
---|
198 | <td> |
---|
199 | |
---|
200 | </td> |
---|
201 | <td> |
---|
202 | |
---|
203 | <p> |
---|
204 | Constructor: do not use directly. |
---|
205 | <p> |
---|
206 | Instead, 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> |
---|
207 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
208 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the effect parameter. </td></tr> |
---|
209 | </table> |
---|
210 | </dl> |
---|
211 | </td> |
---|
212 | </tr> |
---|
213 | </table> |
---|
214 | <a class="anchor" name="80eeeb7eb1d1e957d850da0409e7752c"></a><!-- doxytag: member="FCDEffectParameter::~FCDEffectParameter" ref="80eeeb7eb1d1e957d850da0409e7752c" args="()" --><p> |
---|
215 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
216 | <tr> |
---|
217 | <td class="mdRow"> |
---|
218 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
219 | <tr> |
---|
220 | <td class="md" nowrap valign="top">virtual FCDEffectParameter::~FCDEffectParameter </td> |
---|
221 | <td class="md" valign="top">( </td> |
---|
222 | <td class="mdname1" valign="top" nowrap> </td> |
---|
223 | <td class="md" valign="top"> ) </td> |
---|
224 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
225 | </tr> |
---|
226 | </table> |
---|
227 | </td> |
---|
228 | </tr> |
---|
229 | </table> |
---|
230 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
231 | <tr> |
---|
232 | <td> |
---|
233 | |
---|
234 | </td> |
---|
235 | <td> |
---|
236 | |
---|
237 | <p> |
---|
238 | Destructor: do not use directly. |
---|
239 | <p> |
---|
240 | Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#b5ef02e0d258871d25d75666e199a9f3">FCDEffectParameterList::ReleaseParameter</a> function. When released, the effect parameter list will also release all its parameters, if it owns them. </td> |
---|
241 | </tr> |
---|
242 | </table> |
---|
243 | <hr><h2>Member Function Documentation</h2> |
---|
244 | <a class="anchor" name="d9356add6ab8b9c57907aceeaaeac4df"></a><!-- doxytag: member="FCDEffectParameter::Clone" ref="d9356add6ab8b9c57907aceeaaeac4df" args="(FCDEffectParameter *clone)" --><p> |
---|
245 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
246 | <tr> |
---|
247 | <td class="mdRow"> |
---|
248 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
249 | <tr> |
---|
250 | <td class="md" nowrap valign="top">void FCDEffectParameter::Clone </td> |
---|
251 | <td class="md" valign="top">( </td> |
---|
252 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td> |
---|
253 | <td class="mdname1" valign="top" nowrap> <em>clone</em> </td> |
---|
254 | <td class="md" valign="top"> ) </td> |
---|
255 | <td class="md" nowrap><code> [protected]</code></td> |
---|
256 | </tr> |
---|
257 | </table> |
---|
258 | </td> |
---|
259 | </tr> |
---|
260 | </table> |
---|
261 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
262 | <tr> |
---|
263 | <td> |
---|
264 | |
---|
265 | </td> |
---|
266 | <td> |
---|
267 | |
---|
268 | <p> |
---|
269 | [INTERNAL] Copies into the given effect parameters, the variables held by the <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> interface. |
---|
270 | <p> |
---|
271 | This function is used by the classes based on this interface during the cloning process. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
272 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
273 | <tr><td valign="top"></td><td valign="top"><em>clone</em> </td><td>The parameter to clone. </td></tr> |
---|
274 | </table> |
---|
275 | </dl> |
---|
276 | </td> |
---|
277 | </tr> |
---|
278 | </table> |
---|
279 | <a class="anchor" name="760f178513367b602f7c3363a158b76e"></a><!-- doxytag: member="FCDEffectParameter::Clone" ref="760f178513367b602f7c3363a158b76e" args="()=0" --><p> |
---|
280 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
281 | <tr> |
---|
282 | <td class="mdRow"> |
---|
283 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
284 | <tr> |
---|
285 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameter::Clone </td> |
---|
286 | <td class="md" valign="top">( </td> |
---|
287 | <td class="mdname1" valign="top" nowrap> </td> |
---|
288 | <td class="md" valign="top"> ) </td> |
---|
289 | <td class="md" nowrap><code> [pure virtual]</code></td> |
---|
290 | </tr> |
---|
291 | </table> |
---|
292 | </td> |
---|
293 | </tr> |
---|
294 | </table> |
---|
295 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
296 | <tr> |
---|
297 | <td> |
---|
298 | |
---|
299 | </td> |
---|
300 | <td> |
---|
301 | |
---|
302 | <p> |
---|
303 | Creates a full copy of the effect parameter. |
---|
304 | <p> |
---|
305 | <dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl> |
---|
306 | |
---|
307 | <p> |
---|
308 | Implemented in <a class="el" href="class_f_c_d_effect_parameter_sampler.html#fa71662d4d3b00dcb800613879ee6c36">FCDEffectParameterSampler</a>, <a class="el" href="class_f_c_d_effect_parameter_int.html#2f777fbb9048bfb755084afc0bfbec5a">FCDEffectParameterInt</a>, <a class="el" href="class_f_c_d_effect_parameter_bool.html#bd7cb3640e93bf4ea69208720da2f0d8">FCDEffectParameterBool</a>, <a class="el" href="class_f_c_d_effect_parameter_string.html#cc9085932d1f4ee32231cabdf03a6222">FCDEffectParameterString</a>, <a class="el" href="class_f_c_d_effect_parameter_float.html#cfc0102eb8b7250010b0bb7c416b4a0f">FCDEffectParameterFloat</a>, <a class="el" href="class_f_c_d_effect_parameter_float2.html#f1bac59327d3094462b54e83969f24b7">FCDEffectParameterFloat2</a>, <a class="el" href="class_f_c_d_effect_parameter_float3.html#745c67bd0348bb429f3840e244fbcd02">FCDEffectParameterFloat3</a>, <a class="el" href="class_f_c_d_effect_parameter_vector.html#6efb851221ef887ef061fcd52b97c2eb">FCDEffectParameterVector</a>, <a class="el" href="class_f_c_d_effect_parameter_matrix.html#e72474403ac243b49d923d9f34c69ca7">FCDEffectParameterMatrix</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface.html#b9ade5c8f79c22fdd0e001f73a1504b8">FCDEffectParameterSurface</a>. </td> |
---|
309 | </tr> |
---|
310 | </table> |
---|
311 | <a class="anchor" name="b621789fd1af2279c712b83efb35f807"></a><!-- doxytag: member="FCDEffectParameter::GetBindSymbol" ref="b621789fd1af2279c712b83efb35f807" args="() const " --><p> |
---|
312 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
313 | <tr> |
---|
314 | <td class="mdRow"> |
---|
315 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
316 | <tr> |
---|
317 | <td class="md" nowrap valign="top">const string& FCDEffectParameter::GetBindSymbol </td> |
---|
318 | <td class="md" valign="top">( </td> |
---|
319 | <td class="mdname1" valign="top" nowrap> </td> |
---|
320 | <td class="md" valign="top"> ) </td> |
---|
321 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
322 | </tr> |
---|
323 | </table> |
---|
324 | </td> |
---|
325 | </tr> |
---|
326 | </table> |
---|
327 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
328 | <tr> |
---|
329 | <td> |
---|
330 | |
---|
331 | </td> |
---|
332 | <td> |
---|
333 | |
---|
334 | <p> |
---|
335 | <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Retrieves the program bind symbol for this parameter. This information should be available per-shader, in the <a class="el" href="class_f_c_d_effect_pass_shader.html">FCDEffectPassShader</a> class. </dd></dl> |
---|
336 | <dl compact><dt><b>Returns:</b></dt><dd>The program bind symbol. </dd></dl> |
---|
337 | </td> |
---|
338 | </tr> |
---|
339 | </table> |
---|
340 | <a class="anchor" name="9bf5fa613c3374f7a0ecbf0795df311f"></a><!-- doxytag: member="FCDEffectParameter::GetReference" ref="9bf5fa613c3374f7a0ecbf0795df311f" args="() const " --><p> |
---|
341 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
342 | <tr> |
---|
343 | <td class="mdRow"> |
---|
344 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
345 | <tr> |
---|
346 | <td class="md" nowrap valign="top">const string& FCDEffectParameter::GetReference </td> |
---|
347 | <td class="md" valign="top">( </td> |
---|
348 | <td class="mdname1" valign="top" nowrap> </td> |
---|
349 | <td class="md" valign="top"> ) </td> |
---|
350 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
351 | </tr> |
---|
352 | </table> |
---|
353 | </td> |
---|
354 | </tr> |
---|
355 | </table> |
---|
356 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
357 | <tr> |
---|
358 | <td> |
---|
359 | |
---|
360 | </td> |
---|
361 | <td> |
---|
362 | |
---|
363 | <p> |
---|
364 | Retrieves the reference for this effect parameter. |
---|
365 | <p> |
---|
366 | In the case of generators, the reference string contains the sub-id. <dl compact><dt><b>Returns:</b></dt><dd>The reference. </dd></dl> |
---|
367 | </td> |
---|
368 | </tr> |
---|
369 | </table> |
---|
370 | <a class="anchor" name="6aab49ab02fb2f1b7393fd5e8d929008"></a><!-- doxytag: member="FCDEffectParameter::GetSemantic" ref="6aab49ab02fb2f1b7393fd5e8d929008" args="() const " --><p> |
---|
371 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
372 | <tr> |
---|
373 | <td class="mdRow"> |
---|
374 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
375 | <tr> |
---|
376 | <td class="md" nowrap valign="top">const string& FCDEffectParameter::GetSemantic </td> |
---|
377 | <td class="md" valign="top">( </td> |
---|
378 | <td class="mdname1" valign="top" nowrap> </td> |
---|
379 | <td class="md" valign="top"> ) </td> |
---|
380 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
381 | </tr> |
---|
382 | </table> |
---|
383 | </td> |
---|
384 | </tr> |
---|
385 | </table> |
---|
386 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
387 | <tr> |
---|
388 | <td> |
---|
389 | |
---|
390 | </td> |
---|
391 | <td> |
---|
392 | |
---|
393 | <p> |
---|
394 | Retrieves the semantic for this effect parameter. |
---|
395 | <p> |
---|
396 | <dl compact><dt><b>Returns:</b></dt><dd>The semantic. </dd></dl> |
---|
397 | </td> |
---|
398 | </tr> |
---|
399 | </table> |
---|
400 | <a class="anchor" name="5858946f333ea4486ca30c4c1b104871"></a><!-- doxytag: member="FCDEffectParameter::GetType" ref="5858946f333ea4486ca30c4c1b104871" args="() const =0" --><p> |
---|
401 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
402 | <tr> |
---|
403 | <td class="mdRow"> |
---|
404 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
405 | <tr> |
---|
406 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameter::GetType </td> |
---|
407 | <td class="md" valign="top">( </td> |
---|
408 | <td class="mdname1" valign="top" nowrap> </td> |
---|
409 | <td class="md" valign="top"> ) </td> |
---|
410 | <td class="md" nowrap> const<code> [pure virtual]</code></td> |
---|
411 | </tr> |
---|
412 | </table> |
---|
413 | </td> |
---|
414 | </tr> |
---|
415 | </table> |
---|
416 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
417 | <tr> |
---|
418 | <td> |
---|
419 | |
---|
420 | </td> |
---|
421 | <td> |
---|
422 | |
---|
423 | <p> |
---|
424 | Retrieves the type of effect parameter class. |
---|
425 | <p> |
---|
426 | <dl compact><dt><b>Returns:</b></dt><dd>The type of the effect parameter class. </dd></dl> |
---|
427 | |
---|
428 | <p> |
---|
429 | Implemented in <a class="el" href="class_f_c_d_effect_parameter_sampler.html#b0483ddfcc3c69f12539df9fba36f0d6">FCDEffectParameterSampler</a>, <a class="el" href="class_f_c_d_effect_parameter_int.html#fc360d159fbb45443c3f8dcb85ad3d45">FCDEffectParameterInt</a>, <a class="el" href="class_f_c_d_effect_parameter_bool.html#9dcd9b8cfdd28ac8ed1d077a06f310c3">FCDEffectParameterBool</a>, <a class="el" href="class_f_c_d_effect_parameter_string.html#a9b5be86f3ea1f3f88bdaa37b14faeb9">FCDEffectParameterString</a>, <a class="el" href="class_f_c_d_effect_parameter_float.html#a5f935f8cce027dabe4f817c5fc9f79f">FCDEffectParameterFloat</a>, <a class="el" href="class_f_c_d_effect_parameter_float2.html#ffc19911b3553e8a495004123b1df4aa">FCDEffectParameterFloat2</a>, <a class="el" href="class_f_c_d_effect_parameter_float3.html#6c9681855b3fd4c4a7677bee899bbcbe">FCDEffectParameterFloat3</a>, <a class="el" href="class_f_c_d_effect_parameter_vector.html#9390bbea2590e2d49ad2341925b069f9">FCDEffectParameterVector</a>, <a class="el" href="class_f_c_d_effect_parameter_matrix.html#54ef3af47e1e0f2c789cc02d2114171a">FCDEffectParameterMatrix</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface.html#48e1ec0933996bc9ebb5ef1ec9b8e334">FCDEffectParameterSurface</a>. </td> |
---|
430 | </tr> |
---|
431 | </table> |
---|
432 | <a class="anchor" name="15272d55d87c60f603049caa2b96c4f4"></a><!-- doxytag: member="FCDEffectParameter::IsFragment" ref="15272d55d87c60f603049caa2b96c4f4" args="() const " --><p> |
---|
433 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
434 | <tr> |
---|
435 | <td class="mdRow"> |
---|
436 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
437 | <tr> |
---|
438 | <td class="md" nowrap valign="top">bool FCDEffectParameter::IsFragment </td> |
---|
439 | <td class="md" valign="top">( </td> |
---|
440 | <td class="mdname1" valign="top" nowrap> </td> |
---|
441 | <td class="md" valign="top"> ) </td> |
---|
442 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
443 | </tr> |
---|
444 | </table> |
---|
445 | </td> |
---|
446 | </tr> |
---|
447 | </table> |
---|
448 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
449 | <tr> |
---|
450 | <td> |
---|
451 | |
---|
452 | </td> |
---|
453 | <td> |
---|
454 | |
---|
455 | <p> |
---|
456 | <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Retrieves whether the program bind symbol attached to this parameter belongs to a fragment/pixel shader. This information is available per-shader, in the <a class="el" href="class_f_c_d_effect_pass_shader.html">FCDEffectPassShader</a> class. </dd></dl> |
---|
457 | <dl compact><dt><b>Returns:</b></dt><dd>Whether it belongs to a fragment/pixel shader. </dd></dl> |
---|
458 | </td> |
---|
459 | </tr> |
---|
460 | </table> |
---|
461 | <a class="anchor" name="a77e878bbff4b0d7a85c3f08e46bb206"></a><!-- doxytag: member="FCDEffectParameter::IsGenerator" ref="a77e878bbff4b0d7a85c3f08e46bb206" args="() const " --><p> |
---|
462 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
463 | <tr> |
---|
464 | <td class="mdRow"> |
---|
465 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
466 | <tr> |
---|
467 | <td class="md" nowrap valign="top">bool FCDEffectParameter::IsGenerator </td> |
---|
468 | <td class="md" valign="top">( </td> |
---|
469 | <td class="mdname1" valign="top" nowrap> </td> |
---|
470 | <td class="md" valign="top"> ) </td> |
---|
471 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
472 | </tr> |
---|
473 | </table> |
---|
474 | </td> |
---|
475 | </tr> |
---|
476 | </table> |
---|
477 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
478 | <tr> |
---|
479 | <td> |
---|
480 | |
---|
481 | </td> |
---|
482 | <td> |
---|
483 | |
---|
484 | <p> |
---|
485 | Retrieves whether this effect parameter is a parameter generator. |
---|
486 | <p> |
---|
487 | A ColladaFX parameter must be generated to be modified or bound at higher abstraction levels. <dl compact><dt><b>Returns:</b></dt><dd>Whether this is a generator. </dd></dl> |
---|
488 | </td> |
---|
489 | </tr> |
---|
490 | </table> |
---|
491 | <a class="anchor" name="f0270639bc9e73ca45c15fbbebdc8066"></a><!-- doxytag: member="FCDEffectParameter::IsModifier" ref="f0270639bc9e73ca45c15fbbebdc8066" args="() const " --><p> |
---|
492 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
493 | <tr> |
---|
494 | <td class="mdRow"> |
---|
495 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
496 | <tr> |
---|
497 | <td class="md" nowrap valign="top">bool FCDEffectParameter::IsModifier </td> |
---|
498 | <td class="md" valign="top">( </td> |
---|
499 | <td class="mdname1" valign="top" nowrap> </td> |
---|
500 | <td class="md" valign="top"> ) </td> |
---|
501 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
502 | </tr> |
---|
503 | </table> |
---|
504 | </td> |
---|
505 | </tr> |
---|
506 | </table> |
---|
507 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
508 | <tr> |
---|
509 | <td> |
---|
510 | |
---|
511 | </td> |
---|
512 | <td> |
---|
513 | |
---|
514 | <p> |
---|
515 | Retrieves whether this effect parameter is a parameter modifier. |
---|
516 | <p> |
---|
517 | A ColladaFX parameter must be generated to be modified or bound at higher abstraction levels. <dl compact><dt><b>Returns:</b></dt><dd>Whether this is a modifier. </dd></dl> |
---|
518 | </td> |
---|
519 | </tr> |
---|
520 | </table> |
---|
521 | <a class="anchor" name="c9dacd1e9af15e71f54daf59b3f142fd"></a><!-- doxytag: member="FCDEffectParameter::LoadFromXML" ref="c9dacd1e9af15e71f54daf59b3f142fd" args="(xmlNode *parameterNode)" --><p> |
---|
522 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
523 | <tr> |
---|
524 | <td class="mdRow"> |
---|
525 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
526 | <tr> |
---|
527 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameter::LoadFromXML </td> |
---|
528 | <td class="md" valign="top">( </td> |
---|
529 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
530 | <td class="mdname1" valign="top" nowrap> <em>parameterNode</em> </td> |
---|
531 | <td class="md" valign="top"> ) </td> |
---|
532 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
533 | </tr> |
---|
534 | </table> |
---|
535 | </td> |
---|
536 | </tr> |
---|
537 | </table> |
---|
538 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
539 | <tr> |
---|
540 | <td> |
---|
541 | |
---|
542 | </td> |
---|
543 | <td> |
---|
544 | |
---|
545 | <p> |
---|
546 | [INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. |
---|
547 | <p> |
---|
548 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
549 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
550 | <tr><td valign="top"></td><td valign="top"><em>parameterNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
551 | </table> |
---|
552 | </dl> |
---|
553 | <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 parameter. </dd></dl> |
---|
554 | |
---|
555 | <p> |
---|
556 | Reimplemented in <a class="el" href="class_f_c_d_effect_parameter_sampler.html#670e66d4476754540e0e72f9d02f45fe">FCDEffectParameterSampler</a>, <a class="el" href="class_f_c_d_effect_parameter_int.html#6dbff43e3ccbe38f4254ca6c6f902450">FCDEffectParameterInt</a>, <a class="el" href="class_f_c_d_effect_parameter_bool.html#36e922356a5bbee4965c14cbd5bd0cfa">FCDEffectParameterBool</a>, <a class="el" href="class_f_c_d_effect_parameter_string.html#d4e95cfb2f2ae39eca07a8f6adc24092">FCDEffectParameterString</a>, <a class="el" href="class_f_c_d_effect_parameter_float.html#d96a98dbd64fd64a8cb1761d89181c3c">FCDEffectParameterFloat</a>, <a class="el" href="class_f_c_d_effect_parameter_float2.html#ae5130f0993b455533fdbf0016663802">FCDEffectParameterFloat2</a>, <a class="el" href="class_f_c_d_effect_parameter_float3.html#7b1c21d3b681b30fa5af323585704f55">FCDEffectParameterFloat3</a>, <a class="el" href="class_f_c_d_effect_parameter_vector.html#e186731839ff9857efc9b5241234f220">FCDEffectParameterVector</a>, <a class="el" href="class_f_c_d_effect_parameter_matrix.html#7d9b030ae9c35d9c343e41e6bd816774">FCDEffectParameterMatrix</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface.html#c21a50c6bb603ff70d771e5cac5d8f4c">FCDEffectParameterSurface</a>. </td> |
---|
557 | </tr> |
---|
558 | </table> |
---|
559 | <a class="anchor" name="016be91dbd27ff3c8c30f759f00b8c53"></a><!-- doxytag: member="FCDEffectParameter::Overwrite" ref="016be91dbd27ff3c8c30f759f00b8c53" args="(FCDEffectParameter *target)" --><p> |
---|
560 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
561 | <tr> |
---|
562 | <td class="mdRow"> |
---|
563 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
564 | <tr> |
---|
565 | <td class="md" nowrap valign="top">virtual void FCDEffectParameter::Overwrite </td> |
---|
566 | <td class="md" valign="top">( </td> |
---|
567 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td> |
---|
568 | <td class="mdname1" valign="top" nowrap> <em>target</em> </td> |
---|
569 | <td class="md" valign="top"> ) </td> |
---|
570 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
571 | </tr> |
---|
572 | </table> |
---|
573 | </td> |
---|
574 | </tr> |
---|
575 | </table> |
---|
576 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
577 | <tr> |
---|
578 | <td> |
---|
579 | |
---|
580 | </td> |
---|
581 | <td> |
---|
582 | |
---|
583 | <p> |
---|
584 | [INTERNAL] Overwrites the target parameter with this parameter. |
---|
585 | <p> |
---|
586 | This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
587 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
588 | <tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The target parameter to overwrite. </td></tr> |
---|
589 | </table> |
---|
590 | </dl> |
---|
591 | |
---|
592 | <p> |
---|
593 | Reimplemented in <a class="el" href="class_f_c_d_effect_parameter_sampler.html#55890a930b85436bfbac5ea2a764b751">FCDEffectParameterSampler</a>, <a class="el" href="class_f_c_d_effect_parameter_int.html#cb341351e6bb1e5c3c805b20f71c35ce">FCDEffectParameterInt</a>, <a class="el" href="class_f_c_d_effect_parameter_bool.html#b12e01129144af7c5dc44316ea134752">FCDEffectParameterBool</a>, <a class="el" href="class_f_c_d_effect_parameter_string.html#d1e9a2fd51cd50843df9bafa66ec60d3">FCDEffectParameterString</a>, <a class="el" href="class_f_c_d_effect_parameter_float.html#09d821f7e4230b64a4597679f9104aaa">FCDEffectParameterFloat</a>, <a class="el" href="class_f_c_d_effect_parameter_float2.html#58a396a94b4c6e5a63894d044ef83c32">FCDEffectParameterFloat2</a>, <a class="el" href="class_f_c_d_effect_parameter_float3.html#77bc6753cc4e7867be361b087a8631f9">FCDEffectParameterFloat3</a>, <a class="el" href="class_f_c_d_effect_parameter_vector.html#24b7d03b869596955d673b6630fb348f">FCDEffectParameterVector</a>, <a class="el" href="class_f_c_d_effect_parameter_matrix.html#48d3460ecdcb1564ae4fd95088d74e67">FCDEffectParameterMatrix</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface.html#152bf2814b0ab48add562f52109c400a">FCDEffectParameterSurface</a>. </td> |
---|
594 | </tr> |
---|
595 | </table> |
---|
596 | <a class="anchor" name="ad32aa763bceb364a6bb7bf9dba8292f"></a><!-- doxytag: member="FCDEffectParameter::SetBindSymbol" ref="ad32aa763bceb364a6bb7bf9dba8292f" args="(const string &_bindSymbol)" --><p> |
---|
597 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
598 | <tr> |
---|
599 | <td class="mdRow"> |
---|
600 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
601 | <tr> |
---|
602 | <td class="md" nowrap valign="top">void FCDEffectParameter::SetBindSymbol </td> |
---|
603 | <td class="md" valign="top">( </td> |
---|
604 | <td class="md" nowrap valign="top">const string & </td> |
---|
605 | <td class="mdname1" valign="top" nowrap> <em>_bindSymbol</em> </td> |
---|
606 | <td class="md" valign="top"> ) </td> |
---|
607 | <td class="md" nowrap><code> [inline]</code></td> |
---|
608 | </tr> |
---|
609 | </table> |
---|
610 | </td> |
---|
611 | </tr> |
---|
612 | </table> |
---|
613 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
614 | <tr> |
---|
615 | <td> |
---|
616 | |
---|
617 | </td> |
---|
618 | <td> |
---|
619 | |
---|
620 | <p> |
---|
621 | <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Sets the program bind symbol for this parameter. This information is available per-shader, in the <a class="el" href="class_f_c_d_effect_pass_shader.html">FCDEffectPassShader</a> class. </dd></dl> |
---|
622 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
623 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
624 | <tr><td valign="top"></td><td valign="top"><em>_bindSymbol</em> </td><td>The program bind symbol. </td></tr> |
---|
625 | </table> |
---|
626 | </dl> |
---|
627 | </td> |
---|
628 | </tr> |
---|
629 | </table> |
---|
630 | <a class="anchor" name="61f99760b80147aabb65d01051509347"></a><!-- doxytag: member="FCDEffectParameter::SetFragment" ref="61f99760b80147aabb65d01051509347" args="(bool _isFragment)" --><p> |
---|
631 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
632 | <tr> |
---|
633 | <td class="mdRow"> |
---|
634 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
635 | <tr> |
---|
636 | <td class="md" nowrap valign="top">void FCDEffectParameter::SetFragment </td> |
---|
637 | <td class="md" valign="top">( </td> |
---|
638 | <td class="md" nowrap valign="top">bool </td> |
---|
639 | <td class="mdname1" valign="top" nowrap> <em>_isFragment</em> </td> |
---|
640 | <td class="md" valign="top"> ) </td> |
---|
641 | <td class="md" nowrap><code> [inline]</code></td> |
---|
642 | </tr> |
---|
643 | </table> |
---|
644 | </td> |
---|
645 | </tr> |
---|
646 | </table> |
---|
647 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
648 | <tr> |
---|
649 | <td> |
---|
650 | |
---|
651 | </td> |
---|
652 | <td> |
---|
653 | |
---|
654 | <p> |
---|
655 | <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Sets whether the program bind symbol attached to this parameter belongs to a fragment/pixel shader. This information is available per-shader, in the <a class="el" href="class_f_c_d_effect_pass_shader.html">FCDEffectPassShader</a> class. </dd></dl> |
---|
656 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
657 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
658 | <tr><td valign="top"></td><td valign="top"><em>_isFragment</em> </td><td>Whether it belongs to a fragment/pixel shader. </td></tr> |
---|
659 | </table> |
---|
660 | </dl> |
---|
661 | </td> |
---|
662 | </tr> |
---|
663 | </table> |
---|
664 | <a class="anchor" name="bc0f7d843a976115d5b413c59700a230"></a><!-- doxytag: member="FCDEffectParameter::SetSemantic" ref="bc0f7d843a976115d5b413c59700a230" args="(const string &_semantic)" --><p> |
---|
665 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
666 | <tr> |
---|
667 | <td class="mdRow"> |
---|
668 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
669 | <tr> |
---|
670 | <td class="md" nowrap valign="top">void FCDEffectParameter::SetSemantic </td> |
---|
671 | <td class="md" valign="top">( </td> |
---|
672 | <td class="md" nowrap valign="top">const string & </td> |
---|
673 | <td class="mdname1" valign="top" nowrap> <em>_semantic</em> </td> |
---|
674 | <td class="md" valign="top"> ) </td> |
---|
675 | <td class="md" nowrap><code> [inline]</code></td> |
---|
676 | </tr> |
---|
677 | </table> |
---|
678 | </td> |
---|
679 | </tr> |
---|
680 | </table> |
---|
681 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
682 | <tr> |
---|
683 | <td> |
---|
684 | |
---|
685 | </td> |
---|
686 | <td> |
---|
687 | |
---|
688 | <p> |
---|
689 | Sets the semantic for this effect parameter. |
---|
690 | <p> |
---|
691 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
692 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
693 | <tr><td valign="top"></td><td valign="top"><em>_semantic</em> </td><td>The semantic. </td></tr> |
---|
694 | </table> |
---|
695 | </dl> |
---|
696 | </td> |
---|
697 | </tr> |
---|
698 | </table> |
---|
699 | <a class="anchor" name="71aaa548d040bdae0af136f250262ea5"></a><!-- doxytag: member="FCDEffectParameter::WriteToXML" ref="71aaa548d040bdae0af136f250262ea5" args="(xmlNode *parentNode) const " --><p> |
---|
700 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
701 | <tr> |
---|
702 | <td class="mdRow"> |
---|
703 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
704 | <tr> |
---|
705 | <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameter::WriteToXML </td> |
---|
706 | <td class="md" valign="top">( </td> |
---|
707 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
708 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
709 | <td class="md" valign="top"> ) </td> |
---|
710 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
711 | </tr> |
---|
712 | </table> |
---|
713 | </td> |
---|
714 | </tr> |
---|
715 | </table> |
---|
716 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
717 | <tr> |
---|
718 | <td> |
---|
719 | |
---|
720 | </td> |
---|
721 | <td> |
---|
722 | |
---|
723 | <p> |
---|
724 | [INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. |
---|
725 | <p> |
---|
726 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
727 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
728 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the parameter. </td></tr> |
---|
729 | </table> |
---|
730 | </dl> |
---|
731 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
732 | |
---|
733 | <p> |
---|
734 | Reimplemented in <a class="el" href="class_f_c_d_effect_parameter_sampler.html#d6cf0d8d984442be3f99ce951843b6ec">FCDEffectParameterSampler</a>, <a class="el" href="class_f_c_d_effect_parameter_int.html#cb9c3fd3298a512e1b2fdcf1f510cb84">FCDEffectParameterInt</a>, <a class="el" href="class_f_c_d_effect_parameter_bool.html#c177489519a1ec4f8ace8816da91f391">FCDEffectParameterBool</a>, <a class="el" href="class_f_c_d_effect_parameter_string.html#549c15a67edd1eda1cd566dce95e27bd">FCDEffectParameterString</a>, <a class="el" href="class_f_c_d_effect_parameter_float.html#b43bf22832629ca71c264976ce7d3183">FCDEffectParameterFloat</a>, <a class="el" href="class_f_c_d_effect_parameter_float2.html#55d8ee98e2e41fada0e024f9bdae56a6">FCDEffectParameterFloat2</a>, <a class="el" href="class_f_c_d_effect_parameter_float3.html#4a9415f61033a439fa26ba1cd009fc0b">FCDEffectParameterFloat3</a>, <a class="el" href="class_f_c_d_effect_parameter_vector.html#86e7d049cf09fd981961e85ffe510c91">FCDEffectParameterVector</a>, <a class="el" href="class_f_c_d_effect_parameter_matrix.html#b08c0c7fb3a9d48a6aee101aa2a07fd7">FCDEffectParameterMatrix</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface.html#7afa33510da0525c2bd3954bdaeb0541">FCDEffectParameterSurface</a>. </td> |
---|
735 | </tr> |
---|
736 | </table> |
---|
737 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
738 | <li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul> |
---|
739 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by |
---|
740 | <a href="http://www.doxygen.org/index.html"> |
---|
741 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
742 | </body> |
---|
743 | </html> |
---|