1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48    <title>nw::gfx::ParticleShape</title>
49  </head>
50  <body>
51    <h1><CODE>nw::gfx::ParticleShape</CODE> Class</h1>
52    <h2>Syntax</h2>
53    <div class="section">
54      <pre class="definition">class ParticleShape : public <a href="../../../nw/gfx/SceneObject/Overview.html">nw::gfx::SceneObject</a></pre>
55    </div>
56    <h2>Description</h2>
57    <div class="section">
58      <p>Class that represents particle shapes.</p><p>Use ParticleCollection, not this class.</p></div>
59    <a name="constant" id="constant">
60      <h2>Member Constants</h2>
61      <div class="section">
62        <table class="members">
63          <tr>
64            <td width="100">
65              <span class="static_style" title="static">S</span>
66            </td>
67            <th>
68              <span class="argument"><a href="../../../nw/gfx/SceneObject/DEFAULT_MAX_CHILDREN.html"><CODE>DEFAULT_MAX_CHILDREN</CODE></a></span>
69            </th>
70            <td>Maximum number of children when a fixed amount of memory is used.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td>
71          </tr>
72          <tr>
73            <td width="100">
74              <span class="static_style" title="static">S</span>
75            </td>
76            <th>
77              <span class="argument"><a href="../../../nw/gfx/SceneObject/DEFAULT_MAX_CALLBACKS.html"><CODE>DEFAULT_MAX_CALLBACKS</CODE></a></span>
78            </th>
79            <td>Maximum number of callbacks when a fixed amount of memory is used.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td>
80          </tr>
81          <tr>
82            <td width="100">
83              <span class="static_style" title="static">S</span>
84            </td>
85            <th>
86              <span class="argument"><a href="../../../nw/gfx/SceneObject/MAX_NAME_LENGTH.html"><CODE>MAX_NAME_LENGTH</CODE></a></span>
87            </th>
88            <td>Limit on names of scene objects.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td>
89          </tr> </table>
90      </div>
91    </a> <a name="variable" id="variable">
92      <h2>Member Variables</h2>
93      <div class="section">
94        <table class="members">
95          <tr>
96            <td width="100"> </td>
97            <th>
98              <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span>
99            </th>
100            <td>
101        </td>
102          </tr>
103          <tr>
104            <td width="100"> </td>
105            <th>
106              <span class="argument">m_CommandCache</span>
107            </th>
108            <td>
109        </td>
110          </tr>
111          <tr>
112            <td width="100"> </td>
113            <th>
114              <span class="argument">m_CommandCacheSize</span>
115            </th>
116            <td>
117        </td>
118          </tr>
119          <tr>
120            <td width="100"> </td>
121            <th>
122              <span class="argument">m_DeactivateVertexCommandCache</span>
123            </th>
124            <td>
125        </td>
126          </tr>
127          <tr>
128            <td width="100"> </td>
129            <th>
130              <span class="argument">m_DeactivateVertexCommandCacheSize</span>
131            </th>
132            <td>
133        </td>
134          </tr>
135          <tr>
136            <td width="100"> </td>
137            <th>
138              <span class="argument">m_PrimitiveCommandCache</span>
139            </th>
140            <td>
141        </td>
142          </tr>
143          <tr>
144            <td width="100"> </td>
145            <th>
146              <span class="argument">m_PrimitiveCommandCacheSize</span>
147            </th>
148            <td>
149        </td>
150          </tr> </table>
151      </div>
152    </a> <a name="function" id="function">
153      <h2>Member Functions</h2>
154      <div class="section">
155        <table class="members">
156          <tr>
157            <th class="category" colspan="3">Creation</th>
158          </tr>
159          <tr>
160            <td width="100">
161              <span class="static_style" title="static">S</span> </td>
162            <th>
163              <a href="../../../nw/gfx/ParticleShape/Create.html">Create</a>
164            </th>
165            <td>Creates a particle shape node from a resource.</td>
166          </tr>
167          <tr>
168            <td width="100">
169              <span class="static_style" title="static">S</span> </td>
170            <th>
171              <a href="../../../nw/gfx/ParticleShape/GetMemorySize.html">GetMemorySize</a>
172            </th>
173            <td>Gets the memory size required at time of creation.</td>
174          </tr>
175          <tr>
176            <td width="100">
177              <span class="static_style" title="static">S</span> </td>
178            <th>
179              <a href="../../../nw/gfx/ParticleShape/GetDeviceMemorySize.html"><CODE>GetDeviceMemorySize</CODE></a>
180            </th>
181            <td>Gets the device memory size required at time of creation.</td>
182          </tr>
183          <tr>
184            <th class="category" colspan="3">Set/Get</th>
185          </tr>
186          <tr>
187            <td width="100">  </td>
188            <th>
189              <a href="../../../nw/gfx/ParticleShape/GetResParticleShape.html"><CODE>GetResParticleShape</CODE></a>
190            </th>
191            <td>Gets the resource.</td>
192          </tr>
193          <tr>
194            <td width="100">  </td>
195            <th>
196              <a href="../../../nw/gfx/ParticleShape/GetVertexAttributesCount.html"><CODE>GetVertexAttributesCount</CODE></a>
197            </th>
198            <td>Gets the number of vertex attributes.</td>
199          </tr>
200          <tr>
201            <td width="100">  </td>
202            <th>
203              <a href="../../../nw/gfx/ParticleShape/IsVertexStream.html">IsVertexStream</a>
204            </th>
205            <td>Checks if the vertex attribute is a stream.</td>
206          </tr>
207          <tr>
208            <td width="100">  </td>
209            <th>
210              <a href="../../../nw/gfx/ParticleShape/GetVertexAttributeUsage.html">GetVertexAttributeUsage</a>
211            </th>
212            <td>Gets the vertex attributes usage type.</td>
213          </tr>
214          <tr>
215            <td width="100">  </td>
216            <th>
217              <a href="../../../nw/gfx/ParticleShape/GetVertexAttributeFormatType.html">GetVertexAttributeFormatType</a>
218            </th>
219            <td>Gets the vertex attributes format.</td>
220          </tr>
221          <tr>
222            <td width="100">  </td>
223            <th>
224              <a href="../../../nw/gfx/ParticleShape/GetVertexAttributeDimension.html">GetVertexAttributeDimension</a>
225            </th>
226            <td>Gets the vertex attributes dimension.</td>
227          </tr>
228          <tr>
229            <td width="100">  </td>
230            <th>
231              <a href="../../../nw/gfx/ParticleShape/GetVertexStreamPtr.html"><CODE>GetVertexStreamPtr</CODE></a>
232            </th>
233            <td>Gets a pointer to a stream of vertex attributes.</td>
234          </tr>
235          <tr>
236            <td width="100">  </td>
237            <th>
238              <a href="../../../nw/gfx/ParticleShape/GetVertexParameter.html">GetVertexParameter</a>
239            </th>
240            <td>Gets the vertex attributes parameters.</td>
241          </tr>
242          <tr>
243            <td width="100">  </td>
244            <th>
245              <a href="../../../nw/gfx/ParticleShape/SetVertexAttributeCommandPtr.html">SetVertexAttributeCommandPtr</a>
246            </th>
247            <td>: private</td>
248          </tr>
249          <tr>
250            <td width="100">  </td>
251            <th>
252              <a href="../../../nw/gfx/ParticleShape/GetPrimitiveStreamPtr.html"><CODE>GetPrimitiveStreamPtr</CODE></a>
253            </th>
254            <td>Gets a pointer to a stream of primitives.</td>
255          </tr>
256          <tr>
257            <td width="100">  </td>
258            <th>
259              <a href="../../../nw/gfx/ParticleShape/GetVertexCapacity.html"><CODE>GetVertexCapacity</CODE></a>
260            </th>
261            <td>Gets the maximum number of particles that can be stored in each stream.</td>
262          </tr>
263          <tr>
264            <td width="100">  </td>
265            <th>
266              <a href="../../../nw/gfx/ParticleShape/SetBufferSide.html"><CODE>SetBufferSide</CODE></a>
267            </th>
268            <td>Swaps the target buffer (switches from the calculation buffer to the render buffer, or vice versa).</td>
269          </tr>
270          <tr>
271            <td width="100">  </td>
272            <th>
273              <a href="../../../nw/gfx/ParticleShape/GetBufferSide.html">GetBufferSide</a>
274            </th>
275            <td>Gets the front side buffer number.</td>
276          </tr>
277          <tr>
278            <th class="category" colspan="3">Resources</th>
279          </tr>
280          <tr>
281            <td width="100">  </td>
282            <th>
283              <a href="../../../nw/gfx/SceneObject/GetResSceneObject.html"><CODE>GetResSceneObject</CODE></a>
284            </th>
285            <td>Gets the scene object resource.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td>
286          </tr>
287          <tr>
288            <td width="100">  </td>
289            <th>
290              <a href="../../../nw/gfx/SceneObject/GetName.html">GetName</a>
291            </th>
292            <td>Gets the name from the resource.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td>
293          </tr>
294          <tr>
295            <th class="category" colspan="3">Create/Destroy</th>
296          </tr>
297          <tr>
298            <td width="100">  </td>
299            <th>
300              <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a>
301            </th>
302            <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.</td>
303          </tr>
304          <tr>
305            <th class="category" colspan="3">Constructors and Destructors</th>
306          </tr>
307          <tr>
308            <td width="100">
309              <span class="protected_style" title="protected">protected</span>  </td>
310            <th>
311              <a href="../../../nw/gfx/ParticleShape/ParticleShape.html"><CODE>ParticleShape</CODE></a>
312            </th>
313            <td>Constructor.</td>
314          </tr>
315          <tr>
316            <td width="100">
317              <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span>
318            </td>
319            <th>
320              <a href="../../../nw/gfx/ParticleShape/~ParticleShape.html"><CODE>~ParticleShape</CODE></a>
321            </th>
322            <td>Destructor.</td>
323          </tr> </table>
324      </div>
325    </a>
326    <h2>Class Hierarchy</h2>
327    <div class="section">
328      <p class="hierarchy"><a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a><br />  <a href="../../../nw/gfx/SceneObject/Overview.html">nw::gfx::SceneObject</a><br />    <b>nw::gfx::ParticleShape</b>
329      </p>
330    </div>
331  <hr><p>CONFIDENTIAL</p></body>
332</html>
333