Giter VIP home page Giter VIP logo

straight-skeleton's Introduction

straight-skeleton

This is a TypeScript library that wraps the basic functionality of CGAL's straight skeleton implementation using Wasm (WebAssembly). You can use this library to generate unweighted straight skeletons of polygons with or without holes.

If you are interested in a less robust but more fast straight skeleton implementation that's written in pure TypeScript, check out v1 of this library.

Demo

Live playground

Installation

npm i straight-skeleton

Usage

This library supports both arrays of points (SkeletonBuilder.buildFromPolygon) and GeoJSON polygons (SkeletonBuilder.buildFromGeoJSON).

Input requirements

  • Input polygon must have at least one ring.
  • The first ring is always the outer ring, and the rest are inner rings.
  • Outer rings must be counter-clockwise oriented and inner rings must be clockwise oriented.
  • All rings must be weakly simple.
  • Each ring must have a duplicate of the first vertex at the end.

Example

import {SkeletonBuilder} from 'straight-skeleton';

// Contains two rings: outer and inner.
const polygon = [
	[
		[-1, -1],
		[0, -12],
		[1, -1],
		[12, 0],
		[1, 1],
		[0, 12],
		[-1, 1],
		[-12, 0],
		[-1, -1]
	], [
		[-1, 0],
		[0, 1],
		[1, 0],
		[0, -1],
		[-1, 0]
	]
];

// Initialize the Wasm module by calling init() once.
SkeletonBuilder.init().then(() => {
	const result = SkeletonBuilder.buildFromPolygon(polygon);
	
	// Check if the skeleton was successfully constructed
	if (result !== null) {
		for (const vertex of result.vertices) {
			// Do something with vertices
		}

		for (const polygon of result.polygons) {
			// Do something with polygons
		}
	}
});

Development

  1. Clone this repository.
  2. Run npm i to install dependencies.
  3. Optionally, rebuild the Wasm module:
    1. Install Emscripten and make sure that it's in your PATH.
    2. cd src/core, then sh ./install_libraries.sh to download and unpack all dependencies.
    3. mkdir build && cd build to create a build directory.
    4. emcmake cmake .. to generate the build files.
    5. emmake make to build the Wasm module. Rerun this whenever your .cpp files change.
  4. Run npm run build to build the library or npm run dev to start a development server that watches for changes.

References

straight-skeleton's People

Contributors

strandedkitty avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.