Class CurvePath<T>

Curved Path - a curve path is simply a array of connected curves, but retains the api of a curve.

Remarks

A CurvePath is simply an array of connected curves, but retains the api of a curve.

See

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

arcLengthDivisions autoClose curves type

Methods

add clone closePath computeFrenetFrames copy fromJSON getCurveLengths getLength getLengths getPoint getPointAt getPoints getSpacedPoints getTangent getTangentAt getUtoTmapping toJSON updateArcLengths

Constructors

constructor

Properties

arcLengthDivisions

arcLengthDivisions: number

This value determines the amount of divisions when calculating the cumulative segment lengths of a Curve via .getLengths. To ensure precision when using methods like .getSpacedPoints, it is recommended to increase .arcLengthDivisions if the Curve is very large.

Default Value

200

Remarks

Expects a Integer

autoClose

autoClose: boolean

Whether or not to automatically close the path.

Default Value

false

curves

curves: Curve<T>[]

The array of Curves.

Default Value

[]

Readonly type

type: string

A Read-only string to check if this object type.

Remarks

Sub-classes will update this value.

Default Value

CurvePath

Methods

add

  • add(curve): void

  • Add a curve to the .curves array.

    Parameters

    Returns void

clone

  • clone(): this

  • Creates a clone of this instance.

    Returns this

closePath

  • closePath(): this

  • Adds a lineCurve to close the path.

    Returns this

computeFrenetFrames

  • computeFrenetFrames(segments, closed?): {
        binormals: Vector3[];
        normals: Vector3[];
        tangents: Vector3[];
    }

  • Generates the Frenet Frames

    Parameters

    • segments: number

      Expects a Integer

    • Optional closed: boolean

    Returns {
        binormals: Vector3[];
        normals: Vector3[];
        tangents: Vector3[];
    }

    Remarks

    Requires a Curve definition in 3D space Used in geometries like TubeGeometry or ExtrudeGeometry.

copy

  • copy(source): this

  • Copies another Curve object to this instance.

    Parameters

    Returns this

fromJSON

  • fromJSON(json): this

  • Copies the data from the given JSON object to this instance.

    Parameters

    • json: {}

      Returns this

    getCurveLengths

    • getCurveLengths(): number[]

    • Get list of cumulative curve lengths of the curves in the .curves array.

      Returns number[]

    getLength

    • getLength(): number

    • Get total Curve arc length.

      Returns number

    getLengths

    • getLengths(divisions?): number[]

    • Get list of cumulative segment lengths.

      Parameters

      • Optional divisions: number

        Expects a Integer

      Returns number[]

    getPoint

    • getPoint(t, optionalTarget?): T

    • Returns a vector for a given position on the curve.

      Parameters

      • t: number

        A position on the curve. Must be in the range [ 0, 1 ]. Expects a Float

      • Optional optionalTarget: T

        If specified, the result will be copied into this Vector, otherwise a new Vector will be created. Default new T.

      Returns T

    getPointAt

    • getPointAt(u, optionalTarget?): T

    • Returns a vector for a given position on the Curve according to the arc length.

      Parameters

      • u: number

        A position on the Curve according to the arc length. Must be in the range [ 0, 1 ]. Expects a Float

      • Optional optionalTarget: T

        If specified, the result will be copied into this Vector, otherwise a new Vector will be created. Default new T.

      Returns T

    getPoints

    • getPoints(divisions?): T[]

    • Returns an array of points representing a sequence of curves

      Parameters

      • Optional divisions: number

        Number of pieces to divide the curve into. Expects a Integer. Default 12

      Returns T[]

      Remarks

      The division parameter defines the number of pieces each curve is divided into However, for optimization and quality purposes, the actual sampling resolution for each curve depends on its type For example, for a LineCurve, the returned number of points is always just 2.

    getSpacedPoints

    • getSpacedPoints(divisions?): T[]

    • Returns a set of divisions +1 equi-spaced points using .getPointAt | getPointAt(u).

      Parameters

      • Optional divisions: number

        Number of pieces to divide the curve into. Expects a Integer. Default 40

      Returns T[]

    getTangent

    • getTangent(t, optionalTarget?): T

    • Returns a unit vector tangent at t

      Parameters

      • t: number

        A position on the curve. Must be in the range [ 0, 1 ]. Expects a Float

      • Optional optionalTarget: T

        If specified, the result will be copied into this Vector, otherwise a new Vector will be created.

      Returns T

      Remarks

      If the derived Curve does not implement its tangent derivation, two points a small delta apart will be used to find its gradient which seems to give a reasonable approximation.

    getTangentAt

    • getTangentAt(u, optionalTarget?): T

    • Returns tangent at a point which is equidistant to the ends of the Curve from the point given in .getTangent.

      Parameters

      • u: number

        A position on the Curve according to the arc length. Must be in the range [ 0, 1 ]. Expects a Float

      • Optional optionalTarget: T

        If specified, the result will be copied into this Vector, otherwise a new Vector will be created.

      Returns T

    getUtoTmapping

    • getUtoTmapping(u, distance): number

    • Given u in the range [ 0, 1 ],

      Parameters

      • u: number

        Expects a Float

      • distance: number

        Expects a Float

      Returns number

      t also in the range [ 0, 1 ]. Expects a Float.

      Remarks

      u and t can then be used to give you points which are equidistant from the ends of the curve, using .getPoint.

    toJSON

    • toJSON(): {}

    • Returns a JSON object representation of this instance.

      Returns {}

      updateArcLengths

      • updateArcLengths(): void

      • Update the cumulative segment distance cache

        Returns void

        Remarks

        The method must be called every time Curve parameters are changed If an updated Curve is part of a composed Curve like CurvePath, .updateArcLengths() must be called on the composed curve, too.

      Settings

      Member Visibility

      On This Page

      constructorarcLengthDivisionsautoClosecurvestypeaddcloneclosePathcomputeFrenetFramescopyfromJSONgetCurveLengthsgetLengthgetLengthsgetPointgetPointAtgetPointsgetSpacedPointsgetTangentgetTangentAtgetUtoTmappingtoJSONupdateArcLengths