geom-center-and-normalize 1.0.3 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+# [2.0.0](https://github.com/vorg/geom-center-and-normalize/compare/v1.0.2...v2.0.0) (2023-02-02)
+
+
+### Features
+
+* add support for typed array geometries and update positions in place ([97ebbf1](https://github.com/vorg/geom-center-and-normalize/commit/97ebbf1422239f1455061d1edb145a289e0eb712))
+
+
+### BREAKING CHANGES
+
+* use ESM

package/README.md

@@ -1,36 +1,46 @@
 # geom-center-and-normalize
 
-Centers the geometry and scales it to fill 1x1x1 bounding box
+Center a simplicial complex geometry's positions and scale them to fill 1x1x1 bounding box.
 
-## Usage
+## Installation
 
 ```bash
-npm install geom-center-and-normalize --save
+npm install geom-center-and-normalize
 ```
 
-#### `normalizedPositions = centerAndNormalize(positions)`
+## Usage
 
-Parameters:
-`positions` - list of [x, y, z]
+```js
+import centerAndNormalize from "geom-center-and-normalize";
+
+const positions = new Float32Array([
+  // p1 [x, y, z]
+  1, 1, 1,
+  // p2 [x, y, z]
+  2, 2, 2,
+  // p3 [x, y, z]
+  3, 5, 3,
+]);
+const normalizedPositions = centerAndNormalize(positions);
+// => Float32Array(9) [
+//   -0.25, -0.5, -0.25,
+//   0, -0.25, 0,
+//   0.25, 0.5, 0.25,
+// ]
+```
 
-Returns:
-List of positions [x, y, z] centered at [0, 0, 0] and normalized to bounding box [-0.5, -0.5, -0.5] x [0.5, 0.5, 0.5]
+## API
 
-## Example
+#### `centerAndNormalize(positions): positions`
 
-```javascript
-var centerAndNormalize = require('geom-center-and-normalize')
+**Parameters**
 
-var positions = [[1, 1, 1], [2, 2, 2], [3, 5, 3]]
-var normalizedPositions = centerAndNormalize(positions)
+- positions: `TypedArray|Array` – simplicial complex geometry positions (eg. `new Float32Array([x, y, z, x, y, z, ...])` or `new Array([x, y, z], [x, y, z], ...)`)
 
-// normalizedPositions = [
-//   [ -0.25, -0.5, -0.25 ],
-//   [ 0, -0.25, 0 ],
-//   [ 0.25, 0.5, 0.25 ]
-// ]
-```
+**Returns**
+
+- positions: `TypedArray|Array` – The positions parameter array updated, centered at `[0, 0, 0]` and normalized to a unit bounding box `[-0.5, -0.5, -0.5] x [0.5, 0.5, 0.5]`.
 
 ## License
 
-MIT, see [LICENSE.md](http://github.com/vorg/geom-center-and-scale/blob/master/LICENSE.md) for details.
+MIT. See [license file](https://github.com/vorg/geom-center-and-normalize/blob/master/LICENSE.md).

package/index.js

@@ -1,20 +1,29 @@
-var aabb = require('pex-geom/aabb')
-var vec3 = require('pex-math/vec3')
+import { avec3, vec3 } from "pex-math";
+import { aabb } from "pex-geom";
 
-function centerAndNormalize (positions) {
-  var result = aabb.fromPoints(positions)
-  var center = aabb.center(result)
-  var size = aabb.size(result)
-  var scale = Math.max(size[0], Math.max(size[1], size[2]))
+function centerAndNormalize(positions) {
+  const isTypedArray = !Array.isArray(positions);
+  const stride = isTypedArray ? 3 : 1;
 
-  var newPositions = []
-  for (var i = 0; i < positions.length; i++) {
-    var p = vec3.copy(positions[i])
-    vec3.sub(p, center)
-    vec3.scale(p, 1 / scale)
-    newPositions.push(p)
+  const bbox = aabb.create();
+  aabb.fromPoints(bbox, positions);
+  const center = aabb.center(bbox);
+  const size = aabb.size(bbox);
+  const scale = 1 / Math.max(...size);
+
+  for (let i = 0; i < positions.length / stride; i++) {
+    if (isTypedArray) {
+      avec3.sub(positions, i, center, 0);
+      avec3.scale(positions, i, scale);
+    } else {
+      const p = vec3.copy(positions[i]);
+      vec3.sub(p, center);
+      vec3.scale(p, scale);
+      positions[i] = p;
+    }
   }
-  return newPositions
+
+  return positions;
 }
 
-module.exports = centerAndNormalize
+export default centerAndNormalize;

package/package.json

@@ -1,36 +1,41 @@
 {
   "name": "geom-center-and-normalize",
-  "version": "1.0.3",
-  "description": "Centers the geometry and scales it to fill 1x1x1 bounding box",
-  "main": "index.js",
-  "license": "MIT",
-  "author": {
-    "name": "Marcin Ignac",
-    "email": "marcin.ignac@gmail.com",
-    "url": "https://github.com/vorg"
-  },
-  "dependencies": {
-    "clone": "^1.0.2",
-    "pex-geom": "^2.0.2",
-    "pex-math": "^2.1.1"
-  },
-  "devDependencies": {},
-  "scripts": {
-    "test": "node test.js"
-  },
+  "version": "2.0.0",
+  "description": "Center a simplicial complex geometry's positions and scale them to fill 1x1x1 bounding box.",
   "keywords": [
     "geom",
+    "center",
+    "normalize",
     "simplicial",
     "complex",
     "3d",
+    "pex",
+    "geometry",
     "webgl"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/vorg/geom-center-and-normalize.git"
-  },
   "homepage": "https://github.com/vorg/geom-center-and-normalize",
-  "bugs": {
-    "url": "https://github.com/vorg/geom-center-and-normalize/issues"
+  "bugs": "https://github.com/vorg/geom-center-and-normalize/issues",
+  "repository": "vorg/geom-center-and-normalize",
+  "license": "MIT",
+  "author": "Marcin Ignac <marcin.ignac@gmail.com> (https://github.com/vorg)",
+  "contributors": [
+    "Damien Seguin (https://github.com/dmnsgn)"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "exports": "./index.js",
+  "main": "index.js",
+  "scripts": {
+    "release": "snowdev release",
+    "test": "node --test",
+    "test:watch": "node --test --watch test"
+  },
+  "dependencies": {
+    "pex-geom": "^3.0.0-alpha.3",
+    "pex-math": "^4.0.0-alpha.3"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=8.0.0"
   }
 }

package/types/index.d.ts

@@ -0,0 +1,2 @@
+export default centerAndNormalize;
+declare function centerAndNormalize(positions: any): any;