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

Revision 964, 12.3 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: FCDEffectParameterSurfaceInitCube 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>FCDEffectParameterSurfaceInitCube Class Reference</h1><!-- doxytag: class="FCDEffectParameterSurfaceInitCube" --><!-- doxytag: inherits="FCDEffectParameterSurfaceInit" -->A cube-map surface initialization method. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDEffectParameterSurfaceInitCube:
30<p><center><img src="class_f_c_d_effect_parameter_surface_init_cube.png" usemap="#FCDEffectParameterSurfaceInitCube_map" border="0" alt=""></center>
31<map name="FCDEffectParameterSurfaceInitCube_map">
32<area href="class_f_c_d_effect_parameter_surface_init.html" alt="FCDEffectParameterSurfaceInit" shape="rect" coords="0,0,220,24">
33</map>
34<a href="class_f_c_d_effect_parameter_surface_init_cube-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
35<tr><td></td></tr>
36<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
37<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#59228097e934d37b9e8ae788a749bc07">CubeType</a> { <b>ALL</b>,
38<a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#59228097e934d37b9e8ae788a749bc075f20c13bdba2e0c6acd3616d3af70936">PRIMARY</a>,
39<a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#59228097e934d37b9e8ae788a749bc07d8ea23e52036e6ad637a7169021239f3">FACE</a>
40 }</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The types of cube-map initializations.  <a href="class_f_c_d_effect_parameter_surface_init_cube.html#59228097e934d37b9e8ae788a749bc07">More...</a><br></td></tr>
43<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e55fc2856c67f2572dc5eb26cdafda76"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::FCDEffectParameterSurfaceInitCube" ref="e55fc2856c67f2572dc5eb26cdafda76" args="()" -->
45&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#e55fc2856c67f2572dc5eb26cdafda76">FCDEffectParameterSurfaceInitCube</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: builds a new cube-map initialization method. <br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d69a070147d26f23d81d4380c9dd6ec8"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::~FCDEffectParameterSurfaceInitCube" ref="d69a070147d26f23d81d4380c9dd6ec8" args="()" -->
49virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#d69a070147d26f23d81d4380c9dd6ec8">~FCDEffectParameterSurfaceInitCube</a> ()</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
52<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_cube.html#a22db1c4680d97b447466bc54a492451">GetInitType</a> () const </td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the initialization type.  <a href="#a22db1c4680d97b447466bc54a492451"></a><br></td></tr>
55<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_cube.html#1447db8de9739f319d655335a4fac5c6">Clone</a> ()</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the surface initialization parameter.  <a href="#1447db8de9739f319d655335a4fac5c6"></a><br></td></tr>
58<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f13376d1509627b73843e631db0abffb"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::cubeType" ref="f13376d1509627b73843e631db0abffb" args="" -->
60<a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#59228097e934d37b9e8ae788a749bc07">CubeType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#f13376d1509627b73843e631db0abffb">cubeType</a></td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of cube-map initialization. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">UInt16List</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#bb0a85514c43581c62d9b1167d329035">order</a></td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of image indices.  <a href="#bb0a85514c43581c62d9b1167d329035"></a><br></td></tr>
66</table>
67<hr><a name="_details"></a><h2>Detailed Description</h2>
68A cube-map surface initialization method.
69<p>
70<hr><h2>Member Enumeration Documentation</h2>
71<a class="anchor" name="59228097e934d37b9e8ae788a749bc07"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::CubeType" ref="59228097e934d37b9e8ae788a749bc07" args="" --><p>
72<table class="mdTable" cellpadding="2" cellspacing="0">
73  <tr>
74    <td class="mdRow">
75      <table cellpadding="0" cellspacing="0" border="0">
76        <tr>
77          <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#59228097e934d37b9e8ae788a749bc07">FCDEffectParameterSurfaceInitCube::CubeType</a>          </td>
78        </tr>
79      </table>
80    </td>
81  </tr>
82</table>
83<table cellspacing="5" cellpadding="0" border="0">
84  <tr>
85    <td>
86      &nbsp;
87    </td>
88    <td>
89
90<p>
91The types of cube-map initializations.
92<p>
93<dl compact><dt><b>Enumerator: </b></dt><dd>
94<table border="0" cellspacing="2" cellpadding="0">
95<tr><td valign="top"><em><a class="anchor" name="59228097e934d37b9e8ae788a749bc075f20c13bdba2e0c6acd3616d3af70936"></a><!-- doxytag: member="PRIMARY" ref="59228097e934d37b9e8ae788a749bc075f20c13bdba2e0c6acd3616d3af70936" args="" -->PRIMARY</em>&nbsp;</td><td>
96Load all the mip-levels of all the cube-map faces from one image file. </td></tr>
97<tr><td valign="top"><em><a class="anchor" name="59228097e934d37b9e8ae788a749bc07d8ea23e52036e6ad637a7169021239f3"></a><!-- doxytag: member="FACE" ref="59228097e934d37b9e8ae788a749bc07d8ea23e52036e6ad637a7169021239f3" args="" -->FACE</em>&nbsp;</td><td>
98Load all the cube-map faces from separate image files. </td></tr>
99</table>
100</dl>
101    </td>
102  </tr>
103</table>
104<hr><h2>Member Function Documentation</h2>
105<a class="anchor" name="1447db8de9739f319d655335a4fac5c6"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::Clone" ref="1447db8de9739f319d655335a4fac5c6" args="()" --><p>
106<table class="mdTable" cellpadding="2" cellspacing="0">
107  <tr>
108    <td class="mdRow">
109      <table cellpadding="0" cellspacing="0" border="0">
110        <tr>
111          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter_surface_init.html">FCDEffectParameterSurfaceInit</a>* FCDEffectParameterSurfaceInitCube::Clone           </td>
112          <td class="md" valign="top">(&nbsp;</td>
113          <td class="mdname1" valign="top" nowrap>          </td>
114          <td class="md" valign="top">&nbsp;)&nbsp;</td>
115          <td class="md" nowrap><code> [virtual]</code></td>
116        </tr>
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing="5" cellpadding="0" border="0">
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129Creates a full copy of the surface initialization parameter.
130<p>
131<dl compact><dt><b>Returns:</b></dt><dd>The surface initialization parameter. You will need to delete this pointer. </dd></dl>
132
133<p>
134Implements <a class="el" href="class_f_c_d_effect_parameter_surface_init.html#264b13ea36edb1906c9fbe13d3c2d467">FCDEffectParameterSurfaceInit</a>.    </td>
135  </tr>
136</table>
137<a class="anchor" name="a22db1c4680d97b447466bc54a492451"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::GetInitType" ref="a22db1c4680d97b447466bc54a492451" args="() const " --><p>
138<table class="mdTable" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <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> FCDEffectParameterSurfaceInitCube::GetInitType           </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="mdname1" valign="top" nowrap>          </td>
146          <td class="md" valign="top">&nbsp;)&nbsp;</td>
147          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
148        </tr>
149      </table>
150    </td>
151  </tr>
152</table>
153<table cellspacing="5" cellpadding="0" border="0">
154  <tr>
155    <td>
156      &nbsp;
157    </td>
158    <td>
159
160<p>
161Retrieves the initialization type.
162<p>
163You 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>
164
165<p>
166Implements <a class="el" href="class_f_c_d_effect_parameter_surface_init.html#d0109233e63c892e5963a3ca67f7108f">FCDEffectParameterSurfaceInit</a>.    </td>
167  </tr>
168</table>
169<hr><h2>Member Data Documentation</h2>
170<a class="anchor" name="bb0a85514c43581c62d9b1167d329035"></a><!-- doxytag: member="FCDEffectParameterSurfaceInitCube::order" ref="bb0a85514c43581c62d9b1167d329035" args="" --><p>
171<table class="mdTable" cellpadding="2" cellspacing="0">
172  <tr>
173    <td class="mdRow">
174      <table cellpadding="0" cellspacing="0" border="0">
175        <tr>
176          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">UInt16List</a> <a class="el" href="class_f_c_d_effect_parameter_surface_init_cube.html#bb0a85514c43581c62d9b1167d329035">FCDEffectParameterSurfaceInitCube::order</a>          </td>
177        </tr>
178      </table>
179    </td>
180  </tr>
181</table>
182<table cellspacing="5" cellpadding="0" border="0">
183  <tr>
184    <td>
185      &nbsp;
186    </td>
187    <td>
188
189<p>
190The list of image indices.
191<p>
192The images are contained within the surface effect parameter. This is used only for the FACE cube-map initialization type and indicates how to match the faces of faces of the cube-map with the images in the surface effect parameter.     </td>
193  </tr>
194</table>
195<hr>The documentation for this class was generated from the following file:<ul>
196<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_surface_8h-source.html">FCDEffectParameterSurface.h</a></ul>
197<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
198<a href="http://www.doxygen.org/index.html">
199<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
200</body>
201</html>
Note: See TracBrowser for help on using the repository browser.