# @vaalentin/geo-plane

> Plane geometry, extracted from three.js

Latest version **1.0.1** (published 2016-01-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vaalentin/geo-plane
pnpm add @vaalentin/geo-plane
yarn add @vaalentin/geo-plane
bun add @vaalentin/geo-plane
```

## 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.0.1 |
| Published | 2016-01-19 |
| First published | 2016-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | vaalentin |
| Maintainers | vaalentin |
| Keywords | WebGL |

## Links

- npm: https://www.npmjs.com/package/@vaalentin/geo-plane
- Repository: https://github.com/vaalentin/geo-plane
- Homepage: https://github.com/vaalentin/geo-plane#readme
- Issues: https://github.com/vaalentin/geo-plane/issues
- npm.io page: https://npm.io/package/@vaalentin/geo-plane

## Recent versions

- 1.0.1 (latest) — 2016-01-19
- 1.0.0 — 2016-01-09

## README

# @vaalentin/geo-plane

Plane geometry, extracted from three.js

## Installation

```
$ npm install --save @vaalentin/geo-plane
```

## Usage

```js
import getPlaneGeometry from '@vaalentin/geo-plane';

const { verts, uvs, faces } = getPlaneGeometry(1, 1, 2, 2);

// create buffers
```

## API

#### `geo = getPlaneGeometry(w, h, dx, dy)`

Returns a new geometry with:
- `verts` is an float32 array of coordinates (by group of 3).
- `uvs` is an float32 array of uvs (by group of 2).
- `faces` is an uint16/32 array of the faces.

and where:
- `w` is the width of the plane (default is 1).
- `h` is the height of the plane (default is 1).
- `dx` is the number of divisions on the width (default is 1).
- `dy` is the number of divisions on the height (default is 1).

## License

MIT, see [LICENSE.md](https://github.com/vaalentin/geo-plane/blob/master/LICENSE.md) for more details.

## Credits

Thanks to [three.js](http://threejs.org/) for the code.

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