@needle-tools/three 0.169.12 → 0.169.13

package/types/examples/jsm/controls/ArcballControls.d.ts

@@ -0,0 +1,203 @@
+import { Camera, Controls, Raycaster, Scene } from "three";
+
+export type ArcballControlsMouseActionOperation = "PAN" | "ROTATE" | "ZOOM" | "FOV";
+
+export type ArcballControlsMouseActionMouse = 0 | 1 | 2 | "WHEEL";
+
+export type ArcballControlsMouseActionKey = "SHIFT" | "CTRL";
+
+export interface ArcballControlsEventMap {
+    /**
+     * Fires when the camera has been transformed by the controls.
+     */
+    change: {};
+
+    /**
+     * Fires when an interaction was initiated.
+     */
+    start: {};
+
+    /**
+     * Fires when an interaction has finished.
+     */
+    end: {};
+}
+
+/**
+ * Arcball controls allow the camera to be controlled by a virtual trackball with full touch support and advanced
+ * navigation functionality.
+ */
+declare class ArcballControls extends Controls<ArcballControlsEventMap> {
+    /**
+     * The scene rendered by the camera.
+     */
+    scene: Scene | null;
+
+    /**
+     * The size of the gizmo relative to the screen width and height. Default is 0.67.
+     */
+    radiusFactor: number;
+
+    /**
+     * Duration time of focus animation.
+     */
+    focusAnimationTime: number;
+
+    /**
+     * If true, camera's near and far values will be adjusted every time zoom is performed trying to mantain the same
+     * visible portion given by initial near and far values ( {@link PerspectiveCamera} only ). Default is false.
+     */
+    adjustNearFar: boolean;
+
+    /**
+     * The scaling factor used when performing zoom operation.
+     */
+    scaleFactor: number;
+
+    /**
+     * The damping inertia used if [page:.enableAnimations] is set to true.
+     */
+    dampingFactor: number;
+
+    /**
+     * Maximum angular velocity allowed on rotation animation start.
+     */
+    wMax: number;
+
+    /**
+     * Set to true to enable animations for rotation (damping) and focus operation. Default is true.
+     */
+    enableAnimations: boolean;
+
+    /**
+     * When set to true, a grid will appear when panning operation is being performed (desktop interaction only). Default is false.
+     */
+    enableGrid: boolean;
+
+    /**
+     * Set to true to make zoom become cursor centered.
+     */
+    cursorZoom: boolean;
+
+    /**
+     * Speed of rotation. Default is 1.
+     */
+    rotateSpeed: number;
+
+    /**
+     * Enable or disable camera panning. Default is true.
+     */
+    enablePan: boolean;
+
+    /**
+     * Enable or disable camera rotation. Default is true.
+     */
+    enableRotate: boolean;
+
+    /**
+     * Enable or disable zooming of the camera.
+     */
+    enableZoom: boolean;
+
+    /**
+     * How far you can dolly in ( {@link PerspectiveCamera} only ). Default is 0.
+     */
+    minDistance: number;
+
+    /**
+     * How far you can dolly out ( {@link PerspectiveCamera} only ). Default is Infinity.
+     */
+    maxDistance: number;
+
+    /**
+     * How far you can zoom in ( {@link OrthographicCamera} only ). Default is 0.
+     */
+    minZoom: number;
+
+    /**
+     * How far you can zoom out ( {@link OrthographicCamera} only ). Default is Infinity.
+     */
+    maxZoom: number;
+
+    /**
+     * @param camera The camera to be controlled. The camera must not be a child of another object, unless that object
+     * is the scene itself.
+     * @param domElement The HTML element used for event listeners. (optional)
+     * @param scene The scene rendered by the camera. If not given, gizmos cannot be shown. (optional)
+     */
+    constructor(camera: Camera, domElement?: HTMLElement | null, scene?: Scene | null);
+
+    /**
+     * Set a new mouse action by specifying the operation to be performed and a mouse/key combination. In case of
+     * conflict, replaces the existing one.
+     * @param operation Operations can be specified as 'ROTATE', 'PAN', 'FOV' or 'ZOOM'.
+     * @param mouse Mouse inputs can be specified as mouse buttons 0, 1 and 2 or 'WHEEL' for wheel notches.
+     * @param key Keyboard modifiers can be specified as 'CTRL', 'SHIFT' or null if not needed.
+     */
+    setMouseAction(
+        operation: ArcballControlsMouseActionOperation,
+        mouse: ArcballControlsMouseActionMouse,
+        key?: ArcballControlsMouseActionKey | null,
+    ): boolean;
+
+    /**
+     * Removes a mouse action by specifying its mouse/key combination.
+     * @param mouse Mouse inputs can be specified as mouse buttons 0, 1 and 2 or 'WHEEL' for wheel notches.
+     * @param key Keyboard modifiers can be specified as 'CTRL', 'SHIFT' or null if not needed.
+     */
+    unsetMouseAction(mouse: ArcballControlsMouseActionMouse, key?: ArcballControlsMouseActionKey | null): boolean;
+
+    /**
+     * Make gizmos more or less visible.
+     */
+    activateGizmos(isActive: boolean): void;
+
+    /**
+     * Set the camera to be controlled. Must be called in order to set a new camera to be controlled.
+     */
+    setCamera(camera: Camera): void;
+
+    /**
+     * Set the visible property of gizmos.
+     */
+    setGizmosVisible(value: boolean): void;
+
+    /**
+     * Update the `radiusFactor` value, redraw the gizmo and send a `changeEvent` to visualise the changes.
+     */
+    setTbRadius(value: number): void;
+
+    /**
+     * Reset the controls to their state from either the last time the {@link .saveState} was called, or the initial
+     * state.
+     */
+    reset(): void;
+
+    /**
+     * Copy the current state to clipboard (as a readable JSON text).
+     */
+    copyState(): void;
+
+    /**
+     * Set the controls state from the clipboard, assumes that the clipboard stores a JSON text as saved from
+     * {@link .copyState}.
+     */
+    pasteState(): void;
+
+    /**
+     * Save the current state of the controls. This can later be recovered with {@link .reset}.
+     */
+    saveState(): void;
+
+    /**
+     * Returns the {@link Raycaster} object that is used for user interaction. This object is shared between all
+     * instances of ArcballControls. If you set the [.layers]{@link Object3D.layers} property of the
+     * {@link ArcballControls}, you will also want to set the [.layers]{@link Raycaster.layers} property on the
+     * {@link Raycaster} with a matching value, or else the {@link ArcballControls} won't work as expected.
+     */
+    getRaycaster(): Raycaster;
+
+    update(): void;
+}
+
+export { ArcballControls };

