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

Revision 964, 12.0 KB checked in by igarcia, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FCDEffectParameterSurfaceInit Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
14    <li><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FCDEffectParameterSurfaceInit 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="FCDEffectParameterSurfaceInit" -->A surface initialization method. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDEffectParameterSurfaceInit:
33<p><center><img src="class_f_c_d_effect_parameter_surface_init.png" usemap="#FCDEffectParameterSurfaceInit_map" border="0" alt=""></center>
34<map name="FCDEffectParameterSurfaceInit_map">
35<area href="class_f_c_d_effect_parameter_surface_init_as_null.html" alt="FCDEffectParameterSurfaceInitAsNull" shape="rect" coords="0,56,241,80">
36<area href="class_f_c_d_effect_parameter_surface_init_as_target.html" alt="FCDEffectParameterSurfaceInitAsTarget" shape="rect" coords="251,56,492,80">
37<area href="class_f_c_d_effect_parameter_surface_init_cube.html" alt="FCDEffectParameterSurfaceInitCube" shape="rect" coords="502,56,743,80">
38<area href="class_f_c_d_effect_parameter_surface_init_from.html" alt="FCDEffectParameterSurfaceInitFrom" shape="rect" coords="753,56,994,80">
39<area href="class_f_c_d_effect_parameter_surface_init_planar.html" alt="FCDEffectParameterSurfaceInitPlanar" shape="rect" coords="1004,56,1245,80">
40<area href="class_f_c_d_effect_parameter_surface_init_volume.html" alt="FCDEffectParameterSurfaceInitVolume" shape="rect" coords="1255,56,1496,80">
41</map>
42<a href="class_f_c_d_effect_parameter_surface_init-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
43<tr><td></td></tr>
44<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b22a5b52b38cbabb51a39c3ea42db74"></a><!-- doxytag: member="FCDEffectParameterSurfaceInit::FCDEffectParameterSurfaceInit" ref="6b22a5b52b38cbabb51a39c3ea42db74" args="()" -->
46&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html#6b22a5b52b38cbabb51a39c3ea42db74">FCDEffectParameterSurfaceInit</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: builds a new surface initialization method. <br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c350e10e96cbb79e5f4e5b6487052280"></a><!-- doxytag: member="FCDEffectParameterSurfaceInit::~FCDEffectParameterSurfaceInit" ref="c350e10e96cbb79e5f4e5b6487052280" args="()" -->
50virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html#c350e10e96cbb79e5f4e5b6487052280">~FCDEffectParameterSurfaceInit</a> ()</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html#d0109233e63c892e5963a3ca67f7108f">GetInitType</a> () const =0</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the initialization type.  <a href="#d0109233e63c892e5963a3ca67f7108f"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html#f21aed96873a3e65a239f79f830a8b54">Clone</a> (<a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> *clone)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copies all member variables into clone.  <a href="#f21aed96873a3e65a239f79f830a8b54"></a><br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html#264b13ea36edb1906c9fbe13d3c2d467">Clone</a> ()=0</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the surface initialization parameter.  <a href="#264b13ea36edb1906c9fbe13d3c2d467"></a><br></td></tr>
62</table>
63<hr><a name="_details"></a><h2>Detailed Description</h2>
64A surface initialization method.
65<p>
66In COLLADA 1.4.1, this information was added to support complex surface types. There are six types of initialization methods, described in the InitType enumerated type. Expect the FROM initialization type in the large majority of cases.
67<p>
68<hr><h2>Member Function Documentation</h2>
69<a class="anchor" name="264b13ea36edb1906c9fbe13d3c2d467"></a><!-- doxytag: member="FCDEffectParameterSurfaceInit::Clone" ref="264b13ea36edb1906c9fbe13d3c2d467" args="()=0" --><p>
70<table class="mdTable" cellpadding="2" cellspacing="0">
71  <tr>
72    <td class="mdRow">
73      <table cellpadding="0" cellspacing="0" border="0">
74        <tr>
75          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a>* FCDEffectParameterSurfaceInit::Clone           </td>
76          <td class="md" valign="top">(&nbsp;</td>
77          <td class="mdname1" valign="top" nowrap>          </td>
78          <td class="md" valign="top">&nbsp;)&nbsp;</td>
79          <td class="md" nowrap><code> [pure virtual]</code></td>
80        </tr>
81      </table>
82    </td>
83  </tr>
84</table>
85<table cellspacing="5" cellpadding="0" border="0">
86  <tr>
87    <td>
88      &nbsp;
89    </td>
90    <td>
91
92<p>
93Creates a full copy of the surface initialization parameter.
94<p>
95<dl compact><dt><b>Returns:</b></dt><dd>The surface initialization parameter. You will need to delete this pointer. </dd></dl>
96
97<p>
98Implemented in <a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#1447db8de9739f319d655335a4fac5c6">FCDEffectParameterSurfaceInitCube</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#e67e3573dec7f41c0be35b4bb04992d8">FCDEffectParameterSurfaceInitVolume</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_from.html#ed69e2fd3200146418845a5a97d29ae8">FCDEffectParameterSurfaceInitFrom</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_as_null.html#5595284af2dae6838d4843e7937e4061">FCDEffectParameterSurfaceInitAsNull</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_as_target.html#861f45cf5967627e339e4c0aaafab0b9">FCDEffectParameterSurfaceInitAsTarget</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface_init_planar.html#b6c1b97473f3798d7c9bd7451376227f">FCDEffectParameterSurfaceInitPlanar</a>.    </td>
99  </tr>
100</table>
101<a class="anchor" name="f21aed96873a3e65a239f79f830a8b54"></a><!-- doxytag: member="FCDEffectParameterSurfaceInit::Clone" ref="f21aed96873a3e65a239f79f830a8b54" args="(FCDEffectParameterSurfaceInit *clone)" --><p>
102<table class="mdTable" cellpadding="2" cellspacing="0">
103  <tr>
104    <td class="mdRow">
105      <table cellpadding="0" cellspacing="0" border="0">
106        <tr>
107          <td class="md" nowrap valign="top">void FCDEffectParameterSurfaceInit::Clone           </td>
108          <td class="md" valign="top">(&nbsp;</td>
109          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> *&nbsp;</td>
110          <td class="mdname1" valign="top" nowrap> <em>clone</em>          </td>
111          <td class="md" valign="top">&nbsp;)&nbsp;</td>
112          <td class="md" nowrap></td>
113        </tr>
114      </table>
115    </td>
116  </tr>
117</table>
118<table cellspacing="5" cellpadding="0" border="0">
119  <tr>
120    <td>
121      &nbsp;
122    </td>
123    <td>
124
125<p>
126Copies all member variables into clone.
127<p>
128<dl compact><dt><b>Parameters:</b></dt><dd>
129  <table border="0" cellspacing="2" cellpadding="0">
130    <tr><td valign="top"></td><td valign="top"><em>clone</em>&nbsp;</td><td>a valid pointer to a <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a> object </td></tr>
131  </table>
132</dl>
133    </td>
134  </tr>
135</table>
136<a class="anchor" name="d0109233e63c892e5963a3ca67f7108f"></a><!-- doxytag: member="FCDEffectParameterSurfaceInit::GetInitType" ref="d0109233e63c892e5963a3ca67f7108f" args="() const =0" --><p>
137<table class="mdTable" cellpadding="2" cellspacing="0">
138  <tr>
139    <td class="mdRow">
140      <table cellpadding="0" cellspacing="0" border="0">
141        <tr>
142          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init_factory.html#65e74f1159865702cac5236dd5d83892">FCDEffectParameterSurfaceInitFactory::InitType</a> FCDEffectParameterSurfaceInit::GetInitType           </td>
143          <td class="md" valign="top">(&nbsp;</td>
144          <td class="mdname1" valign="top" nowrap>          </td>
145          <td class="md" valign="top">&nbsp;)&nbsp;</td>
146          <td class="md" nowrap> const<code> [pure virtual]</code></td>
147        </tr>
148      </table>
149    </td>
150  </tr>
151</table>
152<table cellspacing="5" cellpadding="0" border="0">
153  <tr>
154    <td>
155      &nbsp;
156    </td>
157    <td>
158
159<p>
160Retrieves the initialization type.
161<p>
162You cannot modify this value. To change the initialization type of a surface parameter, create a new surface initialization structure of the correct type. <dl compact><dt><b>Returns:</b></dt><dd>The initialization type. </dd></dl>
163
164<p>
165Implemented in <a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#a22db1c4680d97b447466bc54a492451">FCDEffectParameterSurfaceInitCube</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_volume.html#d0490f5d50b8babd77b3294277f4fde5">FCDEffectParameterSurfaceInitVolume</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_from.html#33c2001f6d11fe519d7f5c492daec92a">FCDEffectParameterSurfaceInitFrom</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_as_null.html#91211f6657b5ca23ad0530fe803eea8b">FCDEffectParameterSurfaceInitAsNull</a>, <a class="el" href="class_f_c_d_effect_parameter_surface_init_as_target.html#45bcad832e5dd14719aa1dfbea529db2">FCDEffectParameterSurfaceInitAsTarget</a>, and <a class="el" href="class_f_c_d_effect_parameter_surface_init_planar.html#9e91a455acbcbed40b8e647aa0c56d80">FCDEffectParameterSurfaceInitPlanar</a>.    </td>
166  </tr>
167</table>
168<hr>The documentation for this class was generated from the following file:<ul>
169<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a></ul>
170<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
171<a href="http://www.doxygen.org/index.html">
172<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
173</body>
174</html>
Note: See TracBrowser for help on using the repository browser.