Layers.html 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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. A [page:Layers] object assigns an [page:Object3D] to 1 or more of 32 layers numbered 0 to 31
  14. - internally the layers are stored as a [link:https://en.wikipedia.org/wiki/Mask_(computing) bit mask], and by default all
  15. Object3Ds are a member of layer 0.<br /><br />
  16. This can be used to control visibility - an object must share a layer with a [page:Camera camera] to be visible when that camera's
  17. view is renderered.<br /><br />
  18. All classes that inherit from [page:Object3D] have an [page:Object3D.layers] property which is an instance of this class.
  19. </div>
  20. <h2>Constructor</h2>
  21. <h3>[name]()</h3>
  22. <div>
  23. Create a new Layers object, with membership initially set to layer 0.
  24. </div>
  25. <h2>Properties</h2>
  26. <h3>[property:Integer mask]</h3>
  27. <div>
  28. A bit mask storing which of the 32 layers this layers object is currently a member of.
  29. </div>
  30. <h2>Methods</h2>
  31. <h3>[method:null disable]( [page:Integer layer] )</h3>
  32. <div>
  33. layer - an integer from 0 to 31.<br /><br />
  34. Remove membership of this *layer*.
  35. </div>
  36. <h3>[method:null enable]( [page:Integer layer] )</h3>
  37. <div>
  38. layer - an integer from 0 to 31.<br /><br />
  39. Add membership of this *layer*.
  40. </div>
  41. <h3>[method:null set]( [page:Integer layer] )</h3>
  42. <div>
  43. layer - an integer from 0 to 31.<br /><br />
  44. Set membership to *layer*, and remove membership all other layers.
  45. </div>
  46. <h3>[method:Boolean test]( [page:Integer layers] )</h3>
  47. <div>
  48. layers - a Layers object<br /><br />
  49. Returns true if this and the passed *layers* object are members of the same set of layers.
  50. </div>
  51. <h3>[method:null toggle]( [page:Integer layer] )</h3>
  52. <div>
  53. layer - an integer from 0 to 31.<br /><br />
  54. Toggle membership of *layer*.
  55. </div>
  56. <h2>Source</h2>
  57. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  58. </body>
  59. </html>