Add mouseSpeed property to PointerLockControls (mrdoob#23516)

* Add `mouseSpeed` property to `PointerLockControls` `mouseSpeed` controls the mouse sensitivity for `PointerLockControls`. This change also adds a new optional `options` parameter to the constructor of `PointerLockControls`. * Update PointerLockControls.js * Update PointerLockControls.js * Rename `mouseSpeed` to `pointerSpeed` * Add `pointerSpeed` property documentation Co-authored-by: mrdoob <info@mrdoob.com>
donmccurdy · Mar 10, 2022 · b4064cf · b4064cf
1 parent 92c18d4
commit b4064cf
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/docs/examples/en/controls/PointerLockControls.html b/docs/examples/en/controls/PointerLockControls.html
@@ -96,6 +96,11 @@ <h3>[property:Float minPolarAngle]</h3>
 			Camera pitch, lower limit. Range is 0 to Math.PI radians. Default is 0.
 		</p>
 
+		<h3>[property:Float pointerSpeed]</h3>
+		<p>
+			Multiplier for how much the pointer movement influences the camera rotation. Default is 1.
+		</p>
+
 		<h2>Methods</h2>
 
 		<p>See the base [page:EventDispatcher] class for common methods.</p>

diff --git a/examples/js/controls/PointerLockControls.js b/examples/js/controls/PointerLockControls.js
@@ -37,6 +37,8 @@
 
 			this.maxPolarAngle = Math.PI; // radians
 
+			this.pointerSpeed = 1.0;
+
 			const scope = this;
 
 			function onMouseMove( event ) {
@@ -47,8 +49,8 @@
 
 				_euler.setFromQuaternion( camera.quaternion );
 
-				_euler.y -= movementX * 0.002;
-				_euler.x -= movementY * 0.002;
+				_euler.y -= movementX * 0.002 * scope.pointerSpeed;
+				_euler.x -= movementY * 0.002 * scope.pointerSpeed;
 				_euler.x = Math.max( _PI_2 - scope.maxPolarAngle, Math.min( _PI_2 - scope.minPolarAngle, _euler.x ) );
 				camera.quaternion.setFromEuler( _euler );
 				scope.dispatchEvent( _changeEvent );

diff --git a/examples/jsm/controls/PointerLockControls.js b/examples/jsm/controls/PointerLockControls.js
@@ -34,6 +34,8 @@ class PointerLockControls extends EventDispatcher {
 		this.minPolarAngle = 0; // radians
 		this.maxPolarAngle = Math.PI; // radians
 
+		this.pointerSpeed = 1.0;
+
 		const scope = this;
 
 		function onMouseMove( event ) {
@@ -45,8 +47,8 @@ class PointerLockControls extends EventDispatcher {
 
 			_euler.setFromQuaternion( camera.quaternion );
 
-			_euler.y -= movementX * 0.002;
-			_euler.x -= movementY * 0.002;
+			_euler.y -= movementX * 0.002 * scope.pointerSpeed;
+			_euler.x -= movementY * 0.002 * scope.pointerSpeed;
 
 			_euler.x = Math.max( _PI_2 - scope.maxPolarAngle, Math.min( _PI_2 - scope.minPolarAngle, _euler.x ) );