feat!: manual normalizeRotations method (#579)

* manual normalizeRotations
* updating contributing instructions for dev + corepack usage

Author: abernier

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version-file: ".nvmrc"
           cache: "npm"
       - id: main
         run: |

.node-version renamed to .nvmrc

@@ -1,6 +1,26 @@
+# INSTALL
+
 Pre-requisites:
 
-- `npm ci`
+- Install [nvm](https://github.com/nvm-sh/nvm), then:
+  ```sh
+  $ nvm install
+  $ nvm use
+  $ node -v # make sure your version satisfies package.json#engines.node
+  ```
+  nb: if you want this node version to be your default nvm's one: `nvm alias default node`
+- Install npm:
+  ```sh
+  $ corepack enable
+  $ corepack prepare --activate # it reads "packageManager"
+  $ npm -v # make sure your version satisfies package.json#engines.npm
+  ```
+
+```sh
+$ npm ci
+```
+
+# Development
 
 ```sh
 $ npm run dev

CONTRIBUTING.md

@@ -125,7 +125,7 @@
 
 function lookAt() {
 
-	return cameraControls.setLookAt(
+	return cameraControls.normalizeRotations().setLookAt(
 		THREE.MathUtils.randFloat( 0, 5 ), THREE.MathUtils.randFloat( 0, 5 ), THREE.MathUtils.randFloat( 0, 5 ),
 			0, 0, 0,
 			true,

examples/await-transitions.html

@@ -36,9 +36,9 @@
 	<br>
 	<button onclick="cameraControls.setPosition( - 5, 2, 1, true )">move to ( -5, 2, 1 )</button>
 	<button onclick="cameraControls.setTarget( 3, 0, -3, true )">look at ( 3, 0, -3 )</button>
-	<button onclick="cameraControls.setLookAt( 1, 2, 3, 1, 1, 0, true )">move to ( 1, 2, 3 ), look at ( 1, 1, 0 )</button>
+	<button onclick="cameraControls.normalizeRotations().setLookAt( 1, 2, 3, 1, 1, 0, true )">move to ( 1, 2, 3 ), look at ( 1, 1, 0 )</button>
 	<br>
-	<button onclick="cameraControls.lerpLookAt( - 2, 0, 0, 1, 1, 0, 0, 2, 5, - 1, 0, 0, Math.random(), true )">move to somewhere between ( -2, 0, 0 ) -> ( 1, 1, 0 ) and ( 0, 2, 5 ) -> ( -1, 0, 0 )</button>
+	<button onclick="cameraControls.normalizeRotations().lerpLookAt( - 2, 0, 0, 1, 1, 0, 0, 2, 5, - 1, 0, 0, Math.random(), true )">move to somewhere between ( -2, 0, 0 ) -> ( 1, 1, 0 ) and ( 0, 2, 5 ) -> ( -1, 0, 0 )</button>
 	<br>
 	<button onclick="cameraControls.reset( true )">reset</button>
 	<button onclick="cameraControls.saveState()">saveState</button>

examples/basic.html

@@ -90,7 +90,7 @@
 	const distance = cameraControls.getDistanceToFitBox( rectWidth, rectHeight, 0 );
 	const cameraPosition = _cameraPosition.copy( rectNormal ).multiplyScalar( - distance ).add( rectCenterPosition );
 
-	cameraControls.setLookAt(
+	cameraControls.normalizeRotations().setLookAt(
 		cameraPosition.x, cameraPosition.y, cameraPosition.z,
 		rectCenterPosition.x, rectCenterPosition.y, rectCenterPosition.z,
 		true,

examples/fit-to-rect.html

@@ -69,7 +69,7 @@
 const moveToStartPoint = () => {
 
 	curve.getPoint ( 0, _tmp );
-	cameraControls.setLookAt( _tmp.x, _tmp.y, _tmp.z, 0, 0, 0, true );
+	cameraControls.normalizeRotations().setLookAt( _tmp.x, _tmp.y, _tmp.z, 0, 0, 0, true );
 
 };
 
@@ -98,7 +98,7 @@
 			const lookAtY = 0;
 			const lookAtZ = 0;
 
-			cameraControls.setLookAt(
+			cameraControls.normalizeRotations().setLookAt(
 				cameraX,
 				cameraY,
 				cameraZ,

examples/path-animation.html

@@ -11,7 +11,7 @@
 	<p><a href="https://github.com/yomotsu/camera-controls">GitHub repo</a></p>
 	<button type="button" onclick="cameraControls.reset( true )">Reset</button>
 	<button type="button" onclick="cameraControls.rotateTo( THREE.MathUtils.randFloat( 0, 2 * Math.PI ), THREE.MathUtils.randFloat( 0, Math.PI ), true )">Rotate</button>
-	<button onclick="cameraControls.lerpLookAt( -2, 0, 0, 1, 1, 0, 0, 2, 5, -1, 0, 0, Math.random(), true )">Move</button>
+	<button onclick="cameraControls.normalizeRotations().lerpLookAt( -2, 0, 0, 1, 1, 0, 0, 2, 5, -1, 0, 0, Math.random(), true )">Move</button>
 	<p>These buttons will be disabled whenever a transition is occuring and then re-enabled when the transition is complete.</p>
 	<button id="restEventBtn">Enable on Rest</button><br>
 	<button id="sleepEventBtn">Enable on Sleep</button>

examples/rest-and-sleep.html

@@ -67,5 +67,10 @@
     "controls",
     "OrbitControls",
     "camera"
-  ]
+  ],
+  "packageManager": "[email protected]+sha256.c8c61ba0fa0ab3b5120efd5ba97fdaf0e0b495eef647a97c4413919eda0a878b",
+  "engines": {
+    "node": ">=20.11.0",
+    "npm": ">=10.8.2"
+  }
 }

package.json

@@ -1,7 +1,9 @@
-import pkg from './package.json' assert { type: 'json' };
 import rollupReplace from '@rollup/plugin-replace';
 import rollupTypescript from '@rollup/plugin-typescript';
 import typescript from 'typescript';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const pkg = require('./package.json');
 
 const license = `/*!
  * ${ pkg.name }