InterleavedBufferAttribute.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  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. </p>
  13. <h2>Constructor</h2>
  14. <h3>[name]( [param:InterleavedBuffer interleavedBuffer], [param:Integer itemSize], [param:Integer offset], [param:Boolean normalized] )</h3>
  15. <p>
  16. </p>
  17. <h2>Properties</h2>
  18. <h3>[property:InterleavedBuffer data]</h3>
  19. <p>
  20. The [page:InterleavedBuffer InterleavedBuffer] instance passed in the constructor.
  21. </p>
  22. <h3>[property:TypedArray array]</h3>
  23. <p>
  24. The value of [page:InterleavedBufferAttribute.data data].array.
  25. </p>
  26. <h3>[property:Integer count]</h3>
  27. <p>
  28. The value of [page:InterleavedBufferAttribute.data data].count.
  29. If the buffer is storing a 3-component item (such as a position, normal, or color),
  30. then this will count the number of such items stored.
  31. </p>
  32. <h3>[property:Integer itemSize]</h3>
  33. <p>
  34. How many values make up each item.
  35. </p>
  36. <h3>[property:String name]</h3>
  37. <p>
  38. Optional name for this attribute instance. Default is an empty string.
  39. </p>
  40. <h3>[property:Boolean needsUpdate]</h3>
  41. <p>
  42. Default is *false*. Setting this to *true* will send the entire interleaved buffer (not just the specific attribute data) to the GPU again.
  43. </p>
  44. <h3>[property:Boolean normalized]</h3>
  45. <p>
  46. Default is *false*.
  47. </p>
  48. <h3>[property:Integer offset]</h3>
  49. <p>
  50. The offset in the underlying array buffer where an item starts.
  51. </p>
  52. <h2>Methods</h2>
  53. <h3>[method:this applyMatrix4]( [param:Matrix4 m] )</h3>
  54. <p>Applies matrix [page:Matrix4 m] to every Vector3 element of this InterleavedBufferAttribute.</p>
  55. <h3>[method:this applyNormalMatrix]( [param:Matrix3 m] )</h3>
  56. <p>Applies normal matrix [page:Matrix3 m] to every Vector3 element of this InterleavedBufferAttribute.</p>
  57. <h3>[method:this transformDirection]( [param:Matrix4 m] )</h3>
  58. <p>Applies matrix [page:Matrix4 m] to every Vector3 element of this InterleavedBufferAttribute, interpreting the elements as a direction vectors.</p>
  59. <h3>[method:Number getX]( [param:Integer index] ) </h3>
  60. <p>Returns the x component of the item at the given index.</p>
  61. <h3>[method:Number getY]( [param:Integer index] ) </h3>
  62. <p>Returns the y component of the item at the given index.</p>
  63. <h3>[method:Number getZ]( [param:Integer index] ) </h3>
  64. <p>Returns the z component of the item at the given index.</p>
  65. <h3>[method:Number getW]( [param:Integer index] ) </h3>
  66. <p>Returns the w component of the item at the given index.</p>
  67. <h3>[method:null setX]( [param:Integer index], [param:Float x] ) </h3>
  68. <p>Sets the x component of the item at the given index.</p>
  69. <h3>[method:null setY]( [param:Integer index], [param:Float y] ) </h3>
  70. <p>Sets the y component of the item at the given index.</p>
  71. <h3>[method:null setZ]( [param:Integer index], [param:Float z] ) </h3>
  72. <p>Sets the z component of the item at the given index.</p>
  73. <h3>[method:null setW]( [param:Integer index], [param:Float w] ) </h3>
  74. <p>Sets the w component of the item at the given index.</p>
  75. <h3>[method:null setXY]( [param:Integer index], [param:Float x], [param:Float y] ) </h3>
  76. <p>Sets the x and y components of the item at the given index.</p>
  77. <h3>[method:null setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] ) </h3>
  78. <p>Sets the x, y and z components of the item at the given index.</p>
  79. <h3>[method:null setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] ) </h3>
  80. <p>Sets the x, y, z and w components of the item at the given index.</p>
  81. <h2>Source</h2>
  82. <p>
  83. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  84. </p>
  85. </body>
  86. </html>