@types/three 0.176.0 → 0.178.0

three/src/lights/webgpu/ProjectorLight.d.ts

@@ -0,0 +1,17 @@
+import { ColorRepresentation } from "../../math/Color.js";
+import { SpotLight } from "../SpotLight.js";
+
+declare class ProjectorLight extends SpotLight {
+    aspect: number | null;
+
+    constructor(
+        color?: ColorRepresentation,
+        intensity?: number,
+        distance?: number,
+        angle?: number,
+        penumbra?: number,
+        decay?: number,
+    );
+}
+
+export default ProjectorLight;

three/src/materials/LineBasicMaterial.d.ts

@@ -1,55 +1,87 @@
-import { Color, ColorRepresentation } from "../math/Color.js";
+import { Color } from "../math/Color.js";
 import { Texture } from "../textures/Texture.js";
-import { Material, MaterialParameters } from "./Material.js";
-
-export interface LineBasicMaterialParameters extends MaterialParameters {
-    color?: ColorRepresentation | undefined;
-    fog?: boolean | undefined;
-    linewidth?: number | undefined;
-    linecap?: string | undefined;
-    linejoin?: string | undefined;
-}
-
-export class LineBasicMaterial extends Material {
-    constructor(parameters?: LineBasicMaterialParameters);
-
-    /**
-     * Read-only flag to check if a given object is of type {@link LineBasicMaterial}.
-     * @remarks This is a _constant_ value
-     * @defaultValue `true`
-     */
-    readonly isLineBasicMaterial: true;
+import { MapColorPropertiesToColorRepresentations, Material, MaterialProperties } from "./Material.js";
 
+export interface LineBasicMaterialProperties extends MaterialProperties {
     /**
-     * @default 0xffffff
+     * Color of the material.
+     *
+     * @default (1,1,1)
      */
     color: Color;
-
     /**
-     * Whether the material is affected by fog. Default is true.
-     * @default true
+     * Sets the color of the lines using data from a texture. The texture map
+     * color is modulated by the diffuse `color`.
+     *
+     * @default null
      */
-    fog: boolean;
-
+    map: Texture | null;
     /**
+     * Controls line thickness or lines.
+     *
+     * Can only be used with {@link SVGRenderer}. WebGL and WebGPU
+     * ignore this setting and always render line primitives with a
+     * width of one pixel.
+     *
      * @default 1
      */
     linewidth: number;
-
     /**
+     * Defines appearance of line ends.
+     *
+     * Can only be used with {@link SVGRenderer}.
+     *
      * @default 'round'
      */
-    linecap: string;
-
+    linecap: "butt" | "round" | "square";
     /**
+     * Defines appearance of line joints.
+     *
+     * Can only be used with {@link SVGRenderer}.
+     *
      * @default 'round'
      */
-    linejoin: string;
-
+    linejoin: "round" | "bevel" | "miter";
     /**
-     * Sets the color of the lines using data from a {@link Texture}.
+     * Whether the material is affected by fog or not.
+     *
+     * @default true
      */
-    map: Texture | null;
+    fog: boolean;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface LineBasicMaterialParameters
+    extends Partial<MapColorPropertiesToColorRepresentations<LineBasicMaterialProperties>>
+{}
 
-    setValues(parameters: LineBasicMaterialParameters): void;
+/**
+ * A material for rendering line primitives.
+ *
+ * Materials define the appearance of renderable 3D objects.
+ *
+ * ```js
+ * const material = new THREE.LineBasicMaterial( { color: 0xffffff } );
+ * ```
+ */
+export class LineBasicMaterial extends Material {
+    /**
+     * Constructs a new line basic material.
+     *
+     * @param {Object} [parameters] - An object with one or more properties
+     * defining the material's appearance. Any property of the material
+     * (including any property from inherited materials) can be passed
+     * in here. Color values can be passed any type of value accepted
+     * by {@link Color#set}.
+     */
+    constructor(parameters?: LineBasicMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @default true
+     */
+    readonly isLineBasicMaterial: boolean;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface LineBasicMaterial extends LineBasicMaterialProperties {}

three/src/materials/LineDashedMaterial.d.ts

@@ -1,35 +1,55 @@
-import { LineBasicMaterial, LineBasicMaterialParameters } from "./LineBasicMaterial.js";
-
-export interface LineDashedMaterialParameters extends LineBasicMaterialParameters {
-    scale?: number | undefined;
-    dashSize?: number | undefined;
-    gapSize?: number | undefined;
-}
-
-export class LineDashedMaterial extends LineBasicMaterial {
-    constructor(parameters?: LineDashedMaterialParameters);
-
-    /**
-     * Read-only flag to check if a given object is of type {@link LineDashedMaterial}.
-     * @remarks This is a _constant_ value
-     * @defaultValue `true`
-     */
-    readonly isLineDashedMaterial: true;
+import { LineBasicMaterial, LineBasicMaterialProperties } from "./LineBasicMaterial.js";
+import { MapColorPropertiesToColorRepresentations } from "./Material.js";
 
+export interface LineDashedMaterialProperties extends LineBasicMaterialProperties {
     /**
+     * The scale of the dashed part of a line.
+     *
      * @default 1
      */
     scale: number;
-
     /**
-     * @default 1
+     * The size of the dash. This is both the gap with the stroke.
+     *
+     * @default 3
      */
     dashSize: number;
-
     /**
+     * The size of the gap.
+     *
      * @default 1
      */
     gapSize: number;
+}
 
-    setValues(parameters: LineDashedMaterialParameters): void;
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface LineDashedMaterialParameters
+    extends Partial<MapColorPropertiesToColorRepresentations<LineDashedMaterialProperties>>
+{}
+
+/**
+ * A material for rendering line primitives.
+ *
+ * Materials define the appearance of renderable 3D objects.
+ *
+ * ```js
+ * const material = new THREE.LineDashedMaterial( {
+ * 	color: 0xffffff,
+ * 	scale: 1,
+ * 	dashSize: 3,
+ * 	gapSize: 1,
+ * } );
+ * ```
+ */
+export class LineDashedMaterial extends LineBasicMaterial {
+    constructor(parameters?: LineDashedMaterialParameters);
+    /**
+     * This flag can be used for type testing.
+     *
+     * @default true
+     */
+    readonly isLineDashedMaterial: boolean;
 }
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface LineDashedMaterial extends LineDashedMaterialProperties {}