2
0

Layers.html 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. <h1>[name]</h1>
  11. <p class="desc">
  12. A [page:Layers] object assigns an [page:Object3D] to 1 or more of 32 layers numbered `0` to `31`
  13. - internally the layers are stored as a [link:https://en.wikipedia.org/wiki/Mask_(computing) bit mask], and by default all
  14. Object3Ds are a member of layer 0.<br /><br />
  15. 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
  16. view is rendered.<br /><br />
  17. All classes that inherit from [page:Object3D] have an [page:Object3D.layers] property which is an instance of this class.
  18. </p>
  19. <h2>Examples</h2>
  20. <p>
  21. [example:webgl_layers WebGL / layers]
  22. </p>
  23. <h2>Constructor</h2>
  24. <h3>[name]()</h3>
  25. <p>
  26. Create a new Layers object, with membership initially set to layer 0.
  27. </p>
  28. <h2>Properties</h2>
  29. <h3>[property:Integer mask]</h3>
  30. <p>
  31. A bit mask storing which of the 32 layers this layers object is currently a member of.
  32. </p>
  33. <h2>Methods</h2>
  34. <h3>[method:undefined disable]( [param:Integer layer] )</h3>
  35. <p>
  36. layer - an integer from 0 to 31.<br /><br />
  37. Remove membership of this `layer`.
  38. </p>
  39. <h3>[method:undefined enable]( [param:Integer layer] )</h3>
  40. <p>
  41. layer - an integer from 0 to 31.<br /><br />
  42. Add membership of this `layer`.
  43. </p>
  44. <h3>[method:undefined set]( [param:Integer layer] )</h3>
  45. <p>
  46. layer - an integer from 0 to 31.<br /><br />
  47. Set membership to `layer`, and remove membership all other layers.
  48. </p>
  49. <h3>[method:Boolean test]( [param:Layers layers] )</h3>
  50. <p>
  51. layers - a Layers object<br /><br />
  52. Returns true if this and the passed `layers` object have at least one layer in common.
  53. </p>
  54. <h3>[method:Boolean isEnabled]( [param:Integer layer] )</h3>
  55. <p>
  56. layer - an integer from 0 to 31.<br /><br />
  57. Returns true if the given layer is enabled.
  58. </p>
  59. <h3>[method:undefined toggle]( [param:Integer layer] )</h3>
  60. <p>
  61. layer - an integer from 0 to 31.<br /><br />
  62. Toggle membership of `layer`.
  63. </p>
  64. <h3>[method:undefined enableAll]()</h3>
  65. <p>
  66. Add membership to all layers.
  67. </p>
  68. <h3>[method:undefined disableAll]()</h3>
  69. <p>
  70. Remove membership from all layers.
  71. </p>
  72. <h2>Source</h2>
  73. <p>
  74. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  75. </p>
  76. </body>
  77. </html>