README.md

Note

This is one of 199 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

• About
  • 3D tests
• Status
• Installation
• Dependencies
• API
• Authors
• License

About

2D/3D shape intersection checks. This is a support package for @thi.ng/geom.

Type	Circle	Line	Poly	Ray	Rect	Tri
Circle	✓
Line		✓
Point	✓	✓	✓		✓	✓
Ray	✓	✓	✓		✓
Rect	✓				✓

3D tests

Type	AABB	Plane	Point	Ray	Sphere
AABB	✓				✓
Plane		✓
Point	✓				✓
Ray	✓	✓			✓
Sphere					✓

Current implementations partially based on toxiclibs (Java) and Clojure version of thi.ng/geom.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/geom-isec

ESM import:

import * as isec from "@thi.ng/geom-isec";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/geom-isec"></script>

JSDelivr documentation

For Node.js REPL:

const isec = await import("@thi.ng/geom-isec");

Package sizes (brotli'd, pre-treeshake): ESM: 3.26 KB

Dependencies

• @thi.ng/api
• @thi.ng/geom-closest-point
• @thi.ng/math
• @thi.ng/vectors

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

API

Generated API docs

import * as isec from "@thi.ng/geom-isec";

const res = isec.intersectLineLine([0, 0], [100, 50], [50, 100], [50, -100]);
// { type: 4, isec: [ 50, 25 ], alpha: 0.5, beta: 0.375, det: -20000 }

res.type === isec.IntersectionType.INTERSECT
// true

Authors

• Karsten Schmidt

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

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

License

© 2013 - 2024 Karsten Schmidt // Apache License 2.0