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::SceneNode</title> 49 </head> 50 <body> 51 <h1><CODE>nw::gfx::SceneNode</CODE> Class</h1> 52 <h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class SceneNode : 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 acting as the type of node from which the scene tree is built. Can have multiple children.</p> 59 </div> 60 <a name="class" id="class"> 61 <h2>Classes</h2> 62 <div class="section"> 63 <table class="members"> 64 <tr> 65 <th> 66 <a href="../../../nw/gfx/SceneNode/DynamicBuilder/Overview.html"><CODE>nw::gfx::SceneNode::DynamicBuilder</CODE></a> 67 </th> 68 <td>Class for building scene nodes dynamically.</td> 69 </tr> </table> 70 </div> 71 </a> <a name="struct" id="struct"> 72 <h2>Structures</h2> 73 <div class="section"> 74 <table class="members"> 75 <tr> 76 <th> 77 <a href="../../../nw/gfx/SceneNode/Description/Overview.html"><CODE>nw::gfx::SceneNode::Description</CODE></a> 78 </th> 79 <td>Content to configure.</td> 80 </tr> </table> 81 </div> 82 </a> <a name="enum" id="enum"> 83 <h2>Enumerated Types</h2> 84 <div class="section"> 85 <table class="members"> 86 <tr> 87 <td width="100"> </td> 88 <th> 89 <a href="../../../nw/gfx/SceneNode/TraversalResults.html"><CODE>TraversalResults</CODE></a> 90 </th> 91 <td>Definition of the bit flag indicating the traversal results.</td> 92 </tr> </table> 93 </div> 94 </a> <a name="typedef" id="typedef"> 95 <h2><CODE>typedef</CODE> Definitions</h2> 96 <div class="section"> 97 <table class="members"> 98 <tr> 99 <td width="100" /> 100 <th> 101 <a href="../../../nw/gfx/SceneNode/UpdateSignal.html"><CODE>UpdateSignal</CODE></a> 102 </th> 103 <td>Definition of a callback signal that is called during updates.</td> 104 </tr> 105 <tr> 106 <td width="100" /> 107 <th> 108 <a href="../../../nw/gfx/SceneNode/UpdateSlot.html"><CODE>UpdateSlot</CODE></a> 109 </th> 110 <td>Definition of a callback slot that is called during updates.</td> 111 </tr> </table> 112 </div> 113 </a> <a name="constant" id="constant"> 114 <h2>Member Constants</h2> 115 <div class="section"> 116 <table class="members"> 117 <tr> 118 <td width="100"> 119 <span class="static_style" title="static">S</span> 120 </td> 121 <th> 122 <span class="argument"><a href="../../../nw/gfx/SceneObject/DEFAULT_MAX_CHILDREN.html"><CODE>DEFAULT_MAX_CHILDREN</CODE></a></span> 123 </th> 124 <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> 125 </tr> 126 <tr> 127 <td width="100"> 128 <span class="static_style" title="static">S</span> 129 </td> 130 <th> 131 <span class="argument"><a href="../../../nw/gfx/SceneObject/DEFAULT_MAX_CALLBACKS.html"><CODE>DEFAULT_MAX_CALLBACKS</CODE></a></span> 132 </th> 133 <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> 134 </tr> 135 <tr> 136 <td width="100"> 137 <span class="static_style" title="static">S</span> 138 </td> 139 <th> 140 <span class="argument"><a href="../../../nw/gfx/SceneObject/MAX_NAME_LENGTH.html"><CODE>MAX_NAME_LENGTH</CODE></a></span> 141 </th> 142 <td>Limit on names of scene objects.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td> 143 </tr> </table> 144 </div> 145 </a> <a name="variable" id="variable"> 146 <h2>Member Variables</h2> 147 <div class="section"> 148 <table class="members"> 149 <tr> 150 <td width="100"> </td> 151 <th> 152 <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span> 153 </th> 154 <td> 155 </td> 156 </tr> 157 <tr> 158 <td width="100"> 159 <span class="protected_style" title="protected">protected</span> </td> 160 <th> 161 <span class="argument">m_Children</span> 162 </th> 163 <td>Child node.</td> 164 </tr> 165 <tr> 166 <td width="100"> 167 <span class="protected_style" title="protected">protected</span> </td> 168 <th> 169 <span class="argument">m_AnimBinding</span> 170 </th> 171 <td>Animation binding.</td> 172 </tr> </table> 173 </div> 174 </a> <a name="function" id="function"> 175 <h2>Member Functions</h2> 176 <div class="section"> 177 <table class="members"> 178 <tr> 179 <th class="category" colspan="3">Create/Destroy</th> 180 </tr> 181 <tr> 182 <td width="100"> 183 <span class="static_style" title="static">S</span> </td> 184 <th> 185 <a href="../../../nw/gfx/SceneNode/Create.html">Create</a> 186 </th> 187 <td>Generates a scene node.</td> 188 </tr> 189 <tr> 190 <td width="100"> </td> 191 <th> 192 <a href="../../../nw/gfx/SceneNode/DestroyBranch.html"><CODE>DestroyBranch</CODE></a> 193 </th> 194 <td>Destroys all nodes on the current branch, including the current node.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199 <a href="../../../nw/gfx/GfxObject/Destroy.html"><CODE>Destroy</CODE></a> 200 </th> 201 <td>Destroys an object.(Derived from <a href="../../../nw/gfx/GfxObject/Overview.html"><CODE>GfxObject</CODE></a>.</td> 202 </tr> 203 <tr> 204 <th class="category" colspan="3">Resources</th> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209 <a href="../../../nw/gfx/SceneNode/GetResSceneNode.html"><CODE>GetResSceneNode</CODE></a> 210 </th> 211 <td>Gets the scene node resource.</td> 212 </tr> 213 <tr> 214 <td width="100"> </td> 215 <th> 216 <a href="../../../nw/gfx/SceneObject/GetResSceneObject.html"><CODE>GetResSceneObject</CODE></a> 217 </th> 218 <td>Gets the scene object resource.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223 <a href="../../../nw/gfx/SceneObject/GetName.html">GetName</a> 224 </th> 225 <td>Gets the name from the resource.(Derived from <a href="../../../nw/gfx/SceneObject/Overview.html"><CODE>SceneObject</CODE></a>.</td> 226 </tr> 227 <tr> 228 <th class="category" colspan="3">Transform</th> 229 </tr> 230 <tr> 231 <td width="100"> <span class="virtual_style" title="virtual">V</span> 232 </td> 233 <th> 234 <a href="../../../nw/gfx/SceneNode/UpdateTransform.html">UpdateTransform</a> 235 </th> 236 <td>Updates conversion information.</td> 237 </tr> 238 <tr> 239 <th class="category" colspan="3">Scene Tree</th> 240 </tr> 241 <tr> 242 <td width="100"> </td> 243 <th> 244 <a href="../../../nw/gfx/SceneNode/AttachChild.html"><CODE>AttachChild</CODE></a> 245 </th> 246 <td>Attaches a child.</td> 247 </tr> 248 <tr> 249 <td width="100"> </td> 250 <th> 251 <a href="../../../nw/gfx/SceneNode/DetachChild.html"><CODE>DetachChild</CODE></a> 252 </th> 253 <td>Removes a child.</td> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258 <a href="../../../nw/gfx/SceneNode/GetChildBegin.html"><CODE>GetChildBegin</CODE></a> 259 </th> 260 <td>Gets the beginning of a child.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265 <a href="../../../nw/gfx/SceneNode/GetChildEnd.html"><CODE>GetChildEnd</CODE></a> 266 </th> 267 <td>Gets the end of a child.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272 <a href="../../../nw/gfx/SceneNode/DetachAllChildren.html"><CODE>DetachAllChildren</CODE></a> 273 </th> 274 <td>Removes all children.</td> 275 </tr> 276 <tr> 277 <td width="100"> <span class="virtual_style" title="virtual">V</span> 278 </td> 279 <th> 280 <a href="../../../nw/gfx/SceneNode/Accept.html"><CODE>Accept</CODE></a> 281 </th> 282 <td>Accepts visitors.</td> 283 </tr> 284 <tr> 285 <td width="100"> <span class="virtual_style" title="virtual">V</span> 286 </td> 287 <th> 288 <a href="../../../nw/gfx/SceneNode/TrackbackWorldMatrix.html"><CODE>TrackbackWorldMatrix</CODE></a> 289 </th> 290 <td>Tracks back to the parent node and gets the world matrix.</td> 291 </tr> 292 <tr> 293 <td width="100"> <span class="virtual_style" title="virtual">V</span> 294 </td> 295 <th> 296 <a href="../../../nw/gfx/SceneNode/TrackbackWorldTransform.html">TrackbackWorldTransform</a> 297 </th> 298 <td>Tracks back to the parent node and gets the world transform.</td> 299 </tr> 300 <tr> 301 <td width="100"> <span class="virtual_style" title="virtual">V</span> 302 </td> 303 <th> 304 <a href="../../../nw/gfx/SceneNode/TrackbackLocalTransform.html">TrackbackLocalTransform</a> 305 </th> 306 <td>Tracks back to the parent node and gets the local transform.</td> 307 </tr> 308 <tr> 309 <th class="category" colspan="3">Callbacks</th> 310 </tr> 311 <tr> 312 <td width="100"> </td> 313 <th> 314 <a href="../../../nw/gfx/SceneNode/PreUpdateSignal.html"><CODE>PreUpdateSignal</CODE></a> 315 </th> 316 <td>Gets the signal before the scene node is updated.</td> 317 </tr> 318 <tr> 319 <th class="category" colspan="3">Animation</th> 320 </tr> 321 <tr> 322 <td width="100"> </td> 323 <th> 324 <a href="../../../nw/gfx/SceneNode/GetAnimBinding.html"><CODE>GetAnimBinding</CODE></a> 325 </th> 326 <td>Gets the animation binding.</td> 327 </tr> 328 <tr> 329 <td width="100"> </td> 330 <th> 331 <a href="../../../nw/gfx/SceneNode/SetAnimBinding.html"><CODE>SetAnimBinding</CODE></a> 332 </th> 333 <td>Sets the animation binding.</td> 334 </tr> 335 <tr> 336 <td width="100"> </td> 337 <th> 338 <a href="../../../nw/gfx/SceneNode/UpdateFrame.html">UpdateFrame</a> 339 </th> 340 <td>Updates the frames for all configured animation objects.</td> 341 </tr> 342 <tr> 343 <th class="category" colspan="3">Traverse</th> 344 </tr> 345 <tr> 346 <td width="100"> </td> 347 <th> 348 <a href="../../../nw/gfx/SceneNode/GetTraversalResults.html"><CODE>GetTraversalResults</CODE></a> 349 </th> 350 <td>Gets the results of a traversal.</td> 351 </tr> 352 <tr> 353 <td width="100"> </td> 354 <th> 355 <a href="../../../nw/gfx/SceneNode/SetTraversalResults.html"><CODE>SetTraversalResults</CODE></a> 356 </th> 357 <td>Sets the results of a traversal.</td> 358 </tr> 359 <tr> 360 <td width="100"> </td> 361 <th> 362 <a href="../../../nw/gfx/SceneNode/IsEnabledResults.html"><CODE>IsEnabledResults</CODE></a> 363 </th> 364 <td>Gets a value indicating whether a given traversal result is enabled.</td> 365 </tr> 366 <tr> 367 <td width="100"> </td> 368 <th> 369 <a href="../../../nw/gfx/SceneNode/EnableTraversalResults.html"><CODE>EnableTraversalResults</CODE></a> 370 </th> 371 <td>Enables the results of a traversal.</td> 372 </tr> 373 <tr> 374 <td width="100"> </td> 375 <th> 376 <a href="../../../nw/gfx/SceneNode/DisableTraversalResults.html"><CODE>DisableTraversalResults</CODE></a> 377 </th> 378 <td>Disables the results of a traversal.</td> 379 </tr> 380 <tr> 381 <td width="100"> </td> 382 <th> 383 <a href="../../../nw/gfx/SceneNode/ResetTraversalResults.html"><CODE>ResetTraversalResults</CODE></a> 384 </th> 385 <td>Copies the result of traversal from a node.</td> 386 </tr> 387 <tr> 388 <td width="100"> </td> 389 <th> 390 <a href="../../../nw/gfx/SceneNode/CopyTraversalResults.html"><CODE>CopyTraversalResults</CODE></a> 391 </th> 392 <td>Copies the result of traversal from a node.</td> 393 </tr> 394 <tr> 395 <td width="100"> <span class="virtual_style" title="virtual">V</span> 396 </td> 397 <th> 398 <a href="../../../nw/gfx/SceneNode/InheritTraversalResults.html">InheritTraversalResults</a> 399 </th> 400 <td>Inherits conversion information from the parent node.</td> 401 </tr> 402 <tr> 403 <td width="100"> </td> 404 <th> 405 <a href="../../../nw/gfx/SceneNode/SetBranchVisible.html"><CODE>SetBranchVisible</CODE></a> 406 </th> 407 <td>Sets the flag used to render below the node.</td> 408 </tr> 409 <tr> 410 <td width="100"> </td> 411 <th> 412 <a href="../../../nw/gfx/SceneNode/IsBranchVisible.html">IsBranchVisible</a> 413 </th> 414 <td>Gets the flag used to render below the node.</td> 415 </tr> 416 <tr> 417 <th class="category" colspan="3">Constructors and Destructors</th> 418 </tr> 419 <tr> 420 <td width="100"> 421 <span class="protected_style" title="protected">protected</span> </td> 422 <th> 423 <a href="../../../nw/gfx/SceneNode/SceneNode.html"><CODE>SceneNode</CODE></a> 424 </th> 425 <td>Constructor.</td> 426 </tr> 427 <tr> 428 <td width="100"> 429 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 430 </td> 431 <th> 432 <a href="../../../nw/gfx/SceneNode/~SceneNode.html"><CODE>~SceneNode</CODE></a> 433 </th> 434 <td>Destructor.</td> 435 </tr> 436 <tr> 437 <th class="category" colspan="3">Other</th> 438 </tr> 439 <tr> 440 <td width="100"> 441 <span class="protected_style" title="protected">protected</span> </td> 442 <th> 443 <a href="../../../nw/gfx/SceneNode/IsCircularReference.html"><CODE>IsCircularReference</CODE></a> 444 </th> 445 <td>Returns <CODE>true</CODE> if there is a circular reference.</td> 446 </tr> 447 <tr> 448 <td width="100"> 449 <span class="protected_style" title="protected">protected</span> </td> 450 <th> 451 <a href="../../../nw/gfx/SceneNode/AcceptChildren.html"><CODE>AcceptChildren</CODE></a> 452 </th> 453 <td>Makes all nodes accept visitors.</td> 454 </tr> 455 <tr> 456 <td width="100"> 457 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 458 </td> 459 <th> 460 <a href="../../../nw/gfx/SceneNode/Initialize.html"><CODE>Initialize</CODE></a> 461 </th> 462 <td>Allocates memory for and initialized members.</td> 463 </tr> </table> 464 </div> 465 </a> 466 <h2>Class Hierarchy</h2> 467 <div class="section"> 468 <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::SceneNode</b> 469 </p> 470 </div> 471 <hr><p>CONFIDENTIAL</p></body> 472</html> 473