Class Line3

A geometric line segment represented by a start and end point.

Hierarchy

  • Base
    • Line3

Constructors

constructor

Properties

end start

Accessors

isBox2 isBox3 isColor isCylindrical isEuler isLine3 isMatrix3 isMatrix4 isPlane isQuaternion isRay isSphere isSpherical isTriangle isVector2 isVector3 isVector4

Methods

applyMatrix4 at clone closestPointToPoint closestPointToPointParameter copy delta distance distanceSq equals getCenter set

Constructors

constructor

  • Create a new instance.

    Parameters

    • Optional start: Vector3

      Start of the line segment. Default is (0, 0, 0).

    • Optional end: Vector3

      End of the line segment. Default is (0, 0, 0).

    Returns Line3

Properties

end

end: Vector3

start

start: Vector3

Accessors

isBox2

  • get isBox2(): boolean

  • Returns boolean

isBox3

  • get isBox3(): boolean

  • Returns boolean

isColor

  • get isColor(): boolean

  • Returns boolean

isCylindrical

  • get isCylindrical(): boolean

  • Returns boolean

isEuler

  • get isEuler(): boolean

  • Returns boolean

isLine3

  • get isLine3(): boolean

  • Returns boolean

isMatrix3

  • get isMatrix3(): boolean

  • Returns boolean

isMatrix4

  • get isMatrix4(): boolean

  • Returns boolean

isPlane

  • get isPlane(): boolean

  • Returns boolean

isQuaternion

  • get isQuaternion(): boolean

  • Returns boolean

isRay

  • get isRay(): boolean

  • Returns boolean

isSphere

  • get isSphere(): boolean

  • Returns boolean

isSpherical

  • get isSpherical(): boolean

  • Returns boolean

isTriangle

  • get isTriangle(): boolean

  • Returns boolean

isVector2

  • get isVector2(): boolean

  • Returns boolean

isVector3

  • get isVector3(): boolean

  • Returns boolean

isVector4

  • get isVector4(): boolean

  • Returns boolean

Methods

applyMatrix4

  • Applies a matrix transform to the line segment.

    Returns

    This instance.

    Parameters

    Returns Line3

at

  • Compute the scaled position along the line. When t = 0, it returns the start vector. When t = 1 it returns the end vector.

    Returns

    The position on the line.

    Parameters

    • t: number

      Use values 0-1 to return a position along the line segment.

    • Optional target: Vector3

      — the result will be copied into this Vector3.

    Returns Vector3

clone

  • Create a new Line3 with the same start and end vectors as this one.

    Returns

    The new instance.

    Returns Line3

closestPointToPoint

  • Find the closest point on the line. If clampToLine is true, then the returned value will be clamped to the line segment.

    Returns

    The closest point.

    Parameters

    • point: Vector3

      return the closest point on the line to this point.

    • Optional clampToLine: boolean

      whether to clamp the returned value to the line segment.

    • Optional target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

closestPointToPointParameter

  • Compute a point parameter based on the closest point as projected on the line segment. If clampToLine is true, then the returned value will be between 0 and 1.

    Returns

    The scaled proportion.

    Parameters

    • point: Vector3

      the point for which to return a point parameter.

    • Optional clampToLine: boolean

      Whether to clamp the result to the range [0, 1].

    Returns number

copy

  • Copies the passed line's start and end vectors to this line.

    Returns

    This instance.

    Parameters

    Returns Line3

delta

  • Compute the delta vector of the line segment (end vector minus the start vector).

    Returns

    The resulting vector.

    Parameters

    • Optional target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

distance

  • Compute the Euclidean distance (straight-line distance) between the line's start and end points.

    Returns

    The Euclidean distance.

    Returns number

distanceSq

  • Compute the square of the Euclidean distance (straight-line distance) between the line's start and end vectors.

    Returns

    The distance squared.

    Returns number

equals

  • Test for value equality.

    Returns

    True if both line's start and end points are equal.

    Parameters

    • line: Line3

      Line3 to compare with this one.

    Returns boolean

getCenter

  • Compute the center of the line segment.

    Returns

    The center point

    Parameters

    • Optional target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

set

  • Update the start and end values by copying the provided vectors.

    Returns

    This instance.

    Parameters

    • start: Vector3

      set the start point of the line.

    • end: Vector3

      set the end point of the line.

    Returns Line3

Settings

Member Visibility

Theme