Layers.html 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. <p 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. </p>
  20. <h2>Examples</h2>
  21. <p>
  22. [example:webgl_layers WebGL / layers]
  23. </p>
  24. <h2>Constructor</h2>
  25. <h3>[name]()</h3>
  26. <p>
  27. Create a new Layers object, with membership initially set to layer 0.
  28. </p>
  29. <h2>Properties</h2>
  30. <h3>[property:Integer mask]</h3>
  31. <p>
  32. A bit mask storing which of the 32 layers this layers object is currently a member of.
  33. </p>
  34. <h2>Methods</h2>
  35. <h3>[method:null disable]( [param:Integer layer] )</h3>
  36. <p>
  37. layer - an integer from 0 to 31.<br /><br />
  38. Remove membership of this *layer*.
  39. </p>
  40. <h3>[method:null enable]( [param:Integer layer] )</h3>
  41. <p>
  42. layer - an integer from 0 to 31.<br /><br />
  43. Add membership of this *layer*.
  44. </p>
  45. <h3>[method:null set]( [param:Integer layer] )</h3>
  46. <p>
  47. layer - an integer from 0 to 31.<br /><br />
  48. Set membership to *layer*, and remove membership all other layers.
  49. </p>
  50. <h3>[method:Boolean test]( [param:Layers layers] )</h3>
  51. <p>
  52. layers - a Layers object<br /><br />
  53. Returns true if this and the passed *layers* object are members of the same set of layers.
  54. </p>
  55. <h3>[method:null toggle]( [param:Integer layer] )</h3>
  56. <p>
  57. layer - an integer from 0 to 31.<br /><br />
  58. Toggle membership of *layer*.
  59. </p>
  60. <h2>Source</h2>
  61. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  62. </body>
  63. </html>