You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP

@mathigon/euclid

Package Overview
Dependencies
2
Maintainers
0
Versions
46
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

# @mathigon/euclid

Euclidean geometry classes and tools for JavaScript

Version published
Maintainers
0
Created

## Euclid.ts

Euclid.ts is a Typescript library for 2D geometry. It contains classes for elements like points, lines, circles, and polygons, intersection detection, as well as SVG and Canvas drawing tools. It was developed for Mathigon.org, an award-winning mathematics education project.

### API

All class instances are immutable: you need to create new copies rather than modifying their properties. This is mainly to facilitate fast change detection on downstream libraries.

• Points: `Point(x: number, y: number)`

• Lines: `Line(p1: Point, p2: Point)`, `Segment(p1: Point, p2: Point)`, `Ray(p1: Point, p2: Point)`

• Polygons: `Polygon(...points: Point[])`, `Polyline(...points: Point[])`

• Rectangles: `Rectangle(p: Point, w: number, h: number)`

• Circles: `Circle(c: Point, r: number)`

• Ellipses: `Ellipse(c: Point, a: number, b: number)`

• Arcs: `Arc((c: Point, start: Point, angle: number))`, `Sector((c: Point, start: Point, angle: number))`

• Angle: `Angle(a: Point, b: Point, c: Point)`

• Bounds: `Bounds(xMin: number, xMax: number, yMin: number, yMax: number)`

• Intersections: `intsersection(...obj: GeoShape[])`

• Drawing: `drawSVG(obj: GeoElement, options: SVGDrawingOptions)`, `drawCanvas(ctx: CanvasRenderingContext2D, obj: GeoElement, options: CanvasDrawingOptions)`

### Usage

First, install Euclid.ts from NPM using

`npm install @mathigon/euclid`

Now, simply import all functions and classes you need, using

``````import {Point, Line} from '@mathigon/euclid'
``````

### Contributing

We welcome community contributions: please file any bugs you find or send us pull requests with improvements. You can find out more on Mathigon.io.

Before submitting a pull request, you will need to sign the Mathigon Individual Contributor License Agreement.

## Keywords

FAQs

Package last updated on 23 Jun 2024

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.

## Related posts

Product

• Integrations
• Docs
• Pricing
• FAQ
• Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

• Terms
• Privacy
• Security

Made with ⚡️ by Socket Inc