# dubins-js

> This is a JS port of [previous work](#where-did-the-code-come-from) on generating Dubins sets + paths.

Latest version **0.0.7** (published 2022-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install dubins-js
pnpm add dubins-js
yarn add dubins-js
bun add dubins-js
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2022-03-01 |
| First published | 2022-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 30 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | aierie |

## Links

- npm: https://www.npmjs.com/package/dubins-js
- npm.io page: https://npm.io/package/dubins-js

## Recent versions

- 0.0.7 (latest) — 2022-03-01
- 0.0.6 — 2022-02-28
- 0.0.5 — 2022-02-27
- 0.0.4 — 2022-02-27
- 0.0.3 — 2022-02-20
- 0.0.2 — 2022-02-20
- 0.0.1 — 2022-02-20

## README

# What is this?
This is a JS port of [previous work](#where-did-the-code-come-from) on generating Dubins sets + paths.

# Install
```
npm i dubins-js
```

Supports CJS and ESM.

# Why?
I (the author) want to draw a fish, on HTML Canvas, using Javascript, that can move in an aestheticically pleasing and organic-looking way.

# Where did the code come from?
The Python version: https://github.com/fgabbert/dubins_py, by [@fgabbert](https://github.com/fgabbert)
The paper: https://cpb-us-e2.wpmucdn.com/faculty.sites.uci.edu/dist/e/700/files/2014/04/Dubins_Set_Robotics_2001.pdf

# This is WIP
There should still be significant changes to come for this package, particularly:
- [x] Restructure so that midpoints (and segments) are easily accessible
- [x] Better (exported) types
- [x] Easy API to lazily get a point from a Dubins path
      - [x] add pointAt
- [x] Angles should only use radians and use the x axis as a base, as normal unit circles do
- [x] Renaming of functions and other variables to follow JS convention
- [x] Add pointAt, pointAtLength, on segments
- [ ] Initial documentation
- [ ] Mathematical reasoning, granular unit tests
- [ ] Utility functions to render on canvas + svg (separate module, optional import?)
- [ ] Generalize DubinsPath so that segments can be tacked on
- [ ] increased floating point precision? this would be good for visual precision + asserting on results
- [ ] Tests to ensure correctness as per paper

# How does this work?
Coming soon!

---
_Source: https://npm.io/package/dubins-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._