geom-center-and-normalize 1.0.3 → 2.1.1

package/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
+
+## [2.1.1](https://github.com/vorg/geom-center-and-normalize/compare/v2.1.0...v2.1.1) (2024-03-14)
+
+
+
+# [2.1.0](https://github.com/vorg/geom-center-and-normalize/compare/v2.0.0...v2.1.0) (2024-03-14)
+
+
+### Bug Fixes
+
+* handle division by 0 for aabb size 0 ([26f146c](https://github.com/vorg/geom-center-and-normalize/commit/26f146cc25b32617eb03fcf71285bc8d419550aa))
+
+
+### Features
+
+* add support for flat arrays ([300c4ad](https://github.com/vorg/geom-center-and-normalize/commit/300c4ad31f233e6b5f93816bfbb06c37b8fcf188))
+* make center and normalize options ([0a051bb](https://github.com/vorg/geom-center-and-normalize/commit/0a051bbf477f3d130bc25262f9a432b400bf255f))
+* replace normalize option with scaling as boolean/number ([fe23ff9](https://github.com/vorg/geom-center-and-normalize/commit/fe23ff9eb06cb7f135667cbaaac977c8b475b67a))
+* separate normalize and scale parameters ([56efcd3](https://github.com/vorg/geom-center-and-normalize/commit/56efcd354e6a5088d5d7474a30339262ee9fadfe))
+
+
+
+# [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,48 @@
 # geom-center-and-normalize
 
-Centers the geometry and scales it to fill 1x1x1 bounding box
+Center a simplicial complex geometry's positions in place and scale them to fill a defined bounding box.
 
-## Usage
+## Installation
 
 ```bash
-npm install geom-center-and-normalize --save
+npm install geom-center-and-normalize
+```
+
+## Usage
+
+```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,
+// ]
 ```
 
-#### `normalizedPositions = centerAndNormalize(positions)`
+## API
 
-Parameters:
-`positions` - list of [x, y, z]
+#### `centerAndNormalize(positions, [options]): positions`
 
-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]
+**Parameters**
 
-## Example
+- positions: `TypedArray | Array | Array<[x, y, z]>` – simplicial complex geometry positions (eg. `new Float32Array([x, y, z, x, y, z, ...])/new Array(x, y, z, x, y, z, ...)` or `new Array([x, y, z], [x, y, z], ...)`)
 
-```javascript
-var centerAndNormalize = require('geom-center-and-normalize')
+- options: `{ center: boolean, normalize: boolean, scale: number }` – enable/disable centering/normalizing and control normalized scaling. `center` and `normalize` defaults to `true`. Scale defaults to `1`.
 
-var positions = [[1, 1, 1], [2, 2, 2], [3, 5, 3]]
-var normalizedPositions = centerAndNormalize(positions)
+**Returns**
 
-// normalizedPositions = [
-//   [ -0.25, -0.5, -0.25 ],
-//   [ 0, -0.25, 0 ],
-//   [ 0.25, 0.5, 0.25 ]
-// ]
-```
+- positions: `TypedArray | Array | Array<[x, y, z]>` – The positions parameter array updated, centered at `[0, 0, 0]` and normalized to a bounding box of `scale` size (`[-halfScale, -halfScale, -halfScale] x [halfScale, halfScale, halfScale]`).
 
 ## 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,42 @@
-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]))
+const TEMP_VEC3 = vec3.create();
 
-  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)
+function centerAndNormalize(
+  positions,
+  { center = true, normalize = true, scale = 1 } = {},
+) {
+  const isFlatArray = !positions[0]?.length;
+  const positionsCount = positions.length / (isFlatArray ? 3 : 1);
+
+  const bbox = aabb.fromPoints(aabb.create(), positions);
+  const bboxCenter = aabb.center(bbox);
+
+  if (normalize) {
+    const size = aabb.size(bbox);
+    scale = scale / (Math.max(...size) || 1);
   }
-  return newPositions
+
+  for (let i = 0; i < positionsCount; i++) {
+    if (isFlatArray) {
+      avec3.sub(positions, i, bboxCenter, 0);
+      if (normalize) {
+        avec3.scale(positions, i, scale);
+        if (!center) avec3.add(positions, i, bboxCenter, 0);
+      }
+    } else {
+      vec3.set(TEMP_VEC3, positions[i]);
+      vec3.sub(TEMP_VEC3, bboxCenter);
+      if (normalize) {
+        vec3.scale(TEMP_VEC3, scale);
+        if (!center) vec3.add(TEMP_VEC3, bboxCenter);
+      }
+      vec3.set(positions[i], TEMP_VEC3);
+    }
+  }
+
+  return positions;
 }
 
-module.exports = centerAndNormalize
+export default centerAndNormalize;

package/package.json

@@ -1,36 +1,42 @@
 {
   "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.1.1",
+  "description": "Center a simplicial complex geometry's positions in place and scale them to fill a defined 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",
+  "types": "types/index.d.ts",
+  "scripts": {
+    "release": "snowdev release",
+    "test": "node --test",
+    "test:watch": "node --test --watch test"
+  },
+  "dependencies": {
+    "pex-geom": "^3.0.1",
+    "pex-math": "^4.1.0"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=9.6.4"
   }
 }

package/types/index.d.ts

@@ -0,0 +1,6 @@
+export default centerAndNormalize;
+declare function centerAndNormalize(positions: any, { center, normalize, scale }?: {
+    center?: boolean;
+    normalize?: boolean;
+    scale?: number;
+}): any;