https://github.com/mondeja/polf
Calculate points on lines.
https://github.com/mondeja/polf
Last synced: 6 months ago
JSON representation
Calculate points on lines.
- Host: GitHub
- URL: https://github.com/mondeja/polf
- Owner: mondeja
- License: bsd-3-clause
- Created: 2020-07-23T20:10:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T05:13:14.000Z (over 1 year ago)
- Last Synced: 2025-04-15T22:56:58.683Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 762 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📦 polf
[![NPM version][npm-version-image]][npm-link]
[![License][license-image]][license-link]
[![NodeJS versions][npm-versions-image]][npm-link]
Find point coordinates inside line functions between a range `t` from 0 to 1.
## Status
[![Tests][tests-image]][tests-link]
[![Coverage status][coverage-image]][coverage-link]
## Installation
```
npm install polf
```
## Quickstart
```javascript
> const { lineXY } = require("polf");
> lineXY([0, 0], [10, 10], .5)
[ 5, 5 ]
```
## Documentation
### Point on line functions [â–¼](https://github.com/mondeja/polf#point-on-line-functions)
- [lineXY](https://github.com/mondeja/polf/blob/master/README.md#lineXY)
- [cubicBezierXY](https://github.com/mondeja/polf/blob/master/README.md#cubicBezierXY)
- [quadraticBezierXY](https://github.com/mondeja/polf/blob/master/README.md#quadraticBezierXY)
- [ellipticalArcXY](https://github.com/mondeja/polf/blob/master/README.md#ellipticalArcXY)
### Utility functions [â–¼](https://github.com/mondeja/polf#utility-functions)
- [angleBetween](https://github.com/mondeja/polf/blob/master/README.md#angleBetween)
### Point on line functions
# lineXY(p0, p1, t) ⇒ `array`
Computes the coordinate of a point in a line parametrized in the range `t` from 0 to 1.
> Algorithm: `B(t) = p0 + (p1 - p0) * t , 0 <= t <= 1`
- **p0** (array) Start point coordinate.
- **p1** (array) End point coordinate.
- **t** (number) Number in the range from 0 to 1 that parametrizes the location on the line.
# cubicBezierXY(p0, p1, p2, p3, t) ⇒ `array`
Computes the coordinate of a point in a cubic Bézier curve parametrized in the range `t` from 0 to 1.
> Algorithm: `B(t) = (1-t)^3 * p0 + 3*(1-t)^2 * t * p1 + 3*(1-t)^2 * p2 + t^3 * p3 , 0 <= t <= 1`
- **p0** (array) Start point coordinate.
- **p1** (array) First control point coordinate.
- **p2** (array) Second control point coordinate.
- **p3** (array) End point coordinate.
- **t** (number) Number in the range from 0 to 1 that parametrizes the location on the curve.
# quadraticBezierXY(p0, p1, p2, t) ⇒ `array`
Computes the coordinate of a point in a quadratic Bézier curve parametrized in the range `t` from 0 to 1.
> Algorithm: `B(t) = (1-t) * 2 * p0 + 2*(1-t)*t * p1 + t2 * p2 , 0 <= t <= 1`
- **p0** (array) Start point coordinate.
- **p1** (array) Coordinate of the control point.
- **p2** (array) End point coordinate.
- **t** (number) Number in the range from 0 to 1 that parametrizes the location on the curve.
# ellipticalArcXY(p0, rx, ry, xAxisRotation, largeArc, sweep, p1, t) ⇒ `array`
Computes the coordinate of a point in a elliptical arc parametrized in the range `t` from 0 to 1.
- **p0** (array) Start point coordinate.
- **rx** (number) X radius of the arc.
- **ry** (number) Y radius of the arc.
- **xAxisRotation** (number) Rotation in X of the arc in degrees.
- **largeArc** (boolean) `large-arc` flag that specifies how the arc is drawn.
- **sweep** (boolean) `sweep` flag that specifies how the arc is drawn.
- **p1** (array) End point coordinate.
- **t** (number) Number in the range from 0 to 1 that parametrizes the location on the arc.
### Utility functions
# angleBetween(v0, v1) ⇒ `number`
Computes the angle between two vectors.
- **v0** (array) First vector in comparison.
- **v1** (array) Second vector in comparison.
[npm-link]: https://www.npmjs.com/package/polf
[npm-version-image]: https://img.shields.io/npm/v/polf
[tests-image]: https://img.shields.io/github/workflow/status/mondeja/polf/Test
[tests-link]: https://github.com/mondeja/polf/actions?query=workflow%3ATest
[coverage-image]: https://coveralls.io/repos/github/mondeja/polf/badge.svg?branch=master
[coverage-link]: https://coveralls.io/github/mondeja/polf?branch=master
[license-image]: https://img.shields.io/npm/l/polf?color=brightgreen
[license-link]: https://github.com/mondeja/polf/blob/master/LICENSE
[npm-versions-image]: https://img.shields.io/node/v/polf