Class Curve<T>Abstract

arcLengthDivisions

Readonlytype

clone

• clone(): this

• Creates a clone of this instance.

  Returns this

computeFrenetFrames

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

• Generates the Frenet Frames

  Parameters

  • segments: number

    Expects a Integer
  • Optionalclosed: boolean

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

  • 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

  • source: Curve<T>

  Returns this

fromJSON

• fromJSON(json): this

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

  Parameters

  • json: {}

  Returns this

getLength

• getLength(): number

• Get total Curve arc length.

  Returns number

getLengths

• getLengths(divisions?): number[]

• Get list of cumulative segment lengths.

  Parameters

  • Optionaldivisions: 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
  • OptionaloptionalTarget: 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
  • OptionaloptionalTarget: 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 a set of divisions +1 points using .getPoint | getPoint(t).

  Parameters

  • Optionaldivisions: number

    Number of pieces to divide the Curve into. Expects a Integer. Default 5

  Returns T[]

getSpacedPoints

• getSpacedPoints(divisions?): T[]

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

  Parameters

  • Optionaldivisions: number

    Number of pieces to divide the Curve into. Expects a Integer. Default 5

  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
  • OptionaloptionalTarget: 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
  • OptionaloptionalTarget: 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.