UNPKG

1.28 kBTypeScriptView Raw
1import { Vector3 } from "../../math/Vector3.js";
2import { Curve } from "../core/Curve.js";
3
4/**
5 * A curve representing a **3D** line segment.
6 * @see {@link https://threejs.org/docs/index.html#api/en/extras/curves/LineCurve3 | Official Documentation}
7 * @see {@link https://github.com/mrdoob/three.js/blob/master/src/extras/curves/LineCurve3.js | Source}
8 */
9export class LineCurve3 extends Curve<Vector3> {
10 /**
11 * This constructor creates a new {@link LineCurve3}.
12 * @param v1 The start point. Default is `new THREE.Vector3()`.
13 * @param v2 The end point. Default is `new THREE.Vector3()`.
14 */
15 constructor(v1?: Vector3, v2?: Vector3);
16
17 /**
18 * Read-only flag to check if a given object is of type {@link LineCurve3}.
19 * @remarks This is a _constant_ value
20 * @defaultValue `true`
21 */
22 readonly isLineCurve3 = true;
23
24 /**
25 * A Read-only _string_ to check if `this` object type.
26 * @remarks Sub-classes will update this value.
27 * @defaultValue `LineCurve3`
28 */
29 override readonly type: string | "LineCurve3";
30
31 /**
32 * The start point.
33 * @defaultValue `new THREE.Vector3()`.
34 */
35 v1: Vector3;
36
37 /**
38 * The end point.
39 * @defaultValue `new THREE.Vector3()`.
40 */
41 v2: Vector3;
42}