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::BasicRenderQueue</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/gfx/Overview.html">gfx</a>::BasicRenderQueue</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">template <typename TElement, typename TElementList, typename TElementKeyFactory> 55class BasicRenderQueue : public <a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a></pre> 56 </div> 57 <h2>Template Arguments</h2> 58 <div class="section"> 59 <table class="arguments"> 60 <thead> 61 <tr> 62 <th>Name</th> 63 <td>Description</td> 64 </tr> 65 </thead> 66 <tr> 67 <th><CODE>TElement</CODE></th> 68 <td>Class serving as the render unit.</td> 69 </tr> 70 <tr> 71 <th><CODE>TElementList</CODE></th> 72 <td>Container used to store the class serving as the render unit.</td> 73 </tr> 74 <tr> 75 <th><CODE>TElementKeyFactory</CODE></th> 76 <td>Class that creates the keys used to sort the render units.</td> 77 </tr> </table> 78 </div> 79 <h2>Description</h2> 80 <div class="section"> 81 <p>Queue class that stores render elements.</p> 82 </div> 83 <a name="class" id="class"> 84 <h2>Classes</h2> 85 <div class="section"> 86 <table class="members"> 87 <tr> 88 <th> 89 <a href="../../../nw/gfx/BasicRenderQueue/Builder/Overview.html"><CODE>nw::gfx::BasicRenderQueue::Builder</CODE></a> 90 </th> 91 <td>Class for creating <a href="../../../../nw/gfx/BasicRenderQueue/Overview.html"><CODE>BasicRenderQueue</CODE></a>s.</td> 92 </tr> </table> 93 </div> 94 </a> <a name="struct" id="struct"> 95 <h2>Structures</h2> 96 <div class="section"> 97 <table class="members"> 98 <tr> 99 <th> 100 <a href="../../../nw/gfx/BasicRenderQueue/AlwaysCalculatingFunctor/Overview.html">nw::gfx::BasicRenderQueue::AlwaysCalculatingFunctor</a> 101 </th> 102 <td>Always calculates the depth.</td> 103 </tr> 104 <tr> 105 <th> 106 <a href="../../../nw/gfx/BasicRenderQueue/BasicEnqueueModelFunctor/Overview.html">nw::gfx::BasicRenderQueue::BasicEnqueueModelFunctor</a> 107 </th> 108 <td>Functor for adding models to the render queue.</td> 109 </tr> 110 <tr> 111 <th> 112 <a href="../../../nw/gfx/BasicRenderQueue/BasicEnqueueModelTranslucentModelBaseFunctor/Overview.html">nw::gfx::BasicRenderQueue::BasicEnqueueModelTranslucentModelBaseFunctor</a> 113 </th> 114 <td>Functor for adding models to the render queue.</td> 115 </tr> 116 <tr> 117 <th> 118 <a href="../../../nw/gfx/BasicRenderQueue/CalculateDepthFunctor/Overview.html">nw::gfx::BasicRenderQueue::CalculateDepthFunctor</a> 119 </th> 120 <td>Function object that calculates depth in the clip coordinate system.</td> 121 </tr> 122 <tr> 123 <th> 124 <a href="../../../nw/gfx/BasicRenderQueue/CalculateDepthOfSkeletalModelFunctor/Overview.html">nw::gfx::BasicRenderQueue::CalculateDepthOfSkeletalModelFunctor</a> 125 </th> 126 <td>Function object that calculates depth in the clip coordinate system used for skeletal models.</td> 127 </tr> 128 <tr> 129 <th> 130 <a href="../../../nw/gfx/BasicRenderQueue/IsCalculatingOnlyLayer1Functor/Overview.html">nw::gfx::BasicRenderQueue::IsCalculatingOnlyLayer1Functor</a> 131 </th> 132 <td>Function object that calculates depth only when the render layer is 1 (translucent).</td> 133 </tr> 134 <tr> 135 <th> 136 <a href="../../../nw/gfx/BasicRenderQueue/ReportFunctor/Overview.html">nw::gfx::BasicRenderQueue::ReportFunctor</a> 137 </th> 138 <td>Function object for reporting render queue status to log output.</td> 139 </tr> </table> 140 </div> 141 </a> <a name="typedef" id="typedef"> 142 <h2><CODE>typedef</CODE> Definitions</h2> 143 <div class="section"> 144 <table class="members"> 145 <tr> 146 <td width="100" /> 147 <th> 148 <a href="../../../nw/gfx/BasicRenderQueue/ElementType.html"><CODE>ElementType</CODE></a> 149 </th> 150 <td> 151 </td> 152 </tr> 153 <tr> 154 <td width="100" /> 155 <th> 156 <a href="../../../nw/gfx/BasicRenderQueue/ElementListType.html"><CODE>ElementListType</CODE></a> 157 </th> 158 <td> 159 </td> 160 </tr> 161 <tr> 162 <td width="100" /> 163 <th> 164 <a href="../../../nw/gfx/BasicRenderQueue/ElementKeyFactoryType.html"><CODE>ElementKeyFactoryType</CODE></a> 165 </th> 166 <td> 167 </td> 168 </tr> 169 <tr> 170 <td width="100" /> 171 <th> 172 <a href="../../../nw/gfx/BasicRenderQueue/ElementKeyType.html"><CODE>ElementKeyType</CODE></a> 173 </th> 174 <td> 175 </td> 176 </tr> 177 <tr> 178 <td width="100" /> 179 <th> 180 <a href="../../../nw/gfx/BasicRenderQueue/reference.html"><CODE>reference</CODE></a> 181 </th> 182 <td> 183 </td> 184 </tr> 185 <tr> 186 <td width="100" /> 187 <th> 188 <a href="../../../nw/gfx/BasicRenderQueue/difference_type.html"><CODE>difference_type</CODE></a> 189 </th> 190 <td> 191 </td> 192 </tr> 193 <tr> 194 <td width="100" /> 195 <th> 196 <a href="../../../nw/gfx/BasicRenderQueue/value_type.html"><CODE>value_type</CODE></a> 197 </th> 198 <td> 199 </td> 200 </tr> 201 <tr> 202 <td width="100" /> 203 <th> 204 <a href="../../../nw/gfx/BasicRenderQueue/iterator.html"><CODE>iterator</CODE></a> 205 </th> 206 <td> 207 </td> 208 </tr> 209 <tr> 210 <td width="100" /> 211 <th> 212 <a href="../../../nw/gfx/BasicRenderQueue/const_iterator.html"><CODE>const_iterator</CODE></a> 213 </th> 214 <td> 215 </td> 216 </tr> 217 <tr> 218 <td width="100" /> 219 <th> 220 <a href="../../../nw/gfx/BasicRenderQueue/reverse_iterator.html"><CODE>reverse_iterator</CODE></a> 221 </th> 222 <td> 223 </td> 224 </tr> 225 <tr> 226 <td width="100" /> 227 <th> 228 <a href="../../../nw/gfx/BasicRenderQueue/const_reverse_iterator.html"><CODE>const_reverse_iterator</CODE></a> 229 </th> 230 <td> 231 </td> 232 </tr> 233 <tr> 234 <td width="100" /> 235 <th> 236 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueModelFunctor.html">EnqueueModelFunctor</a> 237 </th> 238 <td>Functor for adding models to the render queue.</td> 239 </tr> 240 <tr> 241 <td width="100" /> 242 <th> 243 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueSkeletalModelFunctor.html">EnqueueSkeletalModelFunctor</a> 244 </th> 245 <td>The functor for adding skeletal models to the render queue.</td> 246 </tr> 247 <tr> 248 <td width="100" /> 249 <th> 250 <a href="../../../nw/gfx/BasicRenderQueue/FastEnqueueModelFunctor.html">FastEnqueueModelFunctor</a> 251 </th> 252 <td>Functor for adding models to the render queue. Depth is calculated only when the render layer is 1 (translucent).</td> 253 </tr> 254 <tr> 255 <td width="100" /> 256 <th> 257 <a href="../../../nw/gfx/BasicRenderQueue/FastEnqueueSkeletalModelFunctor.html">FastEnqueueSkeletalModelFunctor</a> 258 </th> 259 <td>The functor for adding skeletal models to the render queue. Depth is calculated only when the render layer is 1 (translucent).</td> 260 </tr> 261 <tr> 262 <td width="100" /> 263 <th> 264 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueModelTranslucentModelBaseFunctor.html">EnqueueModelTranslucentModelBaseFunctor</a> 265 </th> 266 <td>Functor for adding models to the render queue.</td> 267 </tr> 268 <tr> 269 <td width="100" /> 270 <th> 271 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueSkeletalModelTranslucentModelBaseFunctor.html">EnqueueSkeletalModelTranslucentModelBaseFunctor</a> 272 </th> 273 <td>The functor for adding skeletal models to the render queue.</td> 274 </tr> 275 <tr> 276 <td width="100" /> 277 <th> 278 <a href="../../../nw/gfx/BasicRenderQueue/FastEnqueueModelTranslucentModelBaseFunctor.html">FastEnqueueModelTranslucentModelBaseFunctor</a> 279 </th> 280 <td>Functor for adding models to the render queue. Depth is calculated only when the render layer is 1 (translucent).</td> 281 </tr> 282 <tr> 283 <td width="100" /> 284 <th> 285 <a href="../../../nw/gfx/BasicRenderQueue/FastEnqueueSkeletalModelTranslucentModelBaseFunctor.html">FastEnqueueSkeletalModelTranslucentModelBaseFunctor</a> 286 </th> 287 <td>The functor for adding skeletal models to the render queue. Depth is calculated only when the render layer is 1 (translucent).</td> 288 </tr> </table> 289 </div> 290 </a> <a name="constant" id="constant"> 291 <h2>Member Constants</h2> 292 <div class="section"> 293 <table class="members"> 294 <tr> 295 <td width="100"> 296 <span class="static_style" title="static">S</span> 297 </td> 298 <th> 299 <span class="argument"><a href="../../../nw/gfx/BasicRenderQueue/PRIORITY_END.html">PRIORITY_END</a></span> 300 </th> 301 <td width="100">const <span>u8</span></td> 302 <td>Definition representing the last (highest value) priority.</td> 303 </tr> </table> 304 </div> 305 </a> <a name="variable" id="variable"> 306 <h2>Member Variables</h2> 307 <div class="section"> 308 <table class="members"> 309 <tr> 310 <td width="100"> </td> 311 <th> 312 <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span> 313 </th> 314 <td width="100" /> 315 <td> 316 </td> 317 </tr> </table> 318 </div> 319 </a> <a name="function" id="function"> 320 <h2>Member Functions</h2> 321 <div class="section"> 322 <table class="members"> 323 <tr> 324 <th class="category" colspan="3">Key Operations</th> 325 </tr> 326 <tr> 327 <td width="100"> </td> 328 <th> 329 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueElement.html">EnqueueElement</a> 330 </th> 331 <td>Adds a render element to the queue.</td> 332 </tr> 333 <tr> 334 <td width="100"> </td> 335 <th> 336 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueMesh.html"><CODE>EnqueueMesh</CODE></a> 337 </th> 338 <td>Adds a mesh to the queue.</td> 339 </tr> 340 <tr> 341 <td width="100"> </td> 342 <th> 343 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueModel.html"><CODE>EnqueueModel</CODE></a> 344 </th> 345 <td>Adds mesh elements included in the model to the queue.</td> 346 </tr> 347 <tr> 348 <td width="100"> </td> 349 <th> 350 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueSkeletalModel.html"><CODE>EnqueueSkeletalModel</CODE></a> 351 </th> 352 <td>Adds mesh elements included in the skeletal model to the queue.</td> 353 </tr> 354 <tr> 355 <td width="100"> </td> 356 <th> 357 <a href="../../../nw/gfx/BasicRenderQueue/EnqueueCommand.html"><CODE>EnqueueCommand</CODE></a> 358 </th> 359 <td>Adds a command to the queue.</td> 360 </tr> 361 <tr> 362 <td width="100"> </td> 363 <th> 364 <a href="../../../nw/gfx/BasicRenderQueue/Reset.html"><CODE>Reset</CODE></a> 365 </th> 366 <td>Deletes all items in the queue.</td> 367 </tr> 368 <tr> 369 <th class="category" colspan="3">Set/Get</th> 370 </tr> 371 <tr> 372 <td width="100"> </td> 373 <th> 374 <a href="../../../nw/gfx/BasicRenderQueue/Size.html">Size</a> 375 </th> 376 <td>Gets the number of elements.</td> 377 </tr> 378 <tr> 379 <td width="100"> </td> 380 <th> 381 <a href="../../../nw/gfx/BasicRenderQueue/Empty.html"><CODE>Empty</CODE></a> 382 </th> 383 <td>Returns <CODE>true</CODE> if there are no elements.</td> 384 </tr> 385 <tr> 386 <td width="100"> </td> 387 <th> 388 <a href="../../../nw/gfx/BasicRenderQueue/Peek.html"><CODE>Peek</CODE></a> 389 </th> 390 <td>Accesses the first element.</td> 391 </tr> 392 <tr> 393 <td width="100"> </td> 394 <th> 395 <a href="../../../nw/gfx/BasicRenderQueue/Begin.html"><CODE>Begin</CODE></a> 396 </th> 397 <td>Gets an iterator to the start.</td> 398 </tr> 399 <tr> 400 <td width="100"> </td> 401 <th> 402 <a href="../../../nw/gfx/BasicRenderQueue/End.html">END</a> 403 </th> 404 <td>Gets an iterator to the end.</td> 405 </tr> 406 <tr> 407 <td width="100"> </td> 408 <th> 409 <a href="../../../nw/gfx/BasicRenderQueue/ReverseBegin.html"><CODE>ReverseBegin</CODE></a> 410 </th> 411 <td>Gets an reverse iterator to the start.</td> 412 </tr> 413 <tr> 414 <td width="100"> </td> 415 <th> 416 <a href="../../../nw/gfx/BasicRenderQueue/ReverseEnd.html"><CODE>ReverseEnd</CODE></a> 417 </th> 418 <td>Gets a reverse iterator to the end.</td> 419 </tr> 420 <tr> 421 <th class="category" colspan="3">Create/Destroy</th> 422 </tr> 423 <tr> 424 <td width="100"> </td> 425 <th> 426 <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a> 427 </th> 428 <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.)</td> 429 </tr> </table> 430 </div> 431 </a> 432 <h2>Class Hierarchy</h2> 433 <div class="section"> 434 <p class="hierarchy"><a href="../../../nw/gfx/GfxObject/Overview.html">nw::gfx::GfxObject</a><br /> <b>nw::gfx::BasicRenderQueue</b> 435 </p> 436 </div> 437 <hr><p>CONFIDENTIAL</p></body> 438</html> 439