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 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nw::gfx::ParticleCollection</title> 51 </head> 52 <body> 53 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/gfx/Overview.html">gfx</a>::ParticleCollection</CODE> Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class ParticleCollection : public <a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a></pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>Class that represents information about particles within a particle system.</p> 61 </div> 62 <a name="variable" id="variable"> 63 <h2>Member Variables</h2> 64 <div class="section"> 65 <table class="members"> 66 <tr> 67 <td width="100"> </td> 68 <th> 69 <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span> 70 </th> 71 <td width="100" /> 72 <td> 73 </td> 74 </tr> </table> 75 </div> 76 </a> <a name="function" id="function"> 77 <h2>Member Functions</h2> 78 <div class="section"> 79 <table class="members"> 80 <tr> 81 <th class="category" colspan="3">Create/Destroy</th> 82 </tr> 83 <tr> 84 <td width="100"> 85 <span class="static_style" title="static">S</span> </td> 86 <th> 87 <a href="../../../nw/gfx/ParticleCollection/Create.html">Create</a> 88 </th> 89 <td>Creates ParticleCollection nodes from resources.</td> 90 </tr> 91 <tr> 92 <td width="100"> 93 <span class="static_style" title="static">S</span> </td> 94 <th> 95 <a href="../../../nw/gfx/ParticleCollection/GetMemorySize.html">GetMemorySize</a> 96 </th> 97 <td>Gets the memory size required at time of creation.</td> 98 </tr> 99 <tr> 100 <td width="100"> 101 <span class="static_style" title="static">S</span> </td> 102 <th> 103 <a href="../../../nw/gfx/ParticleCollection/GetDeviceMemorySize.html"><CODE>GetDeviceMemorySize</CODE></a> 104 </th> 105 <td>Gets the device memory size required at time of creation.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a> 111 </th> 112 <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.)</td> 113 </tr> 114 <tr> 115 <th class="category" colspan="3">Set/Get</th> 116 </tr> 117 <tr> 118 <td width="100"> </td> 119 <th> 120 <a href="../../../nw/gfx/ParticleCollection/GetResParticleCollection.html"><CODE>GetResParticleCollection</CODE></a> 121 </th> 122 <td>Gets the resource.</td> 123 </tr> 124 <tr> 125 <td width="100"> </td> 126 <th> 127 <a href="../../../nw/gfx/ParticleCollection/GetCapacity.html"><CODE>GetCapacity</CODE></a> 128 </th> 129 <td>Gets the maximum number of particles.</td> 130 </tr> 131 <tr> 132 <td width="100"> </td> 133 <th> 134 <a href="../../../nw/gfx/ParticleCollection/GetCount.html"><CODE>GetCount</CODE></a> 135 </th> 136 <td>Gets the number of particles.</td> 137 </tr> 138 <tr> 139 <td width="100"> </td> 140 <th> 141 <a href="../../../nw/gfx/ParticleCollection/SetCount.html"><CODE>SetCount</CODE></a> 142 </th> 143 <td>Sets the number of particles.</td> 144 </tr> 145 <tr> 146 <td width="100"> </td> 147 <th> 148 <a href="../../../nw/gfx/ParticleCollection/IsStream.html">IsStream</a> 149 </th> 150 <td>Checks whether the specified attribute is a stream.</td> 151 </tr> 152 <tr> 153 <td width="100"> </td> 154 <th> 155 <a href="../../../nw/gfx/ParticleCollection/GetStreamPtr.html"><CODE>GetStreamPtr</CODE></a> 156 </th> 157 <td>Gets the pointer to the stream for the specified attribute.</td> 158 </tr> 159 <tr> 160 <td width="100"> </td> 161 <th> 162 <a href="../../../nw/gfx/ParticleCollection/GetParameterPtr.html">GetParameterPtr</a> 163 </th> 164 <td>Gets the pointer to the parameter for the specified attribute.</td> 165 </tr> 166 <tr> 167 <td width="100"> </td> 168 <th> 169 <a href="../../../nw/gfx/ParticleCollection/SetLifeParameter.html">SetLifeParameter</a> 170 </th> 171 <td>Sets the PARTICLEUSAGE_LIFE parameter.</td> 172 </tr> 173 <tr> 174 <td width="100"> </td> 175 <th> 176 <a href="../../../nw/gfx/ParticleCollection/GetStreamOrParameter.html"><CODE>GetStreamOrParameter</CODE></a> 177 </th> 178 <td>Gets the stream or parameter for the specified attribute.</td> 179 </tr> 180 <tr> 181 <td width="100"> </td> 182 <th> 183 <a href="../../../nw/gfx/ParticleCollection/Clear.html"><CODE>Clear</CODE></a> 184 </th> 185 <td>This function clears all streams.</td> 186 </tr> 187 <tr> 188 <td width="100"> </td> 189 <th> 190 <a href="../../../nw/gfx/ParticleCollection/SwapBuffer.html">SwapBuffer</a> 191 </th> 192 <td>Swaps the target buffer (switches from the calculation buffer to the render buffer, or vice versa).</td> 193 </tr> 194 <tr> 195 <td width="100"> </td> 196 <th> 197 <a href="../../../nw/gfx/ParticleCollection/KillParticles.html"><CODE>KillParticles</CODE></a> 198 </th> 199 <td>Deletes all generated particles. The particles are actually removed at the next round of deletion. If child particle emission occurs before that, it is handled as it would be at finalization.</td> 200 </tr> 201 <tr> 202 <td width="100"> </td> 203 <th> 204 <a href="../../../nw/gfx/ParticleCollection/KillParticle.html">KillParticle</a> 205 </th> 206 <td>Removes the particle having the specified index. The particles are actually removed at the next round of deletion. If child particle emission occurs before that, it is handled as it would be at finalization.</td> 207 </tr> 208 <tr> 209 <th class="category" colspan="3">Constructors and Destructors</th> 210 </tr> 211 <tr> 212 <td width="100"> 213 <span class="protected_style" title="protected">protected</span> </td> 214 <th> 215 <a href="../../../nw/gfx/ParticleCollection/ParticleCollection.html"><CODE>ParticleCollection</CODE></a> 216 </th> 217 <td>Constructor.</td> 218 </tr> 219 <tr> 220 <td width="100"> 221 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 222 </td> 223 <th> 224 <a href="../../../nw/gfx/ParticleCollection/~ParticleCollection.html"><CODE>~ParticleCollection</CODE></a> 225 </th> 226 <td>Destructor.</td> 227 </tr> </table> 228 </div> 229 </a> 230 <h2>Class Hierarchy</h2> 231 <div class="section"> 232 <p class="hierarchy"><a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a><br /> <b>nw::gfx::ParticleCollection</b> 233 </p> 234 </div> 235 <hr><p>CONFIDENTIAL</p></body> 236</html>