scenegraph.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  1. <!DOCTYPE html><html lang="en"><head>
  2. <meta charset="utf-8">
  3. <title>Scene Graph</title>
  4. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  5. <meta name="twitter:card" content="summary_large_image">
  6. <meta name="twitter:site" content="@threejs">
  7. <meta name="twitter:title" content="Three.js – Scene Graph">
  8. <meta property="og:image" content="https://threejs.org/files/share.png">
  9. <link rel="shortcut icon" href="/files/favicon_white.ico" media="(prefers-color-scheme: dark)">
  10. <link rel="shortcut icon" href="/files/favicon.ico" media="(prefers-color-scheme: light)">
  11. <link rel="stylesheet" href="/manual/resources/lesson.css">
  12. <link rel="stylesheet" href="/manual/resources/lang.css">
  13. </head>
  14. <body>
  15. <div class="container">
  16. <div class="lesson-title">
  17. <h1>Scene Graph</h1>
  18. </div>
  19. <div class="lesson">
  20. <div class="lesson-main">
  21. <p>This article is part of a series of articles about three.js. The
  22. first article is <a href="fundamentals.html">three.js fundamentals</a>. If
  23. you haven't read that yet you might want to consider starting there.</p>
  24. <p>Three.js's core is arguably its scene graph. A scene graph in a 3D
  25. engine is a hierarchy of nodes in a graph where each node represents
  26. a local space.</p>
  27. <p><img src="../resources/images/scenegraph-generic.svg" align="center"></p>
  28. <p>That's kind of abstract so let's try to give some examples.</p>
  29. <p>One example might be solar system, sun, earth, moon.</p>
  30. <p><img src="../resources/images/scenegraph-solarsystem.svg" align="center"></p>
  31. <p>The Earth orbits the Sun. The Moon orbits the Earth. The Moon
  32. moves in a circle around the Earth. From the Moon's point of
  33. view it's rotating in the "local space" of the Earth. Even though
  34. its motion relative to the Sun is some crazy spirograph like
  35. curve from the Moon's point of view it just has to concern itself with rotating
  36. around the Earth's local space.</p>
  37. <p></p><div class="threejs_diagram_container">
  38. <iframe class="threejs_diagram " style="width: 400px; height: 300px;" src="/manual/foo/../resources/moon-orbit.html"></iframe>
  39. </div>
  40. <p></p>
  41. <p>To think of it another way, you living on the Earth do not have to think
  42. about the Earth's rotation on its axis nor its rotation around the
  43. Sun. You just walk or drive or swim or run as though the Earth is
  44. not moving or rotating at all. You walk, drive, swim, run, and live
  45. in the Earth's "local space" even though relative to the sun you are
  46. spinning around the earth at around 1000 miles per hour and around
  47. the sun at around 67,000 miles per hour. Your position in the solar
  48. system is similar to that of the moon above but you don't have to concern
  49. yourself. You just worry about your position relative to the earth in its
  50. "local space".</p>
  51. <p>Let's take it one step at a time. Imagine we want to make
  52. a diagram of the sun, earth, and moon. We'll start with the sun by
  53. just making a sphere and putting it at the origin. Note: We're using
  54. sun, earth, moon as a demonstration of how to use a scene graph. Of course
  55. the real sun, earth, and moon use physics but for our purposes we'll
  56. fake it with a scene graph.</p>
  57. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">// an array of objects whose rotation to update
  58. const objects = [];
  59. // use just one sphere for everything
  60. const radius = 1;
  61. const widthSegments = 6;
  62. const heightSegments = 6;
  63. const sphereGeometry = new THREE.SphereGeometry(
  64. radius, widthSegments, heightSegments);
  65. const sunMaterial = new THREE.MeshPhongMaterial({emissive: 0xFFFF00});
  66. const sunMesh = new THREE.Mesh(sphereGeometry, sunMaterial);
  67. sunMesh.scale.set(5, 5, 5); // make the sun large
  68. scene.add(sunMesh);
  69. objects.push(sunMesh);
  70. </pre>
  71. <p>We're using a really low-polygon sphere. Only 6 subdivisions around its equator.
  72. This is so it's easy to see the rotation.</p>
  73. <p>We're going to reuse the same sphere for everything so we'll set a scale
  74. for the sun mesh of 5x.</p>
  75. <p>We also set the phong material's <code class="notranslate" translate="no">emissive</code> property to yellow. A phong material's
  76. emissive property is basically the color that will be drawn with no light hitting
  77. the surface. Light is added to that color.</p>
  78. <p>Let's also put a single point light in the center of the scene. We'll go into more
  79. details about point lights later but for now the simple version is a point light
  80. represents light that emanates from a single point.</p>
  81. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">{
  82. const color = 0xFFFFFF;
  83. const intensity = 3;
  84. const light = new THREE.PointLight(color, intensity);
  85. scene.add(light);
  86. }
  87. </pre>
  88. <p>To make it easy to see we're going to put the camera directly above the origin
  89. looking down. The easiest way to do that is to use the <code class="notranslate" translate="no">lookAt</code> function. The <code class="notranslate" translate="no">lookAt</code>
  90. function will orient the camera from its position to "look at" the position
  91. we pass to <code class="notranslate" translate="no">lookAt</code>. Before we do that though we need to tell the camera
  92. which way the top of the camera is facing or rather which way is "up" for the
  93. camera. For most situations positive Y being up is good enough but since
  94. we are looking straight down we need to tell the camera that positive Z is up.</p>
  95. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">const camera = new THREE.PerspectiveCamera(fov, aspect, near, far);
  96. camera.position.set(0, 50, 0);
  97. camera.up.set(0, 0, 1);
  98. camera.lookAt(0, 0, 0);
  99. </pre>
  100. <p>In the render loop, adapted from previous examples, we're rotating all
  101. objects in our <code class="notranslate" translate="no">objects</code> array with this code.</p>
  102. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">objects.forEach((obj) =&gt; {
  103. obj.rotation.y = time;
  104. });
  105. </pre>
  106. <p>Since we added the <code class="notranslate" translate="no">sunMesh</code> to the <code class="notranslate" translate="no">objects</code> array it will rotate.</p>
  107. <p></p><div translate="no" class="threejs_example_container notranslate">
  108. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun.html"></iframe></div>
  109. <a class="threejs_center" href="/manual/examples/scenegraph-sun.html" target="_blank">click here to open in a separate window</a>
  110. </div>
  111. <p></p>
  112. <p>Now let's add in the earth.</p>
  113. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">const earthMaterial = new THREE.MeshPhongMaterial({color: 0x2233FF, emissive: 0x112244});
  114. const earthMesh = new THREE.Mesh(sphereGeometry, earthMaterial);
  115. earthMesh.position.x = 10;
  116. scene.add(earthMesh);
  117. objects.push(earthMesh);
  118. </pre>
  119. <p>We make a material that is blue but we gave it a small amount of <em>emissive</em> blue
  120. so that it will show up against our black background.</p>
  121. <p>We use the same <code class="notranslate" translate="no">sphereGeometry</code> with our new blue <code class="notranslate" translate="no">earthMaterial</code> to make
  122. an <code class="notranslate" translate="no">earthMesh</code>. We position that 10 units to the left of the sun
  123. and add it to the scene. Since we added it to our <code class="notranslate" translate="no">objects</code> array it will
  124. rotate too.</p>
  125. <p></p><div translate="no" class="threejs_example_container notranslate">
  126. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun-earth.html"></iframe></div>
  127. <a class="threejs_center" href="/manual/examples/scenegraph-sun-earth.html" target="_blank">click here to open in a separate window</a>
  128. </div>
  129. <p></p>
  130. <p>You can see both the sun and the earth are rotating but the earth is not
  131. going around the sun. Let's make the earth a child of the sun</p>
  132. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">-scene.add(earthMesh);
  133. +sunMesh.add(earthMesh);
  134. </pre>
  135. <p>and...</p>
  136. <p></p><div translate="no" class="threejs_example_container notranslate">
  137. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun-earth-orbit.html"></iframe></div>
  138. <a class="threejs_center" href="/manual/examples/scenegraph-sun-earth-orbit.html" target="_blank">click here to open in a separate window</a>
  139. </div>
  140. <p></p>
  141. <p>What happened? Why is the earth the same size as the sun and why is it so far away?
  142. I actually had to move the camera from 50 units above to 150 units above to see the earth.</p>
  143. <p>We made the <code class="notranslate" translate="no">earthMesh</code> a child of the <code class="notranslate" translate="no">sunMesh</code>. The <code class="notranslate" translate="no">sunMesh</code> has
  144. its scale set to 5x with <code class="notranslate" translate="no">sunMesh.scale.set(5, 5, 5)</code>. That means the
  145. <code class="notranslate" translate="no">sunMesh</code>s local space is 5 times as big. Anything put in that space
  146. will be multiplied by 5. That means the earth is now 5x larger and
  147. its distance from the sun (<code class="notranslate" translate="no">earthMesh.position.x = 10</code>) is also
  148. 5x as well.</p>
  149. <p> Our scene graph currently looks like this</p>
  150. <p><img src="../resources/images/scenegraph-sun-earth.svg" align="center"></p>
  151. <p>To fix it let's add an empty scene graph node. We'll parent both the sun and the earth
  152. to that node.</p>
  153. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">+const solarSystem = new THREE.Object3D();
  154. +scene.add(solarSystem);
  155. +objects.push(solarSystem);
  156. const sunMaterial = new THREE.MeshPhongMaterial({emissive: 0xFFFF00});
  157. const sunMesh = new THREE.Mesh(sphereGeometry, sunMaterial);
  158. sunMesh.scale.set(5, 5, 5);
  159. -scene.add(sunMesh);
  160. +solarSystem.add(sunMesh);
  161. objects.push(sunMesh);
  162. const earthMaterial = new THREE.MeshPhongMaterial({color: 0x2233FF, emissive: 0x112244});
  163. const earthMesh = new THREE.Mesh(sphereGeometry, earthMaterial);
  164. earthMesh.position.x = 10;
  165. -sunMesh.add(earthMesh);
  166. +solarSystem.add(earthMesh);
  167. objects.push(earthMesh);
  168. </pre>
  169. <p>Here we made an <a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a>. Like a <a href="/docs/#api/en/objects/Mesh"><code class="notranslate" translate="no">Mesh</code></a> it is also a node in the scene graph
  170. but unlike a <a href="/docs/#api/en/objects/Mesh"><code class="notranslate" translate="no">Mesh</code></a> it has no material or geometry. It just represents a local space.</p>
  171. <p>Our new scene graph looks like this</p>
  172. <p><img src="../resources/images/scenegraph-sun-earth-fixed.svg" align="center"></p>
  173. <p>Both the <code class="notranslate" translate="no">sunMesh</code> and the <code class="notranslate" translate="no">earthMesh</code> are children of the <code class="notranslate" translate="no">solarSystem</code>. All 3
  174. are being rotated and now because the <code class="notranslate" translate="no">earthMesh</code> is not a child of the <code class="notranslate" translate="no">sunMesh</code>
  175. it is no longer scaled by 5x.</p>
  176. <p></p><div translate="no" class="threejs_example_container notranslate">
  177. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun-earth-orbit-fixed.html"></iframe></div>
  178. <a class="threejs_center" href="/manual/examples/scenegraph-sun-earth-orbit-fixed.html" target="_blank">click here to open in a separate window</a>
  179. </div>
  180. <p></p>
  181. <p>Much better. The earth is smaller than the sun and it's rotating around the sun
  182. and rotating itself.</p>
  183. <p>Continuing that same pattern let's add a moon.</p>
  184. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">+const earthOrbit = new THREE.Object3D();
  185. +earthOrbit.position.x = 10;
  186. +solarSystem.add(earthOrbit);
  187. +objects.push(earthOrbit);
  188. const earthMaterial = new THREE.MeshPhongMaterial({color: 0x2233FF, emissive: 0x112244});
  189. const earthMesh = new THREE.Mesh(sphereGeometry, earthMaterial);
  190. -earthMesh.position.x = 10; // note that this offset is already set in its parent's THREE.Object3D object "earthOrbit"
  191. -solarSystem.add(earthMesh);
  192. +earthOrbit.add(earthMesh);
  193. objects.push(earthMesh);
  194. +const moonOrbit = new THREE.Object3D();
  195. +moonOrbit.position.x = 2;
  196. +earthOrbit.add(moonOrbit);
  197. +const moonMaterial = new THREE.MeshPhongMaterial({color: 0x888888, emissive: 0x222222});
  198. +const moonMesh = new THREE.Mesh(sphereGeometry, moonMaterial);
  199. +moonMesh.scale.set(.5, .5, .5);
  200. +moonOrbit.add(moonMesh);
  201. +objects.push(moonMesh);
  202. </pre>
  203. <p>Again we added more invisible scene graph nodes. The first, an <a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a> called <code class="notranslate" translate="no">earthOrbit</code>
  204. and added both the <code class="notranslate" translate="no">earthMesh</code> and the <code class="notranslate" translate="no">moonOrbit</code> to it, also new. We then added the <code class="notranslate" translate="no">moonMesh</code>
  205. to the <code class="notranslate" translate="no">moonOrbit</code>. The new scene graph looks like this.</p>
  206. <p><img src="../resources/images/scenegraph-sun-earth-moon.svg" align="center"></p>
  207. <p>and here's that</p>
  208. <p></p><div translate="no" class="threejs_example_container notranslate">
  209. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun-earth-moon.html"></iframe></div>
  210. <a class="threejs_center" href="/manual/examples/scenegraph-sun-earth-moon.html" target="_blank">click here to open in a separate window</a>
  211. </div>
  212. <p></p>
  213. <p>You can see the moon follows the spirograph pattern shown at the top
  214. of this article but we didn't have to manually compute it. We just
  215. setup our scene graph to do it for us.</p>
  216. <p>It is often useful to draw something to visualize the nodes in the scene graph.
  217. Three.js has some helpful ummmm, helpers to ummm, ... help with this.</p>
  218. <p>One is called an <a href="/docs/#api/en/helpers/AxesHelper"><code class="notranslate" translate="no">AxesHelper</code></a>. It draws 3 lines representing the local
  219. <span style="color:red">X</span>,
  220. <span style="color:green">Y</span>, and
  221. <span style="color:blue">Z</span> axes. Let's add one to every node we
  222. created.</p>
  223. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">// add an AxesHelper to each node
  224. objects.forEach((node) =&gt; {
  225. const axes = new THREE.AxesHelper();
  226. axes.material.depthTest = false;
  227. axes.renderOrder = 1;
  228. node.add(axes);
  229. });
  230. </pre>
  231. <p>On our case we want the axes to appear even though they are inside the spheres.
  232. To do this we set their material's <code class="notranslate" translate="no">depthTest</code> to false which means they will
  233. not check to see if they are drawing behind something else. We also
  234. set their <code class="notranslate" translate="no">renderOrder</code> to 1 (the default is 0) so that they get drawn after
  235. all the spheres. Otherwise a sphere might draw over them and cover them up.</p>
  236. <p></p><div translate="no" class="threejs_example_container notranslate">
  237. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun-earth-moon-axes.html"></iframe></div>
  238. <a class="threejs_center" href="/manual/examples/scenegraph-sun-earth-moon-axes.html" target="_blank">click here to open in a separate window</a>
  239. </div>
  240. <p></p>
  241. <p>We can see the
  242. <span style="color:red">x (red)</span> and
  243. <span style="color:blue">z (blue)</span> axes. Since we are looking
  244. straight down and each of our objects is only rotating around its
  245. y axis we don't see much of the <span style="color:green">y (green)</span> axes.</p>
  246. <p>It might be hard to see some of them as there are 2 pairs of overlapping axes. Both the <code class="notranslate" translate="no">sunMesh</code>
  247. and the <code class="notranslate" translate="no">solarSystem</code> are at the same position. Similarly the <code class="notranslate" translate="no">earthMesh</code> and
  248. <code class="notranslate" translate="no">earthOrbit</code> are at the same position. Let's add some simple controls to allow us
  249. to turn them on/off for each node.
  250. While we're at it let's also add another helper called the <a href="/docs/#api/en/helpers/GridHelper"><code class="notranslate" translate="no">GridHelper</code></a>. It
  251. makes a 2D grid on the X,Z plane. By default the grid is 10x10 units.</p>
  252. <p>We're also going to use <a href="https://github.com/georgealways/lil-gui">lil-gui</a> which is
  253. a UI library that is very popular with three.js projects. lil-gui takes an
  254. object and a property name on that object and based on the type of the property
  255. automatically makes a UI to manipulate that property.</p>
  256. <p>We want to make both a <a href="/docs/#api/en/helpers/GridHelper"><code class="notranslate" translate="no">GridHelper</code></a> and an <a href="/docs/#api/en/helpers/AxesHelper"><code class="notranslate" translate="no">AxesHelper</code></a> for each node. We need
  257. a label for each node so we'll get rid of the old loop and switch to calling
  258. some function to add the helpers for each node</p>
  259. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">-// add an AxesHelper to each node
  260. -objects.forEach((node) =&gt; {
  261. - const axes = new THREE.AxesHelper();
  262. - axes.material.depthTest = false;
  263. - axes.renderOrder = 1;
  264. - node.add(axes);
  265. -});
  266. +function makeAxisGrid(node, label, units) {
  267. + const helper = new AxisGridHelper(node, units);
  268. + gui.add(helper, 'visible').name(label);
  269. +}
  270. +
  271. +makeAxisGrid(solarSystem, 'solarSystem', 25);
  272. +makeAxisGrid(sunMesh, 'sunMesh');
  273. +makeAxisGrid(earthOrbit, 'earthOrbit');
  274. +makeAxisGrid(earthMesh, 'earthMesh');
  275. +makeAxisGrid(moonOrbit, 'moonOrbit');
  276. +makeAxisGrid(moonMesh, 'moonMesh');
  277. </pre>
  278. <p><code class="notranslate" translate="no">makeAxisGrid</code> makes an <code class="notranslate" translate="no">AxisGridHelper</code> which is a class we'll create
  279. to make lil-gui happy. Like it says above lil-gui
  280. will automagically make a UI that manipulates the named property
  281. of some object. It will create a different UI depending on the type
  282. of property. We want it to create a checkbox so we need to specify
  283. a <code class="notranslate" translate="no">bool</code> property. But, we want both the axes and the grid
  284. to appear/disappear based on a single property so we'll make a class
  285. that has a getter and setter for a property. That way we can let lil-gui
  286. think it's manipulating a single property but internally we can set
  287. the visible property of both the <a href="/docs/#api/en/helpers/AxesHelper"><code class="notranslate" translate="no">AxesHelper</code></a> and <a href="/docs/#api/en/helpers/GridHelper"><code class="notranslate" translate="no">GridHelper</code></a> for a node.</p>
  288. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">// Turns both axes and grid visible on/off
  289. // lil-gui requires a property that returns a bool
  290. // to decide to make a checkbox so we make a setter
  291. // and getter for `visible` which we can tell lil-gui
  292. // to look at.
  293. class AxisGridHelper {
  294. constructor(node, units = 10) {
  295. const axes = new THREE.AxesHelper();
  296. axes.material.depthTest = false;
  297. axes.renderOrder = 2; // after the grid
  298. node.add(axes);
  299. const grid = new THREE.GridHelper(units, units);
  300. grid.material.depthTest = false;
  301. grid.renderOrder = 1;
  302. node.add(grid);
  303. this.grid = grid;
  304. this.axes = axes;
  305. this.visible = false;
  306. }
  307. get visible() {
  308. return this._visible;
  309. }
  310. set visible(v) {
  311. this._visible = v;
  312. this.grid.visible = v;
  313. this.axes.visible = v;
  314. }
  315. }
  316. </pre>
  317. <p>One thing to notice is we set the <code class="notranslate" translate="no">renderOrder</code> of the <a href="/docs/#api/en/helpers/AxesHelper"><code class="notranslate" translate="no">AxesHelper</code></a>
  318. to 2 and for the <a href="/docs/#api/en/helpers/GridHelper"><code class="notranslate" translate="no">GridHelper</code></a> to 1 so that the axes get drawn after the grid.
  319. Otherwise the grid might overwrite the axes.</p>
  320. <p></p><div translate="no" class="threejs_example_container notranslate">
  321. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-sun-earth-moon-axes-grids.html"></iframe></div>
  322. <a class="threejs_center" href="/manual/examples/scenegraph-sun-earth-moon-axes-grids.html" target="_blank">click here to open in a separate window</a>
  323. </div>
  324. <p></p>
  325. <p>Turn on the <code class="notranslate" translate="no">solarSystem</code> and you'll see how the earth is exactly 10
  326. units out from the center just like we set above. You can see how the
  327. earth is in the <em>local space</em> of the <code class="notranslate" translate="no">solarSystem</code>. Similarly if you
  328. turn on the <code class="notranslate" translate="no">earthOrbit</code> you'll see how the moon is exactly 2 units
  329. from the center of the <em>local space</em> of the <code class="notranslate" translate="no">earthOrbit</code>.</p>
  330. <p>A few more examples of scene graphs. An automobile in a simple game world might have a scene graph like this</p>
  331. <p><img src="../resources/images/scenegraph-car.svg" align="center"></p>
  332. <p>If you move the car's body all the wheels will move with it. If you wanted the body
  333. to bounce separate from the wheels you might parent the body and the wheels to a "frame" node
  334. that represents the car's frame.</p>
  335. <p>Another example is a human in a game world.</p>
  336. <p><img src="../resources/images/scenegraph-human.svg" align="center"></p>
  337. <p>You can see the scene graph gets pretty complex for a human. In fact
  338. that scene graph above is simplified. For example you might extend it
  339. to cover every finger (at least another 28 nodes) and every toe
  340. (yet another 28 nodes) plus ones for the face and jaw, the eyes and maybe more.</p>
  341. <p>Let's make one semi-complex scene graph. We'll make a tank. The tank will have
  342. 6 wheels and a turret. The tank will follow a path. There will be a sphere that
  343. moves around and the tank will target the sphere.</p>
  344. <p>Here's the scene graph. The meshes are colored in green, the <a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a>s in blue,
  345. the lights in gold, and the cameras in purple. One camera has not been added
  346. to the scene graph.</p>
  347. <div class="threejs_center"><img src="../resources/images/scenegraph-tank.svg" style="width: 800px;"></div>
  348. <p>Look in the code to see the setup of all of these nodes.</p>
  349. <p>For the target, the thing the tank is aiming at, there is a <code class="notranslate" translate="no">targetOrbit</code>
  350. (<a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a>) which just rotates similar to the <code class="notranslate" translate="no">earthOrbit</code> above. A
  351. <code class="notranslate" translate="no">targetElevation</code> (<a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a>) which is a child of the <code class="notranslate" translate="no">targetOrbit</code> provides an
  352. offset from the <code class="notranslate" translate="no">targetOrbit</code> and a base elevation. Childed to that is another
  353. <a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a> called <code class="notranslate" translate="no">targetBob</code> which just bobs up and down relative to the
  354. <code class="notranslate" translate="no">targetElevation</code>. Finally there's the <code class="notranslate" translate="no">targetMesh</code> which is just a cube we
  355. rotate and change its colors</p>
  356. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">// move target
  357. targetOrbit.rotation.y = time * .27;
  358. targetBob.position.y = Math.sin(time * 2) * 4;
  359. targetMesh.rotation.x = time * 7;
  360. targetMesh.rotation.y = time * 13;
  361. targetMaterial.emissive.setHSL(time * 10 % 1, 1, .25);
  362. targetMaterial.color.setHSL(time * 10 % 1, 1, .25);
  363. </pre>
  364. <p>For the tank there's an <a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a> called <code class="notranslate" translate="no">tank</code> which is used to move everything
  365. below it around. The code uses a <a href="/docs/#api/en/extras/curves/SplineCurve"><code class="notranslate" translate="no">SplineCurve</code></a> which it can ask for positions
  366. along that curve. 0.0 is the start of the curve. 1.0 is the end of the curve. It
  367. asks for the current position where it puts the tank. It then asks for a
  368. position slightly further down the curve and uses that to point the tank in that
  369. direction using <a href="/docs/#api/en/core/Object3D.lookAt"><code class="notranslate" translate="no">Object3D.lookAt</code></a>.</p>
  370. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">const tankPosition = new THREE.Vector2();
  371. const tankTarget = new THREE.Vector2();
  372. ...
  373. // move tank
  374. const tankTime = time * .05;
  375. curve.getPointAt(tankTime % 1, tankPosition);
  376. curve.getPointAt((tankTime + 0.01) % 1, tankTarget);
  377. tank.position.set(tankPosition.x, 0, tankPosition.y);
  378. tank.lookAt(tankTarget.x, 0, tankTarget.y);
  379. </pre>
  380. <p>The turret on top of the tank is moved automatically by being a child
  381. of the tank. To point it at the target we just ask for the target's world position
  382. and then again use <a href="/docs/#api/en/core/Object3D.lookAt"><code class="notranslate" translate="no">Object3D.lookAt</code></a></p>
  383. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">const targetPosition = new THREE.Vector3();
  384. ...
  385. // face turret at target
  386. targetMesh.getWorldPosition(targetPosition);
  387. turretPivot.lookAt(targetPosition);
  388. </pre>
  389. <p>There's a <code class="notranslate" translate="no">turretCamera</code> which is a child of the <code class="notranslate" translate="no">turretMesh</code> so
  390. it will move up and down and rotate with the turret. We make that
  391. aim at the target.</p>
  392. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">// make the turretCamera look at target
  393. turretCamera.lookAt(targetPosition);
  394. </pre>
  395. <p>There is also a <code class="notranslate" translate="no">targetCameraPivot</code> which is a child of <code class="notranslate" translate="no">targetBob</code> so it floats
  396. around with the target. We aim that back at the tank. Its purpose is to allow the
  397. <code class="notranslate" translate="no">targetCamera</code> to be offset from the target itself. If we instead made the camera
  398. a child of <code class="notranslate" translate="no">targetBob</code> and just aimed the camera itself it would be inside the
  399. target.</p>
  400. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">// make the targetCameraPivot look at the tank
  401. tank.getWorldPosition(targetPosition);
  402. targetCameraPivot.lookAt(targetPosition);
  403. </pre>
  404. <p>Finally we rotate all the wheels</p>
  405. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">wheelMeshes.forEach((obj) =&gt; {
  406. obj.rotation.x = time * 3;
  407. });
  408. </pre>
  409. <p>For the cameras we setup an array of all 4 cameras at init time with descriptions.</p>
  410. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">const cameras = [
  411. { cam: camera, desc: 'detached camera', },
  412. { cam: turretCamera, desc: 'on turret looking at target', },
  413. { cam: targetCamera, desc: 'near target looking at tank', },
  414. { cam: tankCamera, desc: 'above back of tank', },
  415. ];
  416. const infoElem = document.querySelector('#info');
  417. </pre>
  418. <p>and cycle through our cameras at render time.</p>
  419. <pre class="prettyprint showlinemods notranslate lang-js" translate="no">const camera = cameras[time * .25 % cameras.length | 0];
  420. infoElem.textContent = camera.desc;
  421. </pre>
  422. <p></p><div translate="no" class="threejs_example_container notranslate">
  423. <div><iframe class="threejs_example notranslate" translate="no" style=" " src="/manual/examples/resources/editor.html?url=/manual/examples/scenegraph-tank.html"></iframe></div>
  424. <a class="threejs_center" href="/manual/examples/scenegraph-tank.html" target="_blank">click here to open in a separate window</a>
  425. </div>
  426. <p></p>
  427. <p>I hope this gives some idea of how scene graphs work and how you might use them.
  428. Making <a href="/docs/#api/en/core/Object3D"><code class="notranslate" translate="no">Object3D</code></a> nodes and parenting things to them is an important step to using
  429. a 3D engine like three.js well. Often it might seem like some complex math is necessary
  430. to make something move and rotate the way you want. For example without a scene graph
  431. computing the motion of the moon or where to put the wheels of the car relative to its
  432. body would be very complicated but using a scene graph it becomes much easier.</p>
  433. <p><a href="materials.html">Next up we'll go over materials</a>.</p>
  434. </div>
  435. </div>
  436. </div>
  437. <script src="/manual/resources/prettify.js"></script>
  438. <script src="/manual/resources/lesson.js"></script>
  439. </body></html>