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