2
0

Layers.html 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>[name]</h1>
  12. <div class="desc">
  13. An object providing a [link:https://en.wikipedia.org/wiki/Mask_(computing) bit mask] and accessor methods
  14. used to control an [page:Object3D]'s visibility.
  15. A [page:Layers] object assigns an [page:Object3D] to 0 or more of 32 layers numbered 0 to 31.<br /><br />
  16. This is used to control visibility - an object must share a layer with a [page:Camera camera]
  17. to be visible when that camera's view is renderered.<br /><br />
  18. All classes that inherit from [page:Object3D] have a [property:layers] property which is an instance
  19. of this class.
  20. </div>
  21. <h2>Constructor</h2>
  22. <h3>[name]()</h3>
  23. <div>
  24. Create a new Layers object, with an initial mask set to layer 1.
  25. </div>
  26. <h2>Properties</h2>
  27. <h3>[property:Integer mask]</h3>
  28. <div>
  29. Internal layer mask.
  30. </div>
  31. <h2>Methods</h2>
  32. <h3>[method:null disable]( [page:Integer layer] )</h3>
  33. <div>
  34. layer - an integer from 0 to 31.<br /><br />
  35. Remove *layer* from the mask.
  36. </div>
  37. <h3>[method:null enable]( [page:Integer layer] )</h3>
  38. <div>
  39. layer - an integer from 0 to 31.<br /><br />
  40. Add *layer* to the mask.
  41. </div>
  42. <h3>[method:null set]( [page:Integer layer] )</h3>
  43. <div>
  44. layer - an integer from 0 to 31.<br /><br />
  45. Set the layer mask to the value *layer*.
  46. </div>
  47. <h3>[method:Boolean test]( [page:Integer layers] )</h3>
  48. <div>
  49. layers - a 32bit bit mask of layer numbers.<br /><br />
  50. Returns true if *layers* and [page:.mask] have any bits set in common.
  51. </div>
  52. <h3>[method:null toggle]( [page:Integer layer] )</h3>
  53. <div>
  54. layer - an integer from 0 to 31.<br /><br />
  55. Toggle the *layer* value in the mask.
  56. </div>
  57. <h2>Source</h2>
  58. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  59. </body>
  60. </html>