d536a7364f0a352a51c330f2af9781200e5e6a8ada2da31be5adbb189f22d9c363ba8d9f5d3b6fa98af09458d95cb7e9d5fd940ac29a860c84b8b4d978beca 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. [ENGLISH](./README_EN.md)
  2. <h1 align="center">Bezier Curve Extension</h1>
  3. <p align="center">
  4. <a href="https://travis-ci.com/jiaming743/bezierCurve"><img src="https://img.shields.io/travis/com/jiaming743/bezierCurve.svg" alt="Travis CI"></a>
  5. <a href="https://github.com/jiaming743/BezierCurve/blob/master/LICENSE"><img src="https://img.shields.io/github/license/jiaming743/bezierCurve.svg" alt="LICENSE" /> </a>
  6. <a href="https://www.npmjs.com/package/@jiaminghi/bezier-curve"><img src="https://img.shields.io/npm/v/@jiaminghi/bezier-curve.svg" alt="LICENSE" /> </a>
  7. </p>
  8. ### 这是一个提供如下几个方法的三次贝塞尔曲线插件。
  9. - **[bezierCurveToPolyline](#bezierCurveToPolyline)**
  10. 将贝塞尔曲线抽象成由N个**均匀分布**的点构成的折线
  11. - **[getBezierCurveLength](#getBezierCurveLength)**
  12. 获取贝塞尔曲线的长度
  13. - **[polylineToBezierCurve](#polylineToBezierCurve)**
  14. 将由N个点构成的折线抽象成光滑的贝塞尔曲线
  15. ### npm安装
  16. ```shell
  17. $ npm install @jiaminghi/bezier-curve
  18. ```
  19. ### 使用
  20. ```javascript
  21. import bezierCurve from '@jiaminghi/bezier-curve'
  22. // do something
  23. ```
  24. ### 快速体验
  25. ```html
  26. <!--资源位于个人服务器仅供体验和测试,请勿在生产环境使用-->
  27. <!--调试版-->
  28. <script src="http://lib.jiaminghi.com/bezierCurve/bezierCurve.map.js"></script>
  29. <!--压缩版-->
  30. <script src="http://lib.jiaminghi.com/bezierCurve/bezierCurve.min.js"></script>
  31. <script>
  32. const { bezierCurveToPolyline, getBezierCurveLength, polylineToBezierCurve } = window.bezierCurve
  33. // do something
  34. </script>
  35. ```
  36. ------
  37. <h3 align="center">示例</h3>
  38. #### bezierCurve
  39. ```javascript
  40. // 贝塞尔曲线数据结构
  41. const bezierCurve = [
  42. // 起始点
  43. [20, 20],
  44. // 多段贝塞尔曲线
  45. [
  46. // 控制点1,控制点2,结束点
  47. [100, 20],[100, 80],[180,80]
  48. ],
  49. // 下一段贝塞尔曲线的起始点是上一段的结束点
  50. // [...],[...]
  51. ]
  52. ```
  53. <p align="center">
  54. <img width="200px" src="./exampleImgs/bezierCurve.png" />
  55. </p>
  56. <p align="center"><i>bezierCurve</i> in <b>SVG</b></p>
  57. #### bezierCurveToPolyline
  58. ```javascript
  59. /**
  60. * @description 通过贝塞尔曲线获取折线
  61. * @param {Array} bezierCurve 贝塞尔曲线数据
  62. * @param {Number} precision 计算精度 建议5-10 默认为5
  63. * @return {Array|Boolean} 构成折线的点集 (无效输入将返回false)
  64. */
  65. function bezierCurveToPolyline (bezierCurve, precision = 5) {
  66. // ...
  67. }
  68. const precision = 5
  69. const polyline = bezierCurveToPolyline(bezierCurve, precision)
  70. // polyline = [
  71. // [[20,20],
  72. // [25.998752507628243,20.11632023466343],[31.698106846035834,20.457189096242345],
  73. // [37.11424670004552,21.010468821119716],[42.263355754480024,21.764021645678454],
  74. // ...]
  75. ```
  76. <p align="center">
  77. <img width="200px" src="./exampleImgs/bezierCurveToPolyline.png" />
  78. </p>
  79. <p align="center"><i>polyline</i> in <b>SVG</b></p>
  80. #### Notice
  81. - *bezierCurveToPolyline*的计算结果是由N个点构成的折线,N取决于设置的精度。
  82. - 理想情况下,计算结果中相邻的两个点的距离等于设置的精度(单位px)。
  83. - 建议精度5-10。
  84. - 如果设置的精度过小或过大(小于1或大于10),可能导致计算异常。
  85. - 设置的精度并不是每次都能达到。
  86. #### getBezierCurveLength
  87. ```js
  88. /**
  89. * @description 获取贝塞尔曲线长度
  90. * @param {Array} bezierCurve 贝塞尔曲线数据
  91. * @param {Number} precision 计算精度 建议5-10 默认为5
  92. * @return {Number|Boolean} 贝塞尔曲线长度 (无效输入将返回false)
  93. */
  94. export function getBezierCurveLength (bezierCurve, precision = 5) {
  95. // ...
  96. }
  97. // 通常情况下,默认精度已经能够达到较好的视觉效果。
  98. const length = bezierCurveToPolyline(bezierCurve)
  99. ```
  100. #### polyline
  101. ```javascript
  102. // 折线数据结构
  103. const polyline = [
  104. [20, 70],
  105. [50, 30],
  106. [100, 70],
  107. [150, 30],
  108. [180, 70]
  109. ]
  110. ```
  111. <p align="center">
  112. <img width="200px" src="./exampleImgs/polyline.png" />
  113. </p>
  114. <p align="center"><i>polyline</i> in <b>SVG</b></p>
  115. #### polylineToBezierCurve
  116. ```javascript
  117. /**
  118. * @description 将由N个点构成的折线抽象为光滑的贝塞尔曲线
  119. * @param {Array} polyline 由N个点构成的折线数据
  120. * @param {Boolean} close 是否闭合
  121. * @param {Number} offsetA 光滑程度
  122. * @param {Number} offsetB 光滑程度
  123. * @return {Array|Boolean} 贝塞尔曲线数据 (无效输入将返回false)
  124. */
  125. function polylineToBezierCurve (polyline, close = false, offsetA = 0.25, offsetB = 0.25) {
  126. // ...
  127. }
  128. const bezierCurve = polylineToBezierCurve(polyline)
  129. // bezierCurve = [
  130. // [
  131. // [20,70],
  132. // [[27.5,60],[30,30],[50,30]],
  133. // [[70,30],[75,70],[100,70]],
  134. // [[125,70],[130,30],[150,30]],
  135. // [[170,30],[172.5,60],[180,70]]]
  136. //]
  137. const closedBezierCurve = polylineToBezierCurve(polyline, true)
  138. // closedBezerCurve = [
  139. // [20,70],
  140. // [[-12.5,60],[30,30],[50,30]],
  141. // [[70,30],[75,70],[100,70]],
  142. // [[125,70],[130,30],[150,30]],
  143. // [[170,30],[212.5,60],[180,70]],
  144. // [[147.5,80],[52.5,80],[20,70]]
  145. // ]
  146. ```
  147. <p align="center">
  148. <img width="200px" src="./exampleImgs/polylineToBezierCurve.png" />
  149. </p>
  150. <p align="center"><i>bezierCurve</i> in <b>SVG</b></p>
  151. <p align="center">
  152. <img width="200px" src="./exampleImgs/polylineToClosedBezierCurve.png" />
  153. </p>
  154. <p align="center"><i>closedBezierCurve</i> in <b>SVG</b></p>