package/types/examples/jsm/controls/DragControls.d.ts

@@ -0,0 +1,111 @@
+import { Camera, Controls, MOUSE, Object3D, Raycaster, TOUCH } from "three";
+
+export interface DragControlsEventMap {
+    /**
+     * Fires when the pointer is moved onto a 3D object, or onto one of its children.
+     */
+    hoveron: { object: Object3D };
+
+    /**
+     * Fires when the pointer is moved out of a 3D object.
+     */
+    hoveroff: { object: Object3D };
+
+    /**
+     * Fires when the user starts to drag a 3D object.
+     */
+    dragstart: { object: Object3D };
+
+    /**
+     * Fires when the user drags a 3D object.
+     */
+    drag: { object: Object3D };
+
+    /**
+     * Fires when the user has finished dragging a 3D object.
+     */
+    dragend: { object: Object3D };
+}
+
+declare class DragControls extends Controls<DragControlsEventMap> {
+    /**
+     * An array of draggable 3D objects.
+     */
+    objects: Object3D[];
+
+    /**
+     * Whether children of draggable objects can be dragged independently from their parent. Default is `true`.
+     */
+    recursive: boolean;
+
+    /**
+     * This option only works if the {@link .objects} array contains a single draggable group object. If set to `true`,
+     * {@link DragControls} does not transform individual objects but the entire group. Default is `false`.
+     */
+    transformGroup: boolean;
+
+    /**
+     * The speed at which the object will rotate when dragged in `rotate` mode. The higher the number the faster the
+     * rotation. Default is `1`.
+     */
+    rotateSpeed: number;
+
+    /**
+     * The internal raycaster used for detecting 3D objects.
+     */
+    raycaster: Raycaster;
+
+    /**
+     * This object defines what type of actions are assigned to the available mouse buttons.
+     */
+    mouseButtons: {
+        LEFT?: MOUSE | null | undefined;
+        MIDDLE?: MOUSE | null | undefined;
+        RIGHT?: MOUSE | null | undefined;
+    };
+
+    /**
+     * This object defines what type of actions are assigned to what kind of touch interaction.
+     */
+    touches: { ONE?: TOUCH | null | undefined };
+
+    /**
+     * Creates a new instance of DragControls.
+     * @param objects An array of draggable 3D objects.
+     * @param camera The camera of the rendered scene.
+     * @param domElement The HTML element used for event listeners. (optional)
+     */
+    constructor(objects: Object3D[], camera: Camera, domElement?: HTMLElement | null);
+
+    /**
+     * Returns the internal {@link Raycaster} instance that is used for intersection tests.
+     * @deprecated getRaycaster() has been deprecated. Use controls.raycaster instead.
+     */
+    getRaycaster(): Raycaster;
+
+    /**
+     * Sets an array of draggable objects by overwriting the existing one.
+     * @deprecated setObjects() has been deprecated. Use controls.objects instead.
+     */
+    setObjects(objects: readonly Object3D[]): void;
+
+    /**
+     * Returns the array of draggable objects.
+     * @deprecated getObjects() has been deprecated. Use controls.objects instead.
+     */
+    getObjects(): Object3D[];
+
+    /**
+     * Adds the event listeners of the controls.
+     * @deprecated activate() has been renamed to connect().
+     */
+    activate(): void;
+
+    /**
+     * Removes the event listeners of the controls.
+     * @deprecated deactivate() has been renamed to disconnect().
+     */
+    deactivate(): void;
+}
+
+export { DragControls };

