three-gamepad-controls 0.16.0 → 0.18.0

package/dist/gamepad-input.d.ts

@@ -23,6 +23,10 @@ type GamepadInputEventMap = {
     gamepad: Gamepad;
   };
 };
+/**
+ * Dead zone processing mode for two-dimensional stick reads.
+ */
+type GamepadDeadzoneMode = "axial" | "radial";
 /**
  * Configuration for {@link GamepadInput}.
  */
@@ -32,6 +36,26 @@ type GamepadInputOptions = {
    * @default 0.1
    */
   deadzone: number;
+  /**
+   * Default dead zone mode for stick reads.
+   * @default "axial"
+   */
+  deadzoneMode: GamepadDeadzoneMode;
+  /**
+   * Whether stick reads rescale values outside the dead zone by default.
+   * @default false
+   */
+  rescale: boolean;
+  /**
+   * Whether the horizontal component of stick reads is inverted by default.
+   * @default false
+   */
+  invertX: boolean;
+  /**
+   * Whether the vertical component of stick reads is inverted by default.
+   * @default false
+   */
+  invertY: boolean;
   /**
    * Browser-assigned gamepad slot to use.
    *
@@ -63,23 +87,33 @@ type GamepadStickOptions = GamepadAxisOptions & {
    * the stick magnitude.
    * @default "axial"
    */
-  deadzoneMode?: "axial" | "radial";
+  deadzoneMode?: GamepadDeadzoneMode;
   /**
    * Whether to remap values outside the dead zone to the full output range.
    * @default false
    */
   rescale?: boolean;
+  /**
+   * Whether to invert the processed component from `xAxis`.
+   * @default false
+   */
+  invertX?: boolean;
+  /**
+   * Whether to invert the processed component from `yAxis`.
+   * @default false
+   */
+  invertY?: boolean;
 };
 /**
- * Two-dimensional stick input after dead zone processing.
+ * Two-dimensional stick input after configured stick processing.
  */
 type GamepadStick = {
   /**
-   * Horizontal stick value.
+   * Processed horizontal stick value.
    */
   x: number;
   /**
-   * Vertical stick value.
+   * Processed vertical stick value.
    */
   y: number;
 };
