Curve.html 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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. An abstract base class for creating a [name] object that contains methods for interpolation.
  14. For an array of [name]s see [page:CurvePath].
  15. </p>
  16. <h2>Constructor</h2>
  17. <h3>[name]()</h3>
  18. <p>
  19. This constructor creates a new [name].
  20. </p>
  21. <h2>Properties</h2>
  22. <h3>[property:Integer arcLengthDivisions]</h3>
  23. <p>This value determines the amount of divisions when calculating the cumulative segment lengths of a curve via [page:.getLengths].
  24. To ensure precision when using methods like [page:.getSpacedPoints], it is recommended to increase [page:.arcLengthDivisions] if the curve is very large. Default is 200.</p>
  25. <h2>Methods</h2>
  26. <h3>[method:Vector getPoint]( [param:Float t], [param:Vector optionalTarget] )</h3>
  27. <p>
  28. [page:Float t] - A position on the curve. Must be in the range [ 0, 1 ]. <br>
  29. [page:Vector optionalTarget] — (optional) If specified, the result will be copied into this Vector,
  30. otherwise a new Vector will be created. <br /><br />
  31. Returns a vector for a given position on the curve.
  32. </p>
  33. <h3>[method:Vector getPointAt]( [param:Float u], [param:Vector optionalTarget] )</h3>
  34. <p>
  35. [page:Float u] - A position on the curve according to the arc length. Must be in the range [ 0, 1 ]. <br>
  36. [page:Vector optionalTarget] — (optional) If specified, the result will be copied into this Vector,
  37. otherwise a new Vector will be created. <br /><br />
  38. Returns a vector for a given position on the curve according to the arc length.
  39. </p>
  40. <h3>[method:Array getPoints]( [param:Integer divisions] )</h3>
  41. <p>
  42. divisions -- number of pieces to divide the curve into. Default is *5*.<br /><br />
  43. Returns a set of divisions + 1 points using getPoint( t ).
  44. </p>
  45. <h3>[method:Array getSpacedPoints]( [param:Integer divisions] )</h3>
  46. <p>
  47. divisions -- number of pieces to divide the curve into. Default is *5*.<br /><br />
  48. Returns a set of divisions + 1 equi-spaced points using getPointAt( u ).
  49. </p>
  50. <h3>[method:Float getLength]()</h3>
  51. <p>Get total curve arc length.</p>
  52. <h3>[method:Array getLengths]( [param:Integer divisions] )</h3>
  53. <p>Get list of cumulative segment lengths.</p>
  54. <h3>[method:null updateArcLengths]()</h3>
  55. <p>Update the cumlative segment distance cache.</p>
  56. <h3>[method:Float getUtoTmapping]( [param:Float u], [param:Float distance] )</h3>
  57. <p>
  58. Given u in the range ( 0 .. 1 ), returns [page:Float t] also in the range ( 0 .. 1 ).
  59. u and t can then be used to give you points which are equidistant from the ends of the curve,
  60. using [page:.getPoint].
  61. </p>
  62. <h3>[method:Vector getTangent]( [param:Float t] )</h3>
  63. <p>
  64. Returns a unit vector tangent at t. If the derived curve does not implement its
  65. tangent derivation, two points a small delta apart will be used to find its gradient
  66. which seems to give a reasonable approximation.
  67. </p>
  68. <h3>[method:Vector getTangentAt]( [param:Float u] )</h3>
  69. <p>
  70. Returns tangent at a point which is equidistant to the ends of the curve from the
  71. point given in [page:.getTangent].
  72. </p>
  73. <h3>[method:Object computeFrenetFrames]( [param:Integer segments], [param:Boolean closed] )</h3>
  74. <p>
  75. Generates the Frenet Frames. Used in geometries like [page:TubeGeometry] or [page:ExtrudeGeometry].
  76. </p>
  77. <h3>[method:Curve clone]()</h3>
  78. <p>Creates a clone of this instance.</p>
  79. <h3>[method:Curve copy]( [param:Curve source] )</h3>
  80. <p>Copies another [name] object to this instance.</p>
  81. <h3>[method:Object toJSON]()</h3>
  82. <p>Returns a JSON object representation of this instance.</p>
  83. <h3>[method:Curve fromJSON]( [param:Object json] )</h3>
  84. <p>Copies the data from the given JSON object to this instance.</p>
  85. <h2>Source</h2>
  86. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  87. </body>
  88. </html>