swoopy

0.0.15 • Public • Published

swoopy

Draw swoopy lines from one point to another.

Installation

Web browser

In vanilla, a swoopy global is exported. You can use the latest version from unpkg.

<script src="https://unpkg.com/swoopy@0.0.15/build/swoopy.js"></script>
<script src="https://unpkg.com/swoopy@0.0.15/build/swoopy.min.js"></script>

If you'd rather host it yourself, download the latest release from the build directory.

npm

npm i swoopy -S
const swoopy = require("swoopy");

API

# swoopy.arc(a, b[, offset]) · Source

Returns an array of points representing a circular arc running between point a and point b, both of which must be passed as an array of two numbers representing the x- and y-coordinates of the points. You may pass an optional offset representing how round you want your arc to be. If an offset is not specified, it defaults to 1, which will return the points of a semicircle. An offset of 0 returns the points of a straight line segment.

const mySwoop = swoopy.arc([0, 0], [10, 0]); // Returns the points of a semicircle between <0, 0> and <10, 0>.

# swoopy.cubic(a, b[, offset]) · Source

Returns an array of points representing the cubic Bézier curve running between point a and point b, both of which must be passed as an array of two numbers representing the x- and y-coordinates of the points. You may pass an optional offset representing how far perpendicularly from the midpoint of a and b to translate the control points of the Bézier curve. If an offset is not specified, it defaults to 0.5, or half the distance between a and b.

const mySwoop = swoopy.cubic([0, 0], [10, 0], -.5); // Returns the points of a cubic Bézier curve between <0, 0> and <10, 0>, with offsets that are negative half the distance between <0, 0> and <10, 0>.

# swoopy.quad(a, b[, offset]) · Source

Returns an array of points representing the quadratic Bézier curve running between point a and point b, both of which must be passed as an array of two numbers representing the x- and y-coordinates of the points. You may pass an optional offset representing how far perpendicularly from the midpoint of a and b to translate the control point of the Bézier curve. If an offset is not specified, it defaults to 0.5, or half the distance between a and b.

const mySwoop = swoopy.quad([0, 0], [10, 0], -.5); // Returns the points of a quadratic Bézier curve between <0, 0> and <10, 0>, with an offset that is negative half the distance between <0, 0> and <10, 0>.

Package Sidebar

Install

npm i swoopy

Weekly Downloads

3

Version

0.0.15

License

MIT

Unpacked Size

28 kB

Total Files

18

Last publish

Collaborators

  • harrystevens