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><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/gfx/Overview.html">gfx</a>::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 width="100"><CODE>const int</CODE></td> 71 <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> 72 </tr> 73 <tr> 74 <td width="100"> 75 <span class="static_style" title="static">S</span> 76 </td> 77 <th> 78 <span class="argument"><a href="../../../nw/gfx/SceneObject/DEFAULT_MAX_CALLBACKS.html"><CODE>DEFAULT_MAX_CALLBACKS</CODE></a></span> 79 </th> 80 <td width="100"><CODE>const int</CODE></td> 81 <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> 82 </tr> 83 <tr> 84 <td width="100"> 85 <span class="static_style" title="static">S</span> 86 </td> 87 <th> 88 <span class="argument"><a href="../../../nw/gfx/SceneObject/MAX_NAME_LENGTH.html"><CODE>MAX_NAME_LENGTH</CODE></a></span> 89 </th> 90 <td width="100"><CODE>const int</CODE></td> 91 <td>Limit on names of scene objects.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.)</td> 92 </tr> </table> 93 </div> 94 </a> <a name="variable" id="variable"> 95 <h2>Member Variables</h2> 96 <div class="section"> 97 <table class="members"> 98 <tr> 99 <td width="100"> </td> 100 <th> 101 <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span> 102 </th> 103 <td width="100" /> 104 <td> 105 </td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <span class="argument">m_CommandCache</span> 111 </th> 112 <td width="100">void *</td> 113 <td> 114 </td> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119 <span class="argument">m_CommandCacheSize</span> 120 </th> 121 <td width="100"><span>s32</span></td> 122 <td> 123 </td> 124 </tr> 125 <tr> 126 <td width="100"> </td> 127 <th> 128 <span class="argument">m_DeactivateVertexCommandCache</span> 129 </th> 130 <td width="100">void *</td> 131 <td> 132 </td> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137 <span class="argument">m_DeactivateVertexCommandCacheSize</span> 138 </th> 139 <td width="100"><span>s32</span></td> 140 <td> 141 </td> 142 </tr> 143 <tr> 144 <td width="100"> </td> 145 <th> 146 <span class="argument">m_PrimitiveCommandCache</span> 147 </th> 148 <td width="100">void *</td> 149 <td> 150 </td> 151 </tr> 152 <tr> 153 <td width="100"> </td> 154 <th> 155 <span class="argument">m_PrimitiveCommandCacheSize</span> 156 </th> 157 <td width="100"><span>s32</span></td> 158 <td> 159 </td> 160 </tr> </table> 161 </div> 162 </a> <a name="function" id="function"> 163 <h2>Member Functions</h2> 164 <div class="section"> 165 <table class="members"> 166 <tr> 167 <th class="category" colspan="3">Creation</th> 168 </tr> 169 <tr> 170 <td width="100"> 171 <span class="static_style" title="static">S</span> </td> 172 <th> 173 <a href="../../../nw/gfx/ParticleShape/Create.html"><CODE>Create</CODE></a> 174 </th> 175 <td>Creates a particle shape node from a resource.</td> 176 </tr> 177 <tr> 178 <td width="100"> 179 <span class="static_style" title="static">S</span> </td> 180 <th> 181 <a href="../../../nw/gfx/ParticleShape/GetMemorySize.html"><CODE>GetMemorySize</CODE></a> 182 </th> 183 <td>Gets the memory size required at time of creation.</td> 184 </tr> 185 <tr> 186 <td width="100"> 187 <span class="static_style" title="static">S</span> </td> 188 <th> 189 <a href="../../../nw/gfx/ParticleShape/GetDeviceMemorySize.html"><CODE>GetDeviceMemorySize</CODE></a> 190 </th> 191 <td>Gets the device memory size required at time of creation.</td> 192 </tr> 193 <tr> 194 <th class="category" colspan="3">Set/Get</th> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199 <a href="../../../nw/gfx/ParticleShape/GetResParticleShape.html"><CODE>GetResParticleShape</CODE></a> 200 </th> 201 <td>Gets the resource.</td> 202 </tr> 203 <tr> 204 <td width="100"> </td> 205 <th> 206 <a href="../../../nw/gfx/ParticleShape/GetVertexAttributesCount.html"><CODE>GetVertexAttributesCount</CODE></a> 207 </th> 208 <td>Gets the number of vertex attributes.</td> 209 </tr> 210 <tr> 211 <td width="100"> </td> 212 <th> 213 <a href="../../../nw/gfx/ParticleShape/IsVertexStream.html">IsVertexStream</a> 214 </th> 215 <td>Checks if the vertex attribute is a stream.</td> 216 </tr> 217 <tr> 218 <td width="100"> </td> 219 <th> 220 <a href="../../../nw/gfx/ParticleShape/GetVertexAttributeUsage.html">GetVertexAttributeUsage</a> 221 </th> 222 <td>Gets the vertex attributes usage type.</td> 223 </tr> 224 <tr> 225 <td width="100"> </td> 226 <th> 227 <a href="../../../nw/gfx/ParticleShape/GetVertexAttributeFormatType.html">GetVertexAttributeFormatType</a> 228 </th> 229 <td>Gets the vertex attributes format.</td> 230 </tr> 231 <tr> 232 <td width="100"> </td> 233 <th> 234 <a href="../../../nw/gfx/ParticleShape/GetVertexAttributeDimension.html">GetVertexAttributeDimension</a> 235 </th> 236 <td>Gets the vertex attributes dimension.</td> 237 </tr> 238 <tr> 239 <td width="100"> </td> 240 <th> 241 <a href="../../../nw/gfx/ParticleShape/GetVertexStreamPtr.html"><CODE>GetVertexStreamPtr</CODE></a> 242 </th> 243 <td>Gets a pointer to a stream of vertex attributes.</td> 244 </tr> 245 <tr> 246 <td width="100"> </td> 247 <th> 248 <a href="../../../nw/gfx/ParticleShape/GetVertexParameter.html">GetVertexParameter</a> 249 </th> 250 <td>Gets the vertex attributes parameters.</td> 251 </tr> 252 <tr> 253 <td width="100"> </td> 254 <th> 255 <a href="../../../nw/gfx/ParticleShape/SetVertexAttributeCommandPtr.html">SetVertexAttributeCommandPtr</a> 256 </th> 257 <td>:private</td> 258 </tr> 259 <tr> 260 <td width="100"> </td> 261 <th> 262 <a href="../../../nw/gfx/ParticleShape/GetPrimitiveStreamPtr.html"><CODE>GetPrimitiveStreamPtr</CODE></a> 263 </th> 264 <td>Gets a pointer to a stream of primitives.</td> 265 </tr> 266 <tr> 267 <td width="100"> </td> 268 <th> 269 <a href="../../../nw/gfx/ParticleShape/GetVertexCapacity.html"><CODE>GetVertexCapacity</CODE></a> 270 </th> 271 <td>Gets the maximum number of particles that can be stored in each stream.</td> 272 </tr> 273 <tr> 274 <td width="100"> </td> 275 <th> 276 <a href="../../../nw/gfx/ParticleShape/SetBufferSide.html"><CODE>SetBufferSide</CODE></a> 277 </th> 278 <td>Swaps the target buffer (switches from the calculation buffer to the render buffer, or vice versa).</td> 279 </tr> 280 <tr> 281 <td width="100"> </td> 282 <th> 283 <a href="../../../nw/gfx/ParticleShape/GetBufferSide.html">GetBufferSide</a> 284 </th> 285 <td>Gets the front side buffer number.</td> 286 </tr> 287 <tr> 288 <th class="category" colspan="3">Resources</th> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293 <a href="../../../nw/gfx/SceneObject/GetResSceneObject.html"><CODE>GetResSceneObject</CODE></a> 294 </th> 295 <td>Gets the scene object resource.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.)</td> 296 </tr> 297 <tr> 298 <td width="100"> </td> 299 <th> 300 <a href="../../../nw/gfx/SceneObject/GetName.html"><CODE>GetName</CODE></a> 301 </th> 302 <td>Gets the name from the resource.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.)</td> 303 </tr> 304 <tr> 305 <th class="category" colspan="3">Create/Destroy</th> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310 <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a> 311 </th> 312 <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.)</td> 313 </tr> 314 <tr> 315 <th class="category" colspan="3">Constructors and Destructors</th> 316 </tr> 317 <tr> 318 <td width="100"> 319 <span class="protected_style" title="protected">protected</span> </td> 320 <th> 321 <a href="../../../nw/gfx/ParticleShape/ParticleShape.html"><CODE>ParticleShape</CODE></a> 322 </th> 323 <td>Constructor.</td> 324 </tr> 325 <tr> 326 <td width="100"> 327 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 328 </td> 329 <th> 330 <a href="../../../nw/gfx/ParticleShape/~ParticleShape.html"><CODE>~ParticleShape</CODE></a> 331 </th> 332 <td>Destructor.</td> 333 </tr> </table> 334 </div> 335 </a> 336 <h2>Class Hierarchy</h2> 337 <div class="section"> 338 <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> 339 </p> 340 </div> 341 <hr><p>CONFIDENTIAL</p></body> 342</html> 343