kite3d/io.github.yuroyami.kite3d.math/Line3

Line3

class Line3(val start: Vector3 = Vector3(), val end: Vector3 = Vector3())

An analytical line segment in 3D space represented by a start and end point.

The segment is mutable and not thread-safe; confine an instance (and any object graph holding it) to a single thread, exactly as in three.js.

The constructor stores the given vectors by reference (it does not copy them). Passing the same vector as both endpoints, or sharing a vector with another object, means later mutations are visible through every alias. Use set or clone when you need independent storage.

Constructors

Line3

constructor(start: Vector3 = Vector3(), end: Vector3 = Vector3())

Properties

end

val end: Vector3

End of the line segment.

start

val start: Vector3

Start of the line segment.

Functions

applyMatrix4

fun applyMatrix4(matrix: Matrix4): Line3

Applies a 4x4 transformation matrix matrix to this line segment.

fun at(t: Double, target: Vector3): Vector3

Writes a point at position t (in [0,1]) along the line segment into target.

clone

fun clone(): Line3

Returns a new line segment with copied values from this instance.

closestPointToPoint

fun closestPointToPoint(point: Vector3, clampToLine: Boolean, target: Vector3): Vector3

Writes the closest point on the line for a given point into target.

closestPointToPointParameter

fun closestPointToPointParameter(point: Vector3, clampToLine: Boolean): Double

Returns a point parameter based on the closest point as projected on the line segment.

copy

fun copy(line: Line3): Line3

Copies the values of the given line segment line to this instance.

delta

fun delta(target: Vector3): Vector3

Writes the delta vector of the line segment's start and end point into target.

distance

fun distance(): Double

Returns the Euclidean distance between the line's start and end point.

distanceSq

fun distanceSq(): Double

Returns the squared Euclidean distance between the line's start and end point.

distanceSqToLine3

fun distanceSqToLine3(line: Line3, c1: Vector3 = Vector3(), c2: Vector3 = Vector3()): Double

Returns the closest squared distance between this line segment and the given one line. When provided, writes the closest point on this segment into c1 and the closest point on line into c2.

equals

open operator override fun equals(other: Any?): Boolean

Structural equality: true when other is a Line3 with equal start and end (each compared via Vector3.equals, so NaN != NaN).

getCenter

fun getCenter(target: Vector3): Vector3

Writes the center of the line segment into target.

hashCode

open override fun hashCode(): Int

set

fun set(start: Vector3, end: Vector3): Line3

Sets the start and end values by copying the given vectors.

toString

open override fun toString(): String