[964] | 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: FCDEffectParameterSampler 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>FCDEffectParameterSampler 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="FCDEffectParameterSampler" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA sampler 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 FCDEffectParameterSampler: |
---|
| 33 | <p><center><img src="class_f_c_d_effect_parameter_sampler.png" usemap="#FCDEffectParameterSampler_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDEffectParameterSampler_map"> |
---|
| 35 | <area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="0,112,175,136"> |
---|
| 36 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,175,80"> |
---|
| 37 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,175,24"> |
---|
| 38 | </map> |
---|
| 39 | <a href="class_f_c_d_effect_parameter_sampler-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 Types</h2></td></tr> |
---|
| 42 | <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_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">SamplerType</a> { <b>SAMPLER1D</b>, |
---|
| 43 | <a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c344243e0a98b613cd47287b74402a45dcd2df">SAMPLER2D</a>, |
---|
| 44 | <a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424705723cc55960ee3b2d6744e3244cd48">SAMPLER3D</a>, |
---|
| 45 | <a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c344244c3851e3bc494f054f2e45efd74e107d">SAMPLERCUBE</a> |
---|
| 46 | }</td></tr> |
---|
| 47 | |
---|
| 48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The type of sampling to execute. <a href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">More...</a><br></td></tr> |
---|
| 49 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 50 | <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_sampler.html#2f69f2f62504f6e0122254d738aac0b4">FCDEffectParameterSampler</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
| 51 | |
---|
| 52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#2f69f2f62504f6e0122254d738aac0b4"></a><br></td></tr> |
---|
| 53 | <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_sampler.html#4bbf339f6dd9bd72a8e924fbd98a6d47">~FCDEffectParameterSampler</a> ()</td></tr> |
---|
| 54 | |
---|
| 55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#4bbf339f6dd9bd72a8e924fbd98a6d47"></a><br></td></tr> |
---|
| 56 | <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_sampler.html#b0483ddfcc3c69f12539df9fba36f0d6">GetType</a> () const </td></tr> |
---|
| 57 | |
---|
| 58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of effect parameter class. <a href="#b0483ddfcc3c69f12539df9fba36f0d6"></a><br></td></tr> |
---|
| 59 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_sampler.html#4d3ce176dcb65c56bb1207fbd3968233">GetSurfaceSid</a> () const </td></tr> |
---|
| 60 | |
---|
| 61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the sub-id of the surface parameter. <a href="#4d3ce176dcb65c56bb1207fbd3968233"></a><br></td></tr> |
---|
| 62 | <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_sampler.html#ede4bcb8ad021cfc506688b5c1d51bb0">SetSurfaceSid</a> (const char *sid)</td></tr> |
---|
| 63 | |
---|
| 64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the sub-id of the surface parameter to sample. <a href="#ede4bcb8ad021cfc506688b5c1d51bb0"></a><br></td></tr> |
---|
| 65 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">SamplerType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_sampler.html#07aaa27b521ceaf9fb570eeb713bb41a">GetSamplerType</a> () const </td></tr> |
---|
| 66 | |
---|
| 67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of sampling to do. <a href="#07aaa27b521ceaf9fb570eeb713bb41a"></a><br></td></tr> |
---|
| 68 | <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_sampler.html#eb463b7fed44feccf05032b2274c4dcc">SetSamplerType</a> (<a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">SamplerType</a> type)</td></tr> |
---|
| 69 | |
---|
| 70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of sampling to do. <a href="#eb463b7fed44feccf05032b2274c4dcc"></a><br></td></tr> |
---|
| 71 | <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_sampler.html#fa71662d4d3b00dcb800613879ee6c36">Clone</a> ()</td></tr> |
---|
| 72 | |
---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a full copy of the effect parameter. <a href="#fa71662d4d3b00dcb800613879ee6c36"></a><br></td></tr> |
---|
| 74 | <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_sampler.html#55890a930b85436bfbac5ea2a764b751">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr> |
---|
| 75 | |
---|
| 76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter. <a href="#55890a930b85436bfbac5ea2a764b751"></a><br></td></tr> |
---|
| 77 | <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_sampler.html#670e66d4476754540e0e72f9d02f45fe">LoadFromXML</a> (xmlNode *parameterNode)</td></tr> |
---|
| 78 | |
---|
| 79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. <a href="#670e66d4476754540e0e72f9d02f45fe"></a><br></td></tr> |
---|
| 80 | <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_sampler.html#d6cf0d8d984442be3f99ce951843b6ec">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
| 81 | |
---|
| 82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. <a href="#d6cf0d8d984442be3f99ce951843b6ec"></a><br></td></tr> |
---|
| 83 | </table> |
---|
| 84 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 85 | A COLLADA sampler effect parameter. |
---|
| 86 | <p> |
---|
| 87 | A sampler parameter provides the extra texturing information necessary to correctly sample a surface parameter. There are four types of samplers supported: 1D, 2D, 3D and cube. |
---|
| 88 | <p> |
---|
| 89 | <hr><h2>Member Enumeration Documentation</h2> |
---|
| 90 | <a class="anchor" name="e3a82d31b80b3510bb44a62bd3c34424"></a><!-- doxytag: member="FCDEffectParameterSampler::SamplerType" ref="e3a82d31b80b3510bb44a62bd3c34424" args="" --><p> |
---|
| 91 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 92 | <tr> |
---|
| 93 | <td class="mdRow"> |
---|
| 94 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 95 | <tr> |
---|
| 96 | <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">FCDEffectParameterSampler::SamplerType</a> </td> |
---|
| 97 | </tr> |
---|
| 98 | </table> |
---|
| 99 | </td> |
---|
| 100 | </tr> |
---|
| 101 | </table> |
---|
| 102 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 103 | <tr> |
---|
| 104 | <td> |
---|
| 105 | |
---|
| 106 | </td> |
---|
| 107 | <td> |
---|
| 108 | |
---|
| 109 | <p> |
---|
| 110 | The type of sampling to execute. |
---|
| 111 | <p> |
---|
| 112 | <dl compact><dt><b>Enumerator: </b></dt><dd> |
---|
| 113 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 114 | <tr><td valign="top"><em><a class="anchor" name="e3a82d31b80b3510bb44a62bd3c344243e0a98b613cd47287b74402a45dcd2df"></a><!-- doxytag: member="SAMPLER2D" ref="e3a82d31b80b3510bb44a62bd3c344243e0a98b613cd47287b74402a45dcd2df" args="" -->SAMPLER2D</em> </td><td> |
---|
| 115 | 1D sampling. </td></tr> |
---|
| 116 | <tr><td valign="top"><em><a class="anchor" name="e3a82d31b80b3510bb44a62bd3c34424705723cc55960ee3b2d6744e3244cd48"></a><!-- doxytag: member="SAMPLER3D" ref="e3a82d31b80b3510bb44a62bd3c34424705723cc55960ee3b2d6744e3244cd48" args="" -->SAMPLER3D</em> </td><td> |
---|
| 117 | 2D sampling. </td></tr> |
---|
| 118 | <tr><td valign="top"><em><a class="anchor" name="e3a82d31b80b3510bb44a62bd3c344244c3851e3bc494f054f2e45efd74e107d"></a><!-- doxytag: member="SAMPLERCUBE" ref="e3a82d31b80b3510bb44a62bd3c344244c3851e3bc494f054f2e45efd74e107d" args="" -->SAMPLERCUBE</em> </td><td> |
---|
| 119 | Cube-map sampling. </td></tr> |
---|
| 120 | </table> |
---|
| 121 | </dl> |
---|
| 122 | </td> |
---|
| 123 | </tr> |
---|
| 124 | </table> |
---|
| 125 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 126 | <a class="anchor" name="2f69f2f62504f6e0122254d738aac0b4"></a><!-- doxytag: member="FCDEffectParameterSampler::FCDEffectParameterSampler" ref="2f69f2f62504f6e0122254d738aac0b4" args="(FCDocument *document)" --><p> |
---|
| 127 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 128 | <tr> |
---|
| 129 | <td class="mdRow"> |
---|
| 130 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 131 | <tr> |
---|
| 132 | <td class="md" nowrap valign="top">FCDEffectParameterSampler::FCDEffectParameterSampler </td> |
---|
| 133 | <td class="md" valign="top">( </td> |
---|
| 134 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 135 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
| 136 | <td class="md" valign="top"> ) </td> |
---|
| 137 | <td class="md" nowrap></td> |
---|
| 138 | </tr> |
---|
| 139 | </table> |
---|
| 140 | </td> |
---|
| 141 | </tr> |
---|
| 142 | </table> |
---|
| 143 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 144 | <tr> |
---|
| 145 | <td> |
---|
| 146 | |
---|
| 147 | </td> |
---|
| 148 | <td> |
---|
| 149 | |
---|
| 150 | <p> |
---|
| 151 | Constructor: do not use directly. |
---|
| 152 | <p> |
---|
| 153 | 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> |
---|
| 154 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 155 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the effect parameter. </td></tr> |
---|
| 156 | </table> |
---|
| 157 | </dl> |
---|
| 158 | </td> |
---|
| 159 | </tr> |
---|
| 160 | </table> |
---|
| 161 | <a class="anchor" name="4bbf339f6dd9bd72a8e924fbd98a6d47"></a><!-- doxytag: member="FCDEffectParameterSampler::~FCDEffectParameterSampler" ref="4bbf339f6dd9bd72a8e924fbd98a6d47" args="()" --><p> |
---|
| 162 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 163 | <tr> |
---|
| 164 | <td class="mdRow"> |
---|
| 165 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 166 | <tr> |
---|
| 167 | <td class="md" nowrap valign="top">virtual FCDEffectParameterSampler::~FCDEffectParameterSampler </td> |
---|
| 168 | <td class="md" valign="top">( </td> |
---|
| 169 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 170 | <td class="md" valign="top"> ) </td> |
---|
| 171 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 172 | </tr> |
---|
| 173 | </table> |
---|
| 174 | </td> |
---|
| 175 | </tr> |
---|
| 176 | </table> |
---|
| 177 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 178 | <tr> |
---|
| 179 | <td> |
---|
| 180 | |
---|
| 181 | </td> |
---|
| 182 | <td> |
---|
| 183 | |
---|
| 184 | <p> |
---|
| 185 | Destructor: do not use directly. |
---|
| 186 | <p> |
---|
| 187 | 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> |
---|
| 188 | </tr> |
---|
| 189 | </table> |
---|
| 190 | <hr><h2>Member Function Documentation</h2> |
---|
| 191 | <a class="anchor" name="fa71662d4d3b00dcb800613879ee6c36"></a><!-- doxytag: member="FCDEffectParameterSampler::Clone" ref="fa71662d4d3b00dcb800613879ee6c36" args="()" --><p> |
---|
| 192 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 193 | <tr> |
---|
| 194 | <td class="mdRow"> |
---|
| 195 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 196 | <tr> |
---|
| 197 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterSampler::Clone </td> |
---|
| 198 | <td class="md" valign="top">( </td> |
---|
| 199 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 200 | <td class="md" valign="top"> ) </td> |
---|
| 201 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 202 | </tr> |
---|
| 203 | </table> |
---|
| 204 | </td> |
---|
| 205 | </tr> |
---|
| 206 | </table> |
---|
| 207 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 208 | <tr> |
---|
| 209 | <td> |
---|
| 210 | |
---|
| 211 | </td> |
---|
| 212 | <td> |
---|
| 213 | |
---|
| 214 | <p> |
---|
| 215 | Creates a full copy of the effect parameter. |
---|
| 216 | <p> |
---|
| 217 | <dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl> |
---|
| 218 | |
---|
| 219 | <p> |
---|
| 220 | Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>. </td> |
---|
| 221 | </tr> |
---|
| 222 | </table> |
---|
| 223 | <a class="anchor" name="07aaa27b521ceaf9fb570eeb713bb41a"></a><!-- doxytag: member="FCDEffectParameterSampler::GetSamplerType" ref="07aaa27b521ceaf9fb570eeb713bb41a" args="() const " --><p> |
---|
| 224 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 225 | <tr> |
---|
| 226 | <td class="mdRow"> |
---|
| 227 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 228 | <tr> |
---|
| 229 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">SamplerType</a> FCDEffectParameterSampler::GetSamplerType </td> |
---|
| 230 | <td class="md" valign="top">( </td> |
---|
| 231 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 232 | <td class="md" valign="top"> ) </td> |
---|
| 233 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 234 | </tr> |
---|
| 235 | </table> |
---|
| 236 | </td> |
---|
| 237 | </tr> |
---|
| 238 | </table> |
---|
| 239 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 240 | <tr> |
---|
| 241 | <td> |
---|
| 242 | |
---|
| 243 | </td> |
---|
| 244 | <td> |
---|
| 245 | |
---|
| 246 | <p> |
---|
| 247 | Retrieves the type of sampling to do. |
---|
| 248 | <p> |
---|
| 249 | <dl compact><dt><b>Returns:</b></dt><dd>The sampling type. </dd></dl> |
---|
| 250 | </td> |
---|
| 251 | </tr> |
---|
| 252 | </table> |
---|
| 253 | <a class="anchor" name="4d3ce176dcb65c56bb1207fbd3968233"></a><!-- doxytag: member="FCDEffectParameterSampler::GetSurfaceSid" ref="4d3ce176dcb65c56bb1207fbd3968233" args="() const " --><p> |
---|
| 254 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 255 | <tr> |
---|
| 256 | <td class="mdRow"> |
---|
| 257 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 258 | <tr> |
---|
| 259 | <td class="md" nowrap valign="top">const char* FCDEffectParameterSampler::GetSurfaceSid </td> |
---|
| 260 | <td class="md" valign="top">( </td> |
---|
| 261 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 262 | <td class="md" valign="top"> ) </td> |
---|
| 263 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 264 | </tr> |
---|
| 265 | </table> |
---|
| 266 | </td> |
---|
| 267 | </tr> |
---|
| 268 | </table> |
---|
| 269 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 270 | <tr> |
---|
| 271 | <td> |
---|
| 272 | |
---|
| 273 | </td> |
---|
| 274 | <td> |
---|
| 275 | |
---|
| 276 | <p> |
---|
| 277 | Retrieves the sub-id of the surface parameter. |
---|
| 278 | <p> |
---|
| 279 | You will want to search for that sub-id within the parameters to find the <a class="el" href="class_f_c_d_effect_parameter_surface.html">FCDEffectParameterSurface</a> object. <dl compact><dt><b>Returns:</b></dt><dd>The sub-id. </dd></dl> |
---|
| 280 | </td> |
---|
| 281 | </tr> |
---|
| 282 | </table> |
---|
| 283 | <a class="anchor" name="b0483ddfcc3c69f12539df9fba36f0d6"></a><!-- doxytag: member="FCDEffectParameterSampler::GetType" ref="b0483ddfcc3c69f12539df9fba36f0d6" args="() const " --><p> |
---|
| 284 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 285 | <tr> |
---|
| 286 | <td class="mdRow"> |
---|
| 287 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 288 | <tr> |
---|
| 289 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameterSampler::GetType </td> |
---|
| 290 | <td class="md" valign="top">( </td> |
---|
| 291 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 292 | <td class="md" valign="top"> ) </td> |
---|
| 293 | <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
---|
| 294 | </tr> |
---|
| 295 | </table> |
---|
| 296 | </td> |
---|
| 297 | </tr> |
---|
| 298 | </table> |
---|
| 299 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 300 | <tr> |
---|
| 301 | <td> |
---|
| 302 | |
---|
| 303 | </td> |
---|
| 304 | <td> |
---|
| 305 | |
---|
| 306 | <p> |
---|
| 307 | Retrieves the type of effect parameter class. |
---|
| 308 | <p> |
---|
| 309 | <dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: SAMPLER. </dd></dl> |
---|
| 310 | |
---|
| 311 | <p> |
---|
| 312 | Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>. </td> |
---|
| 313 | </tr> |
---|
| 314 | </table> |
---|
| 315 | <a class="anchor" name="670e66d4476754540e0e72f9d02f45fe"></a><!-- doxytag: member="FCDEffectParameterSampler::LoadFromXML" ref="670e66d4476754540e0e72f9d02f45fe" args="(xmlNode *parameterNode)" --><p> |
---|
| 316 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 317 | <tr> |
---|
| 318 | <td class="mdRow"> |
---|
| 319 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 320 | <tr> |
---|
| 321 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterSampler::LoadFromXML </td> |
---|
| 322 | <td class="md" valign="top">( </td> |
---|
| 323 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 324 | <td class="mdname1" valign="top" nowrap> <em>parameterNode</em> </td> |
---|
| 325 | <td class="md" valign="top"> ) </td> |
---|
| 326 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 327 | </tr> |
---|
| 328 | </table> |
---|
| 329 | </td> |
---|
| 330 | </tr> |
---|
| 331 | </table> |
---|
| 332 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 333 | <tr> |
---|
| 334 | <td> |
---|
| 335 | |
---|
| 336 | </td> |
---|
| 337 | <td> |
---|
| 338 | |
---|
| 339 | <p> |
---|
| 340 | [INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. |
---|
| 341 | <p> |
---|
| 342 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 343 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 344 | <tr><td valign="top"></td><td valign="top"><em>parameterNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
| 345 | </table> |
---|
| 346 | </dl> |
---|
| 347 | <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> |
---|
| 348 | |
---|
| 349 | <p> |
---|
| 350 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>. </td> |
---|
| 351 | </tr> |
---|
| 352 | </table> |
---|
| 353 | <a class="anchor" name="55890a930b85436bfbac5ea2a764b751"></a><!-- doxytag: member="FCDEffectParameterSampler::Overwrite" ref="55890a930b85436bfbac5ea2a764b751" args="(FCDEffectParameter *target)" --><p> |
---|
| 354 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 355 | <tr> |
---|
| 356 | <td class="mdRow"> |
---|
| 357 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 358 | <tr> |
---|
| 359 | <td class="md" nowrap valign="top">virtual void FCDEffectParameterSampler::Overwrite </td> |
---|
| 360 | <td class="md" valign="top">( </td> |
---|
| 361 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> * </td> |
---|
| 362 | <td class="mdname1" valign="top" nowrap> <em>target</em> </td> |
---|
| 363 | <td class="md" valign="top"> ) </td> |
---|
| 364 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 365 | </tr> |
---|
| 366 | </table> |
---|
| 367 | </td> |
---|
| 368 | </tr> |
---|
| 369 | </table> |
---|
| 370 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 371 | <tr> |
---|
| 372 | <td> |
---|
| 373 | |
---|
| 374 | </td> |
---|
| 375 | <td> |
---|
| 376 | |
---|
| 377 | <p> |
---|
| 378 | [INTERNAL] Overwrites the target parameter with this parameter. |
---|
| 379 | <p> |
---|
| 380 | This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 381 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 382 | <tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>The target parameter to overwrite. </td></tr> |
---|
| 383 | </table> |
---|
| 384 | </dl> |
---|
| 385 | |
---|
| 386 | <p> |
---|
| 387 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>. </td> |
---|
| 388 | </tr> |
---|
| 389 | </table> |
---|
| 390 | <a class="anchor" name="eb463b7fed44feccf05032b2274c4dcc"></a><!-- doxytag: member="FCDEffectParameterSampler::SetSamplerType" ref="eb463b7fed44feccf05032b2274c4dcc" args="(SamplerType type)" --><p> |
---|
| 391 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 392 | <tr> |
---|
| 393 | <td class="mdRow"> |
---|
| 394 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 395 | <tr> |
---|
| 396 | <td class="md" nowrap valign="top">void FCDEffectParameterSampler::SetSamplerType </td> |
---|
| 397 | <td class="md" valign="top">( </td> |
---|
| 398 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_sampler.html#e3a82d31b80b3510bb44a62bd3c34424">SamplerType</a> </td> |
---|
| 399 | <td class="mdname1" valign="top" nowrap> <em>type</em> </td> |
---|
| 400 | <td class="md" valign="top"> ) </td> |
---|
| 401 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 402 | </tr> |
---|
| 403 | </table> |
---|
| 404 | </td> |
---|
| 405 | </tr> |
---|
| 406 | </table> |
---|
| 407 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 408 | <tr> |
---|
| 409 | <td> |
---|
| 410 | |
---|
| 411 | </td> |
---|
| 412 | <td> |
---|
| 413 | |
---|
| 414 | <p> |
---|
| 415 | Sets the type of sampling to do. |
---|
| 416 | <p> |
---|
| 417 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 418 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 419 | <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The sampling type. </td></tr> |
---|
| 420 | </table> |
---|
| 421 | </dl> |
---|
| 422 | </td> |
---|
| 423 | </tr> |
---|
| 424 | </table> |
---|
| 425 | <a class="anchor" name="ede4bcb8ad021cfc506688b5c1d51bb0"></a><!-- doxytag: member="FCDEffectParameterSampler::SetSurfaceSid" ref="ede4bcb8ad021cfc506688b5c1d51bb0" args="(const char *sid)" --><p> |
---|
| 426 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 427 | <tr> |
---|
| 428 | <td class="mdRow"> |
---|
| 429 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 430 | <tr> |
---|
| 431 | <td class="md" nowrap valign="top">void FCDEffectParameterSampler::SetSurfaceSid </td> |
---|
| 432 | <td class="md" valign="top">( </td> |
---|
| 433 | <td class="md" nowrap valign="top">const char * </td> |
---|
| 434 | <td class="mdname1" valign="top" nowrap> <em>sid</em> </td> |
---|
| 435 | <td class="md" valign="top"> ) </td> |
---|
| 436 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 437 | </tr> |
---|
| 438 | </table> |
---|
| 439 | </td> |
---|
| 440 | </tr> |
---|
| 441 | </table> |
---|
| 442 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 443 | <tr> |
---|
| 444 | <td> |
---|
| 445 | |
---|
| 446 | </td> |
---|
| 447 | <td> |
---|
| 448 | |
---|
| 449 | <p> |
---|
| 450 | Sets the sub-id of the surface parameter to sample. |
---|
| 451 | <p> |
---|
| 452 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 453 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 454 | <tr><td valign="top"></td><td valign="top"><em>sid</em> </td><td>The surface parameter sub-id. </td></tr> |
---|
| 455 | </table> |
---|
| 456 | </dl> |
---|
| 457 | </td> |
---|
| 458 | </tr> |
---|
| 459 | </table> |
---|
| 460 | <a class="anchor" name="d6cf0d8d984442be3f99ce951843b6ec"></a><!-- doxytag: member="FCDEffectParameterSampler::WriteToXML" ref="d6cf0d8d984442be3f99ce951843b6ec" args="(xmlNode *parentNode) const " --><p> |
---|
| 461 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 462 | <tr> |
---|
| 463 | <td class="mdRow"> |
---|
| 464 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 465 | <tr> |
---|
| 466 | <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterSampler::WriteToXML </td> |
---|
| 467 | <td class="md" valign="top">( </td> |
---|
| 468 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 469 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
| 470 | <td class="md" valign="top"> ) </td> |
---|
| 471 | <td class="md" nowrap> const<code> [virtual]</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 | [INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. |
---|
| 486 | <p> |
---|
| 487 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 488 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 489 | <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> |
---|
| 490 | </table> |
---|
| 491 | </dl> |
---|
| 492 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
| 493 | |
---|
| 494 | <p> |
---|
| 495 | Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>. </td> |
---|
| 496 | </tr> |
---|
| 497 | </table> |
---|
| 498 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 499 | <li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul> |
---|
| 500 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by |
---|
| 501 | <a href="http://www.doxygen.org/index.html"> |
---|
| 502 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 503 | </body> |
---|
| 504 | </html> |
---|