# transformatrix

> A matrix module that tracks 2D transformations with the same API as the HTML5

Latest version **1.1.1** (published 2015-05-22) · New BSD license · 0 weekly downloads

## Install

```sh
npm install transformatrix
pnpm add transformatrix
yarn add transformatrix
bun add transformatrix
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2015-05-22 |
| First published | 2015-05-22 |
| Weekly downloads | 0 |
| License | New BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Chris Aljoudi |
| Maintainers | chrismatic |
| Keywords | matrix, transform |

## Links

- npm: https://www.npmjs.com/package/transformatrix
- Repository: https://github.com/chrisaljoudi/transformatrix.js
- Issues: https://github.com/chrisaljoudi/transformatrix.js/issues
- npm.io page: https://npm.io/package/transformatrix

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2015-05-22
- 1.1.0 — 2015-05-22
- 1.0.2 — 2015-05-22

## README

# transformatrix.js [![Build Status](https://travis-ci.org/chrisaljoudi/Queue.svg?branch=master)](https://travis-ci.org/chrisaljoudi/transformatrix.js)
A lightweight, fast transformation matrix implementantion in JavaScript.

## What?

**transformatrix.js** enables you you to track the transformation matrix of a 2D plane by applying the transformation just as you would, for example, on an HTML5 `<canvas>` context.

## Installation

```javascript
npm install transformatrix
```

It's recommended you use [browserify](http://browserify.org) if you're targeting browsers, but you can also simply drop in the main `.js` file which will export `Matrix` globally.

## Usage

First, import with:

```javascript
var Matrix = require("transformatrix");
```

The module provides the following:

Syntax             | Description
-------------------|-----------------------------------------------------------------------
**`new Matrix()`** | creates and returns a new, untouched transformation Matrix
**`m.translate(x, y)`** | applies a translation to Matrix `m`
**`m.scale(scaleX, scaleY)`** | scales Matrix `m` by `scaleX`, `scaleY`
**`m.rotate(radians)`** | rotates Matrix `m` by the specified number of `radians`
**`m.inverse()`** | returns a Matrix that is the inverse of `m`
**`m.multiply(n)`** | returns a Matrix that is the product of `m` and `n`
**`m.reset()`** | resets Matrix `m` to the default, transformation-free state
**`m.transformPoint(x, y)`** | transforms the point `(x, y)` through `m`, returns `[new_x, new_y]`
**`m.transformVector(x, y)`** | transforms the vector `(x, y)` through `m`, returns `[new_x, new_y]`


**Tip:** where appropriate, the functions above return a `Matrix` instance, which means you can chain them: `m.inverse().multiply(2)`.

## Who made this?

This module was written with care and love by [Chris](https://chrismatic.io/).

## Contribution

* All contributions are welcome — thanks for helping make **transformatrix.js** better.

## License

**transformatrix.js** is released under the MIT License. [See LICENSE](LICENSE).

---
_Source: https://npm.io/package/transformatrix · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._