The cat-rom-spline from actionnick

cat-rom-spline's Introduction

Catmull Rom spline interpolation made easy.

Install

$ npm install --save cat-rom-spline

Usage

var catRomSpline = require('cat-rom-spline');

// Points are arrays in the form of [x, y]
var p0 = [0, 0];
var p1 = [5, 5];
var p2 = [5, 10];
var p3 = [15, 20];

// At least 4 points are needed to interpolate
var points = [p0, p1, p2, p3];

// There are optional configurations that you can make but they aren't required
// If 'samples' is not passed in the interpolation will sample a sensible amount
// of points based on how far away control points are
var options = {
  samples: 50,
  knot: 0.5 // Default is 0.5, Ranges from 0 - 1, 1 being stiffer curves.
};

var interpolatedPoints = catRomSpline(points, options);

License

MIT © Nick Schaubeck

cat-rom-spline's People

Contributors

Stargazers

Watchers

cat-rom-spline's Issues

would you be open to a more memory friendly API refactor?

I'd like to use this module in one of my simulation loops but unfortunately it creates a lot of gc pressure because every invocation generates new array objects.

I'd like to have an API where a fixed array of points is passed in, which will significantly reduce the allocated memory on each invocation.
Open for suggestions, but I'm thinking something like this:

const out = new Array(100)  // hold up to 100 vec2s

for (let i=0; i < 100; i++)
    out[i] = [ 0, 0 ]

// returns the number of points that were generated in the spline.
// out is filled in with those values from 0...pointCount
const pointCount = catRomSpline(points, options, out)