spline.d.ts 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. export interface Point {
  2. x: number;
  3. y: number;
  4. z: number;
  5. }
  6. /**
  7. * BezierSpline
  8. * https://github.com/leszekr/bezier-spline-js
  9. *
  10. * @private
  11. * @copyright
  12. * Copyright (c) 2013 Leszek Rybicki
  13. *
  14. * Permission is hereby granted, free of charge, to any person obtaining a copy
  15. * of this software and associated documentation files (the "Software"), to deal
  16. * in the Software without restriction, including without limitation the rights
  17. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  18. * copies of the Software, and to permit persons to whom the Software is
  19. * furnished to do so, subject to the following conditions:
  20. *
  21. * The above copyright notice and this permission notice shall be included in all
  22. * copies or substantial portions of the Software.
  23. *
  24. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  27. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  29. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30. * SOFTWARE.
  31. */
  32. export default class Spline {
  33. duration: number;
  34. points: Point[];
  35. sharpness: number;
  36. centers: Point[];
  37. controls: Array<[Point, Point]>;
  38. stepLength: number;
  39. length: number;
  40. delay: number;
  41. steps: number[];
  42. constructor(options?: any);
  43. /**
  44. * Caches an array of equidistant (more or less) points on the curve.
  45. */
  46. cacheSteps(mindist: number): number[];
  47. /**
  48. * returns angle and speed in the given point in the curve
  49. */
  50. vector(t: number): {
  51. angle: number;
  52. speed: number;
  53. };
  54. /**
  55. * Gets the position of the point, given time.
  56. *
  57. * WARNING: The speed is not constant. The time it takes between control points is constant.
  58. *
  59. * For constant speed, use Spline.steps[i];
  60. */
  61. pos(time: number): Point;
  62. }