@types/three 0.134.0 → 0.135.0

three/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for three (https://threejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three.
 
 ### Additional Details
- * Last updated: Mon, 08 Nov 2021 18:01:35 GMT
+ * Last updated: Mon, 06 Dec 2021 23:31:03 GMT
  * Dependencies: none
  * Global values: `THREE`
 

three/examples/jsm/controls/DragControls.d.ts

@@ -1,4 +1,4 @@
-import { Camera, EventDispatcher, Object3D } from '../../../src/Three';
+import { Camera, EventDispatcher, Object3D, Raycaster } from '../../../src/Three';
 
 export class DragControls extends EventDispatcher {
     constructor(objects: Object3D[], camera: Camera, domElement?: HTMLElement);
@@ -14,4 +14,5 @@ export class DragControls extends EventDispatcher {
     deactivate(): void;
     dispose(): void;
     getObjects(): Object3D[];
+    getRaycaster(): Raycaster;
 }

three/examples/jsm/csm/CSM.d.ts

@@ -1,36 +1,61 @@
+import { Camera, Vector3, DirectionalLight, Material, Vector2, Object3D } from '../../../src/Three';
+
+export enum CMSMode {
+    practical = 'practical',
+    uniform = 'uniform',
+    logarithmic = 'logarithmic',
+    custom = 'custom',
+}
+
+export interface CMSParameters {
+    camera?: Camera;
+    parent?: Object3D;
+    cascades?: number;
+    maxFar?: number;
+    mode?: CMSMode;
+    shadowMapSize?: number;
+    shadowBias?: number;
+    lightDirection?: Vector3;
+    lightIntensity?: number;
+    lightNear?: number;
+    lightFar?: number;
+    lightMargin?: number;
+    customSplitsCallback?: (cascades: number, cameraNear: number, cameraFar: number, breaks: number[]) => void;
+}
+
 export class CSM {
-    constructor(data: any);
-    camera: any;
-    parent: any;
-    cascades: any;
-    maxFar: any;
-    mode: any;
-    shadowMapSize: any;
-    shadowBias: any;
-    lightDirection: any;
-    lightIntensity: any;
-    lightNear: any;
-    lightFar: any;
-    lightMargin: any;
-    customSplitsCallback: any;
+    constructor(data?: CMSParameters);
+    camera: Camera;
+    parent: Object3D;
+    cascades: number;
+    maxFar: number;
+    mode: CMSMode;
+    shadowMapSize: number;
+    shadowBias: number;
+    lightDirection: Vector3;
+    lightIntensity: number;
+    lightNear: number;
+    lightFar: number;
+    lightMargin: number;
+    customSplitsCallback: (cascades: number, cameraNear: number, cameraFar: number, breaks: number[]) => void;
     fade: boolean;
-    mainFrustum: Frustum;
-    frustums: any[];
-    breaks: any[];
-    lights: any[];
-    shaders: Map<any, any>;
+    mainFrustum: CSMFrustrum;
+    frustums: CSMFrustrum[];
+    breaks: number[];
+    lights: DirectionalLight[];
+    shaders: Map<unknown, string>;
     createLights(): void;
     initCascades(): void;
     updateShadowBounds(): void;
     getBreaks(): void;
     update(): void;
     injectInclude(): void;
-    setupMaterial(material: any): void;
+    setupMaterial(material: Material): void;
     updateUniforms(): void;
-    getExtendedBreaks(target: any): void;
+    getExtendedBreaks(target: Vector2[]): void;
     updateFrustums(): void;
     remove(): void;
     dispose(): void;
 }
 
-import Frustum from './Frustum.js';
+import CSMFrustrum from './CSMFrustum.js';

three/examples/jsm/csm/CSMFrustum.d.ts

@@ -0,0 +1,19 @@
+import { Matrix4, Vector3 } from '../../../src/Three';
+
+export interface CSMFrustumVerticies {
+    near: Vector3[];
+    far: Vector3[];
+}
+
+export interface CSMFrustumParameters {
+    projectionMatrix?: Matrix4;
+    maxFar?: number;
+}
+
+export default class CSMFrustum {
+    constructor(data?: CSMFrustumParameters);
+    vertices: CSMFrustumVerticies;
+    setFromProjectionMatrix(projectionMatrix: Matrix4, maxFar: number): CSMFrustumVerticies;
+    split(breaks: number[], target: CSMFrustum[]): void;
+    toSpace(cameraMatrix: Matrix4, target: CSMFrustum): void;
+}

three/examples/jsm/csm/CSMHelper.d.ts

@@ -1,13 +1,26 @@
-export class CSMHelper {
-    constructor(csm: any);
-    csm: any;
+import {
+    Box3Helper,
+    BufferGeometry,
+    Group,
+    LineBasicMaterial,
+    LineSegments,
+    Mesh,
+    MeshBasicMaterial,
+    PlaneGeometry,
+} from '../../../src/Three';
+
+import { CSM } from './CSM';
+
+export class CSMHelper<TCSM extends CSM = CSM> extends Group {
+    constructor(csm: TCSM);
+    csm: TCSM;
     displayFrustum: boolean;
     displayPlanes: boolean;
     displayShadowBounds: boolean;
-    frustumLines: any;
-    cascadeLines: any[];
-    cascadePlanes: any[];
-    shadowLines: any[];
+    frustumLines: LineSegments<BufferGeometry, LineBasicMaterial>;
+    cascadeLines: Box3Helper[];
+    cascadePlanes: Array<Mesh<PlaneGeometry, MeshBasicMaterial>>;
+    shadowLines: Box3Helper[];
     updateVisibility(): void;
     update(): void;
 }

three/examples/jsm/csm/CSMShader.d.ts

@@ -0,0 +1,4 @@
+export interface CSMShader {
+    lights_fragment_begin: string;
+    lights_pars_begin: string;
+}

three/examples/jsm/exporters/GLTFExporter.d.ts

@@ -16,4 +16,5 @@ export class GLTFExporter {
     constructor();
 
     parse(input: Object3D, onCompleted: (gltf: object) => void, options: GLTFExporterOptions): void;
+    parseAsync(input: Object3D, options: GLTFExporterOptions): Promise<void>;
 }

three/examples/jsm/loaders/GLTFLoader.d.ts

@@ -64,6 +64,8 @@ export class GLTFLoader extends Loader {
         onLoad: (gltf: GLTF) => void,
         onError?: (event: ErrorEvent) => void,
     ): void;
+
+    parseAsync(data: ArrayBuffer | string, path: string): Promise<void>;
 }
 
 export type GLTFReferenceType = 'materials' | 'nodes' | 'textures' | 'meshes';

three/examples/jsm/loaders/LogLuvLoader.d.ts

@@ -0,0 +1,19 @@
+import { DataTextureLoader, TextureDataType, LoadingManager, PixelFormat } from '../../../src/Three';
+
+export interface LogLuv {
+    width: number;
+    height: number;
+    data: Uint16Array | Float32Array;
+    format: PixelFormat;
+    type: TextureDataType;
+    flipY: boolean;
+}
+
+export class LogLuvLoader extends DataTextureLoader {
+    type: TextureDataType;
+    constructor(manager: LoadingManager);
+
+    parse(buffer: Iterable<number>): LogLuv;
+
+    setDataType(value: TextureDataType): this;
+}

three/examples/jsm/webxr/OculusHandPointerModel.d.ts

@@ -53,11 +53,11 @@ export class OculusHandPointerModel extends Object3D {
 
     public isAttached(): boolean;
 
-    public intersectObject(object: Object3D): Intersection[] | void;
+    public intersectObject(object: Object3D, recursive?: boolean): Intersection[] | void;
 
-    public intersectObjects(objects: Object3D[]): Intersection[] | void;
+    public intersectObjects(objects: Object3D[], recursive?: boolean): Intersection[] | void;
 
-    public checkIntersections(objects: Object3D[]): void;
+    public checkIntersections(objects: Object3D[], recursive?: boolean): void;
 
     public setCursor(distance: number): void;
 }

three/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for three 0.134
+// Type definitions for three 0.135
 // Project: https://threejs.org/
 // Definitions by: Josh Ellis <https://github.com/joshuaellis>
 //                 Nathan Bierema <https://github.com/Methuselah96>

three/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/three",
-    "version": "0.134.0",
+    "version": "0.135.0",
     "description": "TypeScript definitions for three",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/three",
     "license": "MIT",
@@ -25,6 +25,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "081e8a2aa20cac9bb8a5fc1c65f63e7f502175cd0654faf460174999473bd0ac",
-    "typeScriptVersion": "3.7"
+    "typesPublisherContentHash": "d0154c4f95513cc2c40c0bf65e56ad0b1bd41ffca75f306c6e9bf6c0c8e6dd84",
+    "typeScriptVersion": "3.8"
 }

three/src/cameras/OrthographicCamera.d.ts

@@ -18,7 +18,7 @@ export class OrthographicCamera extends Camera {
      * @param [near=0.1] Camera frustum near plane.
      * @param [far=2000] Camera frustum far plane.
      */
-    constructor(left: number, right: number, top: number, bottom: number, near?: number, far?: number);
+    constructor(left?: number, right?: number, top?: number, bottom?: number, near?: number, far?: number);
 
     type: 'OrthographicCamera';
 

three/src/core/Layers.d.ts

@@ -13,4 +13,5 @@ export class Layers {
     disable(channel: number): void;
     disableAll(): void;
     test(layers: Layers): boolean;
+    isEnabled(channel: number): boolean;
 }

three/src/core/Object3D.d.ts

@@ -119,6 +119,7 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
      * @default new THREE.Layers()
      */
     layers: Layers;
+
     /**
      * Object gets rendered if true.
      * @default true
@@ -211,18 +212,41 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     static DefaultMatrixAutoUpdate: boolean;
 
     /**
-     * This updates the position, rotation and scale with the matrix.
+     * Applies the matrix transform to the object and updates the object's position, rotation and scale.
      */
     applyMatrix4(matrix: Matrix4): void;
 
+    /**
+     * Applies the rotation represented by the quaternion to the object.
+     */
     applyQuaternion(quaternion: Quaternion): this;
 
+    /**
+     * axis -- A normalized vector in object space.
+     * angle -- angle in radians
+     * @param axis A normalized vector in object space.
+     * @param angle angle in radians
+     */
     setRotationFromAxisAngle(axis: Vector3, angle: number): void;
 
+    /**
+     * Calls setRotationFromEuler(euler) on the .quaternion.
+     * @param euler Euler angle specifying rotation amount.
+     */
     setRotationFromEuler(euler: Euler): void;
 
+    /**
+     * Calls setFromRotationMatrix(m) on the .quaternion.
+     *
+     * Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
+     * @param m rotate the quaternion by the rotation component of the matrix.
+     */
     setRotationFromMatrix(m: Matrix4): void;
 
+    /**
+     * Copy the given quaternion into .quaternion.
+     * @param q normalized Quaternion
+     */
     setRotationFromQuaternion(q: Quaternion): void;
 
     /**
@@ -240,24 +264,25 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     rotateOnWorldAxis(axis: Vector3, angle: number): this;
 
     /**
-     *
-     * @param angle
+     * Rotates the object around x axis in local space.
+     * @param angle the angle to rotate in radians.
      */
     rotateX(angle: number): this;
 
     /**
-     *
-     * @param angle
+     * Rotates the object around y axis in local space.
+     * @param angle the angle to rotate in radians.
      */
     rotateY(angle: number): this;
 
     /**
-     *
-     * @param angle
+     * Rotates the object around z axis in local space.
+     * @param angle the angle to rotate in radians.
      */
     rotateZ(angle: number): this;
 
     /**
+     * Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
      * @param axis	A normalized vector in object space.
      * @param distance	The distance to translate.
      */
@@ -294,7 +319,9 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
     worldToLocal(vector: Vector3): Vector3;
 
     /**
-     * Rotates object to face point in space.
+     * Optionally, the x, y and z components of the world space position.
+     * Rotates the object to face a point in world space.
+     * This method does not support objects having non-uniformly-scaled parent(s).
      * @param vector A world vector to look at.
      */
     lookAt(vector: Vector3 | number, y?: number, z?: number): void;
@@ -361,6 +388,11 @@ export class Object3D<E extends BaseEvent = Event> extends EventDispatcher<E> {
      */
     updateMatrixWorld(force?: boolean): void;
 
+    /**
+     * Updates the global transform of the object.
+     * @param updateParents recursively updates global transform of ancestors.
+     * @param updateChildren recursively updates global transform of descendants.
+     */
     updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void;
 
     toJSON(meta?: { geometries: any; materials: any; textures: any; images: any }): any;

three/examples/jsm/csm/Frustum.d.ts

@@ -1,16 +0,0 @@
-export default class Frustum {
-    constructor(data: any);
-    vertices: {
-        near: any[];
-        far: any[];
-    };
-    setFromProjectionMatrix(
-        projectionMatrix: any,
-        maxFar: any,
-    ): {
-        near: any[];
-        far: any[];
-    };
-    split(breaks: any, target: any): void;
-    toSpace(cameraMatrix: any, target: any): void;
-}

three/examples/jsm/csm/Shader.d.ts

@@ -1,6 +0,0 @@
-declare namespace _default {
-    const lights_fragment_begin: string;
-    const lights_pars_begin: string;
-}
-
-export default _default;