@@ -180,7 +214,7 @@ declare class GamepadInput extends EventDispatcher<GamepadInputEventMap> {
    */
   axis(axis: number, options?: GamepadAxisOptions): number;
   /**
-   * Returns a two-axis stick after dead zone processing.
+   * Returns a two-axis stick after dead zone, rescale, and inversion processing.
    *
    * @param xAxis - Horizontal axis index.
    * @param yAxis - Vertical axis index.
@@ -211,4 +245,4 @@ declare class GamepadInput extends EventDispatcher<GamepadInputEventMap> {
   resetVibration(): Promise<GamepadHapticsResult | null>;
 }
 //#endregion
-export { GamepadAxisOptions, GamepadInput, GamepadInputEventMap, GamepadInputOptions, GamepadStick, GamepadStickOptions };
+export { GamepadAxisOptions, GamepadDeadzoneMode, GamepadInput, GamepadInputEventMap, GamepadInputOptions, GamepadStick, GamepadStickOptions };

package/dist/gamepad-input.js

@@ -2,7 +2,13 @@ import { isGamepadVibrationSupported, playGamepadVibrationEffect, resetGamepadVi
 import { GamepadManager } from "./gamepad-manager.js";
 import { EventDispatcher } from "three";
 //#region src/gamepad-input.ts
-const DEFAULT_GAMEPAD_INPUT_OPTIONS = { deadzone: .1 };
+const DEFAULT_GAMEPAD_INPUT_OPTIONS = {
+	deadzone: .1,
+	deadzoneMode: "axial",
+	rescale: false,
+	invertX: false,
+	invertY: false
+};
 /**
 * Applies a dead zone and remaps the remaining magnitude to `[0, 1]`.
 *
@@ -273,7 +279,7 @@ var GamepadInput = class extends EventDispatcher {
 		return applyGamepadAxialDeadzone(value, this.#getDeadzone(options), false);
 	}
 	/**
-	* Returns a two-axis stick after dead zone processing.
+	* Returns a two-axis stick after dead zone, rescale, and inversion processing.
 	*
 	* @param xAxis - Horizontal axis index.
 	* @param yAxis - Vertical axis index.
@@ -281,15 +287,22 @@ var GamepadInput = class extends EventDispatcher {
 	* @returns Object containing processed `x` and `y` values.
 	*/
 	stick(xAxis, yAxis, options) {
-		const rescale = options?.rescale ?? false;
+		const deadzoneMode = options?.deadzoneMode ?? this.#options.deadzoneMode;
+		const rescale = options?.rescale ?? this.#options.rescale;
+		const invertX = options?.invertX ?? this.#options.invertX;
+		const invertY = options?.invertY ?? this.#options.invertY;
 		const threshold = this.#getDeadzone(options);
 		const x = this.#gamepad?.axes[xAxis] ?? 0;
 		const y = this.#gamepad?.axes[yAxis] ?? 0;
-		if (options?.deadzoneMode === "radial") return applyGamepadRadialDeadzone(x, y, threshold, rescale);
-		return {
+		const processed = deadzoneMode === "radial" ? applyGamepadRadialDeadzone(x, y, threshold, rescale) : {
 			x: applyGamepadAxialDeadzone(x, threshold, rescale),
 			y: applyGamepadAxialDeadzone(y, threshold, rescale)
 		};
+		if (!invertX && !invertY) return processed;
+		return {
+			x: processed.x === 0 ? 0 : invertX ? -processed.x : processed.x,
+			y: processed.y === 0 ? 0 : invertY ? -processed.y : processed.y
+		};
 	}
 	/**
 	* Plays an effect through the active gamepad's primary vibration actuator.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { GAMEPAD_AXIS, GAMEPAD_BUTTON, GamepadAxisKey, GamepadAxisValue, GamepadButtonKey, GamepadButtonValue, MAX_GAMEPAD_INDEX, MIN_GAMEPAD_INDEX } from "./core.js";
-import { GamepadAxisOptions, GamepadInput, GamepadInputEventMap, GamepadInputOptions, GamepadStick, GamepadStickOptions } from "./gamepad-input.js";
+import { GamepadAxisOptions, GamepadDeadzoneMode, GamepadInput, GamepadInputEventMap, GamepadInputOptions, GamepadStick, GamepadStickOptions } from "./gamepad-input.js";
 import { GamepadControls, GamepadControlsEventMap, GamepadControlsOptions } from "./gamepad-controls.js";
 import { GamepadArcballControls, GamepadArcballControlsOptions } from "./gamepad-arcball-controls.js";
 import { GamepadDragControls, GamepadDragControlsOptions } from "./gamepad-drag-controls.js";
@@ -10,4 +10,4 @@ import { GamepadMapControls } from "./gamepad-map-controls.js";
 import { GamepadPointerLockControls, GamepadPointerLockControlsOptions } from "./gamepad-pointer-lock-controls.js";
 import { GamepadTrackballControls, GamepadTrackballControlsOptions } from "./gamepad-trackball-controls.js";
 import { GamepadTransformControls, GamepadTransformControlsOptions } from "./gamepad-transform-controls.js";
-export { GAMEPAD_AXIS, GAMEPAD_BUTTON, GamepadArcballControls, GamepadArcballControlsOptions, GamepadAxisKey, GamepadAxisOptions, GamepadAxisValue, GamepadButtonKey, GamepadButtonValue, GamepadControls, GamepadControlsEventMap, GamepadControlsOptions, GamepadDragControls, GamepadDragControlsOptions, GamepadFirstPersonControls, GamepadFirstPersonControlsOptions, GamepadFlyControls, GamepadFlyControlsOptions, GamepadInput, GamepadInputEventMap, GamepadInputOptions, GamepadMapControls, GamepadOrbitControls, GamepadOrbitControlsOptions, GamepadPointerLockControls, GamepadPointerLockControlsOptions, GamepadStick, GamepadStickOptions, GamepadTrackballControls, GamepadTrackballControlsOptions, GamepadTransformControls, GamepadTransformControlsOptions, MAX_GAMEPAD_INDEX, MIN_GAMEPAD_INDEX };
+export { GAMEPAD_AXIS, GAMEPAD_BUTTON, GamepadArcballControls, GamepadArcballControlsOptions, GamepadAxisKey, GamepadAxisOptions, GamepadAxisValue, GamepadButtonKey, GamepadButtonValue, GamepadControls, GamepadControlsEventMap, GamepadControlsOptions, GamepadDeadzoneMode, GamepadDragControls, GamepadDragControlsOptions, GamepadFirstPersonControls, GamepadFirstPersonControlsOptions, GamepadFlyControls, GamepadFlyControlsOptions, GamepadInput, GamepadInputEventMap, GamepadInputOptions, GamepadMapControls, GamepadOrbitControls, GamepadOrbitControlsOptions, GamepadPointerLockControls, GamepadPointerLockControlsOptions, GamepadStick, GamepadStickOptions, GamepadTrackballControls, GamepadTrackballControlsOptions, GamepadTransformControls, GamepadTransformControlsOptions, MAX_GAMEPAD_INDEX, MIN_GAMEPAD_INDEX };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "three-gamepad-controls",
   "description": "Gamepad support for Three.js controls.",
-  "version": "0.16.0",
+  "version": "0.18.0",
   "homepage": "https://github.com/luckasnix/three-gamepad-controls#readme",
   "author": {
     "name": "Kasnix",