Layers.html 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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 bit mask and accessor method used to control an [page:Object3D]'s visibility.
  14. A [page:Layers] object assigns an [page:Object3D] to 0 or more of 32 layers numbered 0 to 31.
  15. </div>
  16. <h2>Constructor</h2>
  17. <h3>[name]()</h3>
  18. <div>
  19. Create a new Layers object, with an initial mask set to layer 1.
  20. </div>
  21. <h2>Properties</h2>
  22. <h3>[property:Integer mask]</h3>
  23. <div>
  24. Internal layer mask.
  25. </div>
  26. <h2>Methods</h2>
  27. <h3>[method:null set]( [page:Integer layer] )</h3>
  28. <div>
  29. layer - an integer from 0 to 31.
  30. </div>
  31. <div>
  32. Set the layer mask to the value *layer*.
  33. </div>
  34. <h3>[method:null enable]( [page:Integer layer] )</h3>
  35. <div>
  36. layer - an integer from 0 to 31.
  37. </div>
  38. <div>
  39. Add *layer* to the mask.
  40. </div>
  41. <h3>[method:null disable]( [page:Integer layer] )</h3>
  42. <div>
  43. layer - an integer from 0 to 31.
  44. </div>
  45. <div>
  46. Remove *layer* from the mask.
  47. </div>
  48. <h3>[method:null toggle]( [page:Integer layer] )</h3>
  49. <div>
  50. layer - an integer from 0 to 31.
  51. </div>
  52. <div>
  53. Toggle the *layer* value in the mask.
  54. </div>
  55. <h3>[method:Boolean test]( [page:Integer layers] )</h3>
  56. <div>
  57. layers - a 32bit bit mask of layer numbers.
  58. </div>
  59. <div>
  60. Returns true if *layers* and .mask have any bits set in common.
  61. </div>
  62. <h2>Source</h2>
  63. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  64. </body>
  65. </html>