kite3d/io.github.yuroyami.kite3d.math/Sphere

Sphere

class Sphere(val center: Vector3 = Vector3(), var radius: Double = -1.0)

An analytical 3D sphere defined by a center and radius. This class is mainly used as a Bounding Sphere for 3D objects.

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

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

A sphere with a negative radius is considered empty (see isEmpty); a radius of 0 contains only the center point and is not empty.

Constructors

Sphere

constructor(center: Vector3 = Vector3(), radius: Double = -1.0)

Properties

center

val center: Vector3

The center of the sphere.

radius

var radius: Double

The radius of the sphere.

Functions

applyMatrix4

fun applyMatrix4(matrix: Matrix4): Sphere

Transforms this sphere with the given 4x4 transformation matrix matrix.

clampPoint

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

Clamps a point within the sphere, writing the result into target. If the point is outside the sphere, it is clamped to the closest point on the edge of the sphere. Points already inside the sphere are not affected.

clone

fun clone(): Sphere

Returns a new sphere with copied values from this instance.

containsPoint

fun containsPoint(point: Vector3): Boolean

Returns true if this sphere contains the given point inclusive of the surface of the sphere.

copy

fun copy(sphere: Sphere): Sphere

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

distanceToPoint

fun distanceToPoint(point: Vector3): Double

Returns the closest distance from the boundary of the sphere to the given point. If the sphere contains the point, the distance will be negative.

equals

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

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

expandByPoint

fun expandByPoint(point: Vector3): Sphere

Expands the boundaries of this sphere to include the given point.

fromJSON

fun fromJSON(json: DoubleArray): Sphere

Sets this sphere from json laid out as [centerX, centerY, centerZ, radius].

getBoundingBox

fun getBoundingBox(target: Box3): Box3

Writes a bounding box that encloses this sphere into target.

hashCode

open override fun hashCode(): Int

intersectsBox

fun intersectsBox(box: Box3): Boolean

Returns true if this sphere intersects with the given box.

intersectsPlane

fun intersectsPlane(plane: Plane): Boolean

Returns true if this sphere intersects with the given plane.

intersectsSphere

fun intersectsSphere(sphere: Sphere): Boolean

Returns true if this sphere intersects with the given one sphere.

isEmpty

fun isEmpty(): Boolean

Returns true if the sphere is empty (the radius set to a negative number).

makeEmpty

fun makeEmpty(): Sphere

Makes this sphere empty which means it encloses a zero space in 3D.

set

fun set(center: Vector3, radius: Double): Sphere

Sets the sphere's components by copying the given values.

setFromPoints

fun setFromPoints(points: List<Vector3>, optionalCenter: Vector3? = null): Sphere

Computes a bounding sphere for points. The center is optionalCenter when given, otherwise the center of the points' bounding box. The radius reaches the farthest point, so this is not always the smallest possible sphere.

toJSON

fun toJSON(): DoubleArray

Returns this sphere as [centerX, centerY, centerZ, radius]. three.js returns an object with center and radius fields instead.

toString

open override fun toString(): String

translate

fun translate(offset: Vector3): Sphere

Translates the sphere's center by the given offset.

union

fun union(sphere: Sphere): Sphere

Expands this sphere to enclose both the original sphere and the given sphere.