@xeokit/xeokit-sdk/types/viewer/scene/paths/Curve.d.ts

3D BIM IFC Viewer SDK for AEC engineering applications. Open Source JavaScript Toolkit based on pure WebGL for top performance, real-world coordinates and full double precision

import { Component } from "../Component";

export declare type CurveConfiguration = {
    /**Optional ID, unique among all components in the parent {@link Curve}, generated automatically when omitted. */
    id?: string 
    /**Current position on this Curve, in range between ````0..1```` */
    t?: number
}

export declare class Curve extends Component {
    /**
     * @constructor
     * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this Curve as well.
     * @param {CurveConfiguration} [cfg] Configs
     */
    constructor(owner?: Component, cfg?: CurveConfiguration);

    /**
     * Sets the progress along this Curve.
     *
     * Automatically clamps to range ````[0..1]````.
     *
     * Default value is ````0````.
     *
     * @param {Number} value The progress value.
     */
    set t(value: number);

    /**
     * Gets the progress along this Curve.
     *
     * @returns {Number} The progress value.
     */
    get t(): number;

    /**
     * Gets the tangent on this Curve at position {@link Curve#t}.
     *
     * @returns {Number[]} The tangent.
     */
    get tangent(): number[];

    /**
     * Gets the approximate length of this Curve.
     *
     * This method calculates the length by discretizing Curve into hardcoded number of straight segments. Then it sums
     * lengths of these straight segments.
     *
     * If you need more control over the precision of the length calculation, we strongly encourage you to build
     * your own custom function.
     *
     * @returns {Number} The approximate Curve length.
     */
    get length(): number;

    /**
     * Returns a normalized tangent vector on this Curve at the given position.
     *
     * @param {Number} t Position to get tangent at.
     * @returns {Number[]} Normalized tangent vector
     */
    getTangent(t: number): number[];

    getPointAt(u: number): number[];

    /**
     * Samples points on this Curve, at the given number of equally-spaced divisions.
     *
     * @param {Number} divisions The number of divisions.
     * @returns {{Array of Array}} Array of sampled 3D points.
     */
    getPoints(divisions: number): number[][];

    /**
     * 
     * @param {Number} u
     * @param {Number} distance 
     * @returns {Number}
     */
    getUToTMapping(u: number, distance: number): number;
}