Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

extrude-polyline

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

extrude-polyline

triangulates a 2D polyline into a stroke

  • 1.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
33K
increased by7.84%
Maintainers
1
Weekly downloads
 
Created
Source

extrude-polyline

unstable

img

Extrudes a 2D polyline with a given line thickness and the desired join/cap types. Tries to maintain visual consistency with HTML5 2D context stroking.

var polylne = [ [25, 25], [15, 60] ]
var stroke = require('extrude-polyline')({ 
    thickness: 20, 
    cap: 'square',
    join: 'bevel',
    miterLimit: 10
})

//builds a triangulated mesh from a polyline
var mesh = stroke.build(polyline)

The returned mesh is a simplicial complex.

{
    positions: [ [x,y], [x,y] ],
    cells: [ [a,b,c], [a,b,c] ]
}

variable thickness

Currently, to achieve variable thickness you can provide a mapThickness function to the stroke instance before building. By default, it will simply return the current thickness.

//create a falloff, so the thickness tapers toward the start of the path
stroke.mapThickness = function(point, index, points) {
    return this.thickness * index/(points.length-1)
}.bind(stroke)

demo

Git clone, npm install, then npm run test

Usage

NPM

stroke = Extrusion([opt])

Creates a new path builder with the given settings:

  • thickness the line thickness
  • miterLimit the limit before miters turn into bevels; default 10
  • join the join type, can be 'miter' or 'bevel' - default 'miter'
  • cap the cap type, can be 'butt' or 'square' - defalut 'butt'
mesh = stroke.build(points)

Builds a stroke with the specified list of 2D points. Returns a simplicial complex.

Roadmap

Some features that could be useful to add at a later point. PRs welcome.

  • round corners
  • round end caps
  • use consistent winding order so we don't need to disable gl.CULLING
  • connecting start and end points
  • optimizations for flat arrays (Float32Array) ?
  • optimizations for GC (pooling, etc)
  • handling anti-aliasing
  • degenerate triangles or some other form of supporting disconnected lines
  • unify codebase with polyline-normals

License

MIT, see LICENSE.md for details.

Keywords

FAQs

Package last updated on 28 Nov 2014

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc