Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 1.92 KB

README.md

File metadata and controls

112 lines (78 loc) · 1.92 KB

kld-contours


A collection of classes to represent and manipulate various vector shapes

Installation

npm install kld-contours

Importing

The following sections indicate how you can import the code for use in various environments.

Node

import {CubicBezier2D, QuadraticBezier2D, Rectangle2D} = require("kld-contours");

ESM in Modern Browsers

import {CubicBezier2D, QuadraticBezier2D, Rectangle2D} from './node_modules/kld-contours/dist/index-esm.js';

Older Browsers

<script src="./node_modules/kld-contours/dist/index-umd.js"></script>
<script>
  var CubicBezier2D = KldContours.CubicBezier2D;
  var QuadraticBezier2D = KldContours.QuadraticBezier2D;
  var Rectangle2D = KldContours.Rectangle2D;
</script>

Bundlers

import {CubicBezier2D, QuadraticBezier2D, Rectangle2D} from "kld-contours";

API

BoundingBox2D

  • overlaps
  • isEmpty
  • toString

Circle2D

  • getBoundingBox

CubicBezier2D

  • getPointAtParameter
  • splitAtParameter
  • getBernsteinPolynomials
  • getArcLengthPolynomial
  • getParameterFromArcLength
  • getBoundingBox
  • getAlignedBoundingBox
  • getAlignedBezier
  • toPolygon2D
  • toString

Ellipse2D

  • getBoundingBox

Line2D

  • getBoundingBox
  • toPolygon2D

Polygon2D

  • getBoundingBox
  • toPolygon2D

QuadraticBezier2D

  • getPointAtParameter
  • splitAtParameter
  • getBernsteinPolynomials
  • getArcLengthPolynomial
  • getParameterFromArcLength
  • getBoundingBox
  • getAlignedBoundingBox
  • getAlignedBezier
  • toPolygon2D
  • toString

Rectangle2D

  • getBoundingBox
  • toPolygon2D

Links and Related Projects