@thi.ng/geom
Advanced tools
[!NOTE] This is one of 192 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! ❤️
For the Clojure version, please visit: thi.ng/geom-clj
Functional, polymorphic API for 2D geometry types & SVG generation.
This project is a partially ported from the Clojure version of the same name. All polymorphic operations built on @thi.ng/defmulti.
The following shape primitives are provided. For many there're multiple ways to create them, please check linked sources and/or docs.
| Shape/Form | Description | Hiccup support |
|---|---|---|
| AABB | 3D Axis-aligned bounding box | ✅(2) |
| Arc | 2D elliptic arc | ✅ |
| Circle | 2D circle | ✅ |
| ComplexPolygon | 2D polygon w/ holes | ✅ |
| Cubic | nD cubic bezier | ✅(1) |
| Ellipse | 2D ellipse | ✅ |
| Group | group of 2D shapes | ✅ |
| Line | 2D line segment | ✅ |
| Path | 2D path (w/ optional holes/sub-paths) | ✅ |
| Path (from SVG) | 2D path from SVG | ✅ |
| Plane | 3D plane | ✅(2) |
| Point cloud | nD point cloud | ✅(1) |
| Polygon | 2D simple polygon (no holes) | ✅ |
| Polyline | 2D polyline | ✅ |
| Quad | 2D/3D quad (4-gon) | ✅(1) |
| Quadratic | nD quadratic bezier | ✅(1) |
| Ray | nD ray | ✅(1) |
| Rectangle | 2D rectangle | ✅ |
| Sphere | 3D sphere | ✅(2) |
| Text | Basic stub for text labels | ✅(3) |
| Triangle | 2D triangle | ✅ |
With very few exceptions these all are implementing the IToHiccup
interface and so
can be easily converted (via
hiccup) to a
variety of other formats, incl. conversion to SVG.
By design, for better flexibility and performance reasons, the hiccup flavor
used by this package is not compatible with that used by
thi.ng/hiccup-svg,
though the latter provides a
convertTree()
function for that purpose. This is only needed for some cases of dynamic
in-browser SVG DOM creation...
SVG conversion is included via the
asSvg() and
svgDoc() functions.
The following operations are provided (many also applicable to shape groups directly and/or perform automatic resampling/conversion if needed).
| Operation | Description |
|---|---|
applyTransforms() | applies any spatial transformation attributes |
arcLength() | compute arc length / perimeter of shape boundary |
area() | signed/unsigned surface area |
asCubic() | convert shape boundary to cubic bezier segments |
asPath() | convert shape to path |
asPolygon() | convert shape to polygon(s) |
asPolyline() | convert shape to polyline(s) |
asSvg() | serialize shape/group/hierarchy to SVG |
bounds() | compute bounding box |
center() | center shape around origin or point |
centroid() | compute shape centroid |
classifyPoint() | classify point in relation to shape boundary (in/out) |
clipConvex() | clip shape against convex boundary |
closestPoint() | compute closest point on shape boundary |
convexHull() | compute convex hull (2d only) |
edges() | extract edges |
fitIntoBounds() | rescale/reposition shapes into a destination boundary |
flip() | reverse order (vertices or direction) |
intersects() | pairwise shape intersection (various types) |
mapPoint() | transform world space point into local shape space |
offset() | shape/path offsetting |
pointAt() | compute point on shape boundary at parametric position |
pointInside() | check if point is inside shape |
proximity() | distance from point to shape boundary |
resample() | resample/convert shape |
rotate() | rotate shape |
scale() | scale shape (uniformly/non-uniformly) |
scatter() | create random points inside a shape boundary |
simplify() | simplify shape/boundary (Douglas-Peucker) |
splitArcLength() | split shapes & groups based on max. arc length |
splitAt() | split shape/boundary at parametric position |
splitNear() | split shape/boundary near world position |
subdivCurve() | recursively apply curve subdivision kernel |
tangentAt() | compute tangent at parametric position |
tessellate() | (recursively) tessellate shape |
transformVertices() | apply custom function to each vertex |
transform() | apply transformation matrix |
translate() | translate shape |
union() | compute shape union |
vertices() | extract/sample vertices from shape boundary |
volume() | compute shape volume (3D only) |
warpPoints() | transfer points between the local spaces defined by 2 shapes |
withAttribs() | shallow copy of given shape with new attribs assigned |
This package acts as a higher-level frontend for most of the following related packages (which are more low-level, lightweight and usable by themselves too):
STABLE - used in production
Search or submit any issues for this package
yarn add @thi.ng/geom
ESM import:
import * as geom from "@thi.ng/geom";
Browser ESM import:
<script type="module" src="https://esm.run/@thi.ng/geom"></script>
For Node.js REPL:
const geom = await import("@thi.ng/geom");
Package sizes (brotli'd, pre-treeshake): ESM: 14.59 KB
Several projects in this repo's /examples directory are using this package:
| Screenshot | Description | Live demo | Source |
|---|---|---|---|
 | Basic 2D boid simulation and spatial indexing neighbor lookups | Demo | Source |
 | Self-modifying, animated typographic grid with emergent complex patterns | Demo | Source |
 | Fiber-based cooperative multitasking basics | Demo | Source |
 | Shape conversions & operations using polygons with holes | Demo | Source |
 | Convex hull & shape clipping of 2D polygons | Demo | Source |
 | geom-fuzz basic shape & fill examples | Demo | Source |
 | (Re)Constructing the thi.ng logo using a 2D signed-distance field | Demo | Source |
 | SVG path to SDF, applying deformation and converting back to SVG | Demo | Source |
 | 2.5D hidden line visualization of digital elevation files (DEM) | Demo | Source |
 | Animated, recursive polygon tessellations | Demo | Source |
 | Poisson-disk shape-aware sampling, Voronoi & Minimum Spanning Tree visualization | Demo | Source |
 | Mouse gesture / stroke analysis, simplification, corner detection | Demo | Source |
 | 2D Bezier curve-guided particle system | Demo | Source |
 | Animated arcs & drawing using hiccup-canvas | Demo | Source |
 | Canvas based Immediate Mode GUI components | Demo | Source |
 | Animated sine plasma effect visualized using contour lines | Demo | Source |
 | k-means clustering visualization | Demo | Source |
 | Live coding playground for 2D geometry generation using @thi.ng/pointfree-lang | Demo | Source |
 | 2D Poisson-disc sampler with procedural gradient map | Demo | Source |
 | Polygon to cubic curve conversion & visualization | Demo | Source |
 | Animated, iterative polygon subdivisions & visualization | Demo | Source |
 | Quasi-random lattice generator | Demo | Source |
 | Minimal rdom-canvas animation | Demo | Source |
 | Animated Voronoi diagram, cubic splines & SVG download | Demo | Source |
 | 2D scenegraph & shape picking | Demo | Source |
 | 2D scenegraph & image map based geometry manipulation | Demo | Source |
 | Compute cubic spline position & tangent using Dual Numbers | Demo | Source |
 | SVG path parsing & dynamic resampling | Demo | Source |
 | 3D wireframe textmode demo | Demo | Source |
 | Multi-layer vectorization & dithering of bitmap images | Demo | Source |
TODO
If this project contributes to an academic publication, please cite it as:
@misc{thing-geom,
title = "@thi.ng/geom",
author = "Karsten Schmidt",
note = "https://thi.ng/geom",
year = 2013
}
© 2013 - 2024 Karsten Schmidt // Apache License 2.0
FAQs
Functional, polymorphic API for 2D geometry types & SVG generation
The npm package @thi.ng/geom receives a total of 671 weekly downloads. As such, @thi.ng/geom popularity was classified as not popular.
We found that @thi.ng/geom demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.