package/types/examples/jsm/controls/FirstPersonControls.d.ts

@@ -0,0 +1,101 @@
+import { Camera, Controls, Vector3 } from "three";
+
+/**
+ * This class is an alternative implementation of {@link FlyControls}.
+ */
+declare class FirstPersonControls extends Controls<{}> {
+    /**
+     * The movement speed. Default is *1*.
+     */
+    movementSpeed: number;
+
+    /**
+     * The look around speed. Default is `0.005`.
+     */
+    lookSpeed: number;
+
+    /**
+     * Whether or not it's possible to vertically look around. Default is `true`.
+     */
+    lookVertical: boolean;
+
+    /**
+     * Whether or not the camera is automatically moved forward. Default is `false`.
+     */
+    autoForward: boolean;
+
+    /**
+     * Whether or not it's possible to look around. Default is `true`.
+     */
+    activeLook: boolean;
+
+    /**
+     * Whether or not the camera's height influences the forward movement speed. Default is `false`.
+     * Use the properties {@link .heightCoef}, {@link .heightMin} and {@link .heightMax} for configuration
+     */
+    heightSpeed: boolean;
+
+    /**
+     * Determines how much faster the camera moves when it's y-component is near {@link .heightMax}. Default is *1*.
+     */
+    heightCoef: number;
+
+    /**
+     * Lower camera height limit used for movement speed adjustment. Default is *0*.
+     */
+    heightMin: number;
+
+    /**
+     * Upper camera height limit used for movement speed adjustment. Default is *1*.
+     */
+    heightMax: number;
+
+    /**
+     * Whether or not looking around is vertically constrained by [{@link .verticalMin}, {@link .verticalMax}]. Default
+     * is `false`.
+     */
+    constrainVertical: boolean;
+
+    /**
+     * How far you can vertically look around, lower limit. Range is 0 to Math.PI radians. Default is *0*.
+     */
+    verticalMin: number;
+
+    /**
+     * How far you can vertically look around, upper limit. Range is 0 to Math.PI radians. Default is `Math.PI`.
+     */
+    verticalMax: number;
+
+    /**
+     * Whether or not the mouse is pressed down. Read-only property.
+     */
+    mouseDragOn: boolean;
+
+    /**
+     * Creates a new instance of {@link FirstPersonControls}.
+     * @param object The camera to be controlled.
+     * @param domElement The HTML element used for event listeners. (optional)
+     */
+    constructor(object: Camera, domElement?: HTMLElement);
+
+    /**
+     * Should be called if the application window is resized.
+     */
+    handleResize(): void;
+
+    /**
+     * Ensures the controls orient the camera towards the defined target position.
+     * @param vector A vector representing the target position.
+     */
+    lookAt(vector: Vector3): this;
+
+    /**
+     * Ensures the controls orient the camera towards the defined target position.
+     * @param x The x component of the world space position.
+     * @param y The y component of the world space position.
+     * @param z The z component of the world space position.
+     */
+    lookAt(x: number, y: number, z: number): this;
+}
+
+export { FirstPersonControls };

