kite3d/io.github.yuroyami.kite3d.math/Spherical

Spherical

class Spherical(var radius: Double = 1.0, var phi: Double = 0.0, var theta: Double = 0.0)

Represents points in 3D space as spherical coordinates.

Instances are mutable and not thread-safe; confine an instance to a single thread, exactly as in three.js.

Parameters

radius

The radius, or the Euclidean distance (straight-line distance) from the point to the origin.

phi

The polar angle in radians from the y (up) axis.

theta

The equator/azimuthal angle in radians around the y (up) axis.

Constructors

Spherical

constructor(radius: Double = 1.0, phi: Double = 0.0, theta: Double = 0.0)

Properties

phi

var phi: Double

The polar angle in radians from the y (up) axis.

radius

var radius: Double

The radius, or the Euclidean distance (straight-line distance) from the point to the origin.

theta

var theta: Double

The equator/azimuthal angle in radians around the y (up) axis.

Functions

clone

fun clone(): Spherical

Returns a new spherical with copied values from this instance.

copy

fun copy(other: Spherical): Spherical

Copies the values of the given spherical to this instance.

equals

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

Structural equality: true when other is a Spherical with equal components (component-wise ==, so NaN != NaN).

hashCode

open override fun hashCode(): Int

makeSafe

fun makeSafe(): Spherical

Restricts the polar angle phi to be between 0.000001 and PI - 0.000001.

set

fun set(radius: Double, phi: Double, theta: Double): Spherical

Sets the spherical components by copying the given values.

setFromCartesianCoords

fun setFromCartesianCoords(x: Double, y: Double, z: Double): Spherical

Sets the spherical components from the given Cartesian coordinates.

setFromVector3

fun setFromVector3(v: Vector3): Spherical

Sets the spherical components from the given vector which is assumed to hold Cartesian coordinates.

toString

open override fun toString(): String