Socket
Socket
Sign inDemoInstall

circle2-lowdeps

Package Overview
Dependencies
1
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    circle2-lowdeps

fork of circle2 with only `intersectCircle()` and `containsPoint()` method and less dependencies


Version published
Weekly downloads
4
increased by300%
Maintainers
1
Install size
169 kB
Created
Weekly downloads
 

Readme

Source

circle2-lowdeps

all credits go to tmpvar and his circle2 implementation

install

npm install circle2-lowdeps

use

new Circle([origin [, radius])

Where origin adheres to the following form:

  • [0, 1]
  • { x: 0, y: 1}
  • new Vec2(0, 1)

and radius is a number

Note: the arguments to the Circle function are optional. If none are passed circle.position will be 0, 0 and circle.radius will be 1

containsPoint(point)

Where point looks like one of the following:

  • [0, 1]
  • { x: 0, y: 1 }
  • new Vec2(0, 1)

This function will return true if the passed point is inside or right on the boundary of the circle.

var Circle = require('circle2');

var c = Circle()

console.log(c.contains([10, 0])) // false

c.radius(10);

console.log(c.contains([10, 0])); // true

intersectCircle(circle)

Performs an intersection between this circle and the incoming. Results are as follows:

  • false - no intersection or one circle is contained in the other
  • [] - same circles
  • [Vec2] - single intersection
  • [Vec2, Vec2] - two intersection points

toSegments([segments])

Convert this circle into a series of points representing the outline of this circle

license

MIT (see: LICENSE)

Keywords

FAQs

Last updated on 25 Apr 2016

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc