JSPM – @thi.ng/geom-clip-line@2.1.36

Package Exports

@thi.ng/geom-clip-line
@thi.ng/geom-clip-line/clip-poly
@thi.ng/geom-clip-line/liang-barsky

Readme

npm downloads

This project is part of the @thi.ng/umbrella monorepo.

About
Status
Related packages
Installation
Dependencies
API
Authors
License

About

2D line clipping (Liang-Barsky). This is a support package for @thi.ng/geom.

Current implementation is based on toxiclibs (Java) and Clojure version thi.ng/geom-clj.

This package has been extracted from the former (now obsolete) @thi.ng/geom-clip package.

Status

STABLE - used in production

Search or submit any issues for this package

@thi.ng/geom-clip-poly - 2D polygon clipping / offsetting (Sutherland-Hodgeman, Grainer-Hormann)

Installation

yarn add @thi.ng/geom-clip-line

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/geom-clip-line"></script>

Skypack documentation

For Node.js REPL:

# with flag only for < v16
node --experimental-repl-await

> const geomClipLine = await import("@thi.ng/geom-clip-line");

Package sizes (gzipped, pre-treeshake): ESM: 549 bytes

Dependencies

API

Generated API docs

liangBarsky2
liangBarksy2Raw

import { liangBarsky2 } from "@thi.ng/geom-clip-line";

liangBarsky2(
    // line end points
    [-10, -20], [30, 400],
    // min/max clip rect
    [0, 0], [100, 200]
)
// [ [ 0, 85 ], [ 10.952380952380953, 200 ], 0.25, 0.5238095238095238 ]

// returns undefined if line is completely outside the clip rect
liangBarsky2(
    // line end points
    [-10, -20], [-30, 400],
    // min/max bbox
    [0, 0], [100, 200]
)
// undefined

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-geom-clip-line,
  title = "@thi.ng/geom-clip-line",
  author = "Karsten Schmidt",
  note = "https://thi.ng/geom-clip-line",
  year = 2013
}

@thi.ng/geom-clip-line