kite3d/io.github.yuroyami.kite3d.math/Plane

Plane

class Plane(val normal: Vector3 = Vector3(1.0, 0.0, 0.0), var constant: Double = 0.0)

A two dimensional surface that extends infinitely in 3D space, represented in Hessian normal form by a unit length normal vector and a constant.

The plane is mutable and not thread-safe. Use each instance from one thread only.

The constructor stores the given normal by reference (it does not copy it). Sharing that vector with another object means later mutations are visible through every alias; use set/setComponents or clone for independent storage.

Constructors

Plane

constructor(normal: Vector3 = Vector3(1.0, 0.0, 0.0), constant: Double = 0.0)

Properties

constant

var constant: Double

The signed distance from the origin to the plane.

normal

val normal: Vector3

A unit length vector defining the normal of the plane.

Functions

applyMatrix4

fun applyMatrix4(matrix: Matrix4, optionalNormalMatrix: Matrix3? = null): Plane

Applies a 4x4 matrix matrix to the plane. The matrix must be an affine, homogeneous transform.

clone

fun clone(): Plane

Returns a new plane with copied values from this instance.

coplanarPoint

fun coplanarPoint(target: Vector3): Vector3

Writes the point on the plane closest to the origin into target. Assumes a unit-length normal.

copy

fun copy(plane: Plane): Plane

Copies the values of the given plane plane to this instance.

distanceToPoint

fun distanceToPoint(point: Vector3): Double

Returns the signed distance from the given point to this plane.

distanceToSphere

fun distanceToSphere(sphere: Sphere): Double

Returns the signed distance from the given sphere to this plane.

equals

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

Structural equality: true when other is a Plane with an equal normal (via Vector3.equals) and an equal constant (primitive ==, so NaN != NaN).

hashCode

open override fun hashCode(): Int

intersectLine

fun intersectLine(line: Line3, target: Vector3, clampToLine: Boolean = true): Vector3?

Writes the intersection point of the passed line and the plane into target. Returns null if the line does not intersect. Returns the line's starting point if the line is coplanar with the plane.

intersectsBox

fun intersectsBox(box: Box3): Boolean

Returns true if the given bounding box box intersects with the plane.

intersectsLine

fun intersectsLine(line: Line3): Boolean

Returns true if the given line segment line intersects with (passes through) the plane.

intersectsSphere

fun intersectsSphere(sphere: Sphere): Boolean

Returns true if the given bounding sphere sphere intersects with the plane.

negate

fun negate(): Plane

Negates both the plane normal and the constant.

normalize

fun normalize(): Plane

Normalizes the plane normal and adjusts the constant accordingly.

projectPoint

fun projectPoint(point: Vector3, target: Vector3): Vector3

Projects the given point onto the plane, writing the result into target.

set

fun set(normal: Vector3, constant: Double): Plane

Sets the plane components by copying the given values.

setComponents

fun setComponents(x: Double, y: Double, z: Double, w: Double): Plane

Sets the plane components by defining x, y, z as the plane normal and w as the constant.

setFromCoplanarPoints

fun setFromCoplanarPoints(a: Vector3, b: Vector3, c: Vector3): Plane

Sets the plane from three coplanar points a, b, c. The winding order is assumed to be counter-clockwise, and determines the direction of the plane normal.

setFromNormalAndCoplanarPoint

fun setFromNormalAndCoplanarPoint(normal: Vector3, point: Vector3): Plane

Sets the plane from the given normal and coplanar point (a point that lies on the plane).

toString

open override fun toString(): String

translate

fun translate(offset: Vector3): Plane

Translates the plane by the distance defined by the given offset vector. Note that this only affects the plane constant and will not affect the normal vector.