This repository contains basic classes to perform Geometry operations in 2 dimensions.
It is not an optimized repository, but rather aims at containing most operations necessary to assist with layouting logic.
It can be used by anyone that want to add simple geometry operations to a typescript
or javascript
project.
There are many other geometry repositories already, why create another one? Because I couldn't find any repository that contained the operations on polygons that I needed to perform layouting when visualizing graphs.
Transformation
class. This uses matrices to transform coordinates. For full information, please refer to the API documentation to see available classes and their functions.
The library assumes a coordinate system where positive x
goes to the right, and positive y
goes upwards. Most often one doesn't need to consider this, but for example with rotation or the cross product of vectors this is good to know.
npx
https://github.com/npm/npx. This allows invoking of the other global npm requirements in the repository (Typescript, Jest) without having to install them.You can install the package using. NOTE: The github name and the npm install names are different.
npm i -S ts-2d-geometry
All main classes are exported from index.js
Contributions, if they are in line with expanding functionality that can help with layout logic are welcome. Requirements for pull requests are:
Generated using TypeDoc