package/types/examples/jsm/controls/FlyControls.d.ts

@@ -0,0 +1,44 @@
+import { Camera, Controls } from "three";
+
+export interface FlyControlsEventMap {
+    /**
+     * Fires when the camera has been transformed by the controls.
+     */
+    change: {};
+}
+
+/**
+ * {@link FlyControls} enables a navigation similar to fly modes in DCC tools like Blender. You can arbitrarily
+ * transform the camera in 3D space without any limitations (e.g. focus on a specific target).
+ */
+declare class FlyControls extends Controls<FlyControlsEventMap> {
+    /**
+     * The movement speed. Default is `1`.
+     */
+    movementSpeed: number;
+
+    /**
+     * The rotation speed. Default is `0.005`.
+     */
+    rollSpeed: number;
+
+    /**
+     * If set to `true`, you can only look around by performing a drag interaction. Default is `false`.
+     */
+    dragToLook: boolean;
+
+    /**
+     * If set to `true`, the camera automatically moves forward (and does not stop) when initially translated. Default
+     * is `false`.
+     */
+    autoForward: boolean;
+
+    /**
+     * Creates a new instance of {@link FlyControls}.
+     * @param object The camera to be controlled.
+     * @param domElement The HTML element used for event listeners. (optional)
+     */
+    constructor(object: Camera, domElement?: HTMLElement | null);
+}
+
+export { FlyControls };

package/types/examples/jsm/controls/MapControls.d.ts

@@ -0,0 +1,21 @@
+import { Camera } from "three";
+import { OrbitControls } from "./OrbitControls.js";
+
+/**
+ * MapControls performs orbiting, dollying (zooming), and panning.
+ * Unlike TrackballControls, it maintains the "up" direction
+ * object.up (+Y by default).
+ *
+ *    Orbit - right mouse, or left mouse + ctrl/meta/shiftKey / touch:
+ *    two-finger rotate
+ *    Zoom - middle mouse, or mousewheel / touch: two-finger spread or squish
+ *    Pan - left mouse, or arrow keys / touch: one-finger move
+ *
+ * @param object - The camera to be controlled. The camera must not
+ * be a child of another object, unless that object is the scene itself.
+ * @param domElement - The HTML element used for
+ * event listeners.
+ */
+export class MapControls extends OrbitControls {
+    constructor(object: Camera, domElement?: HTMLElement);
+}