Add missing mode argument for TransformControls.d.ts events (#941)

* Add TransformControlMode and add missing event mode * Rename --------- Co-authored-by: Nathan Bierema <[email protected]>
three-types · May 17, 2024 · 19b8df3 · 19b8df3
1 parent 1cc6ee8
commit 19b8df3
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/types/three/examples/jsm/controls/TransformControls.d.ts b/types/three/examples/jsm/controls/TransformControls.d.ts
@@ -1,9 +1,11 @@
 import { Camera, Mesh, MOUSE, Object3D, Object3DEventMap, Quaternion, Raycaster, Vector3 } from "three";
 
+type TransformControlsMode = "translate" | "rotate" | "scale";
+
 export interface TransformControlsEventMap extends Object3DEventMap {
     change: {};
-    mouseDown: {};
-    mouseUp: {};
+    mouseDown: { mode: TransformControlsMode };
+    mouseUp: { mode: TransformControlsMode };
     objectChange: {};
     "camera-changed": { value: unknown };
     "object-changed": { value: unknown };
@@ -43,7 +45,7 @@ export class TransformControls extends Object3D<TransformControlsEventMap> {
     object: Object3D | undefined;
     enabled: boolean;
     axis: "X" | "Y" | "Z" | "E" | "XY" | "YZ" | "XZ" | "XYZ" | "XYZE" | null;
-    mode: "translate" | "rotate" | "scale";
+    mode: TransformControlsMode;
     translationSnap: number | null;
     rotationSnap: number | null;
     space: "world" | "local";
@@ -67,9 +69,9 @@ export class TransformControls extends Object3D<TransformControlsEventMap> {
 
     attach(object: Object3D): this;
     detach(): this;
-    getMode(): "translate" | "rotate" | "scale";
+    getMode(): TransformControlsMode;
     getRaycaster(): Raycaster;
-    setMode(mode: "translate" | "rotate" | "scale"): void;
+    setMode(mode: TransformControlsMode): void;
     setTranslationSnap(translationSnap: number | null): void;
     setRotationSnap(rotationSnap: number | null): void;
     setScaleSnap(scaleSnap: number | null): void;
@@ -108,7 +110,7 @@ export class TransformControlsPlane extends Mesh {
 
     constructor();
 
-    mode: "translate" | "scale" | "rotate";
+    mode: TransformControlsMode;
 
     axis: "X" | "Y" | "Z" | "XY" | "YZ" | "XZ" | "XYZ" | "E";