CurvePath.html 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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. [page:Curve] &rarr;
  12. <h1>[name]</h1>
  13. <div class="desc">
  14. An abstract base class extending [page:Curve]. A CurvePath is simply an array of connected curves,
  15. but retains the api of a curve.
  16. </div>
  17. <h2>Constructor</h2>
  18. <h3>[name]()</h3>
  19. <div>
  20. The constructor take no parameters.
  21. </div>
  22. <h2>Properties</h2>
  23. <div>See the base [page:Curve] class for common properties.</div>
  24. <h3>[property:array curves]</h3>
  25. <div>The array of [page:Curve Curves].</div>
  26. <h3>[property:boolean autoClose]</h3>
  27. <div>Whether or not to automatically close the path.</div>
  28. <h2>Methods</h2>
  29. <div>See the base [page:Curve] class for common methods.</div>
  30. <h3>[method:null add]( [page:Curve curve] )</h3>
  31. <div>Add a curve to the [page:.curves] array.</div>
  32. <h3>[method:null closePath]()</h3>
  33. <div>Adds a [page:LineCurve lineCurve] to close the path.</div>
  34. <h3>[method:Geometry createGeometry]( [page:Vector3 points] )</h3>
  35. <div>
  36. points -- An array of [page:Vector3 Vector3s]<br /><br />
  37. Creates a geometry from points
  38. </div>
  39. <h3>[method:Geometry createPointsGeometry]( [page:Integer divisions] )</h3>
  40. <div>
  41. divisions -- How many segments to create. Defaults to *12*.<br /><br />
  42. Creates a [page:Geometry] object comprised of [page:Vector3 Vector3s], for example
  43. to be used with [page:Line] or [page:Points]. Uses [page:Curve.getPoints]() for the division.
  44. </div>
  45. <h3>[method:Geometry createSpacedPointsGeometry]( [page:Integer divisions] )</h3>
  46. <div>
  47. divisions -- How many segments to create. Defaults to *12*.<br /><br />
  48. Creates a [page:Geometry] object comprised of [page:Vector3]s that are equidistant, for example
  49. to be used with [page:Line] or [page:Points]. Uses [page:Curve.getSpacedPoints]() for the division.
  50. </div>
  51. <h3>[method:Float getCurveLengths]()</h3>
  52. <div>Adds together the lengths of the curves in the [page:.curves] array.</div>
  53. <h2>Source</h2>
  54. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  55. </body>
  56. </html>