kite3d/io.github.yuroyami.kite3d.math/Vector2

Vector2

class Vector2(var x: Double = 0.0, var y: Double = 0.0) : Iterable<Double>

A 2D vector: an ordered pair of numbers (x, y).

Vectors are mutable and not thread-safe; confine an instance (and any object graph holding it) to a single thread, exactly as in three.js. Most methods mutate this and return it for chaining.

Iterating a vector yields its components (x, y) in order.

Constructors

Vector2

constructor(x: Double = 0.0, y: Double = 0.0)

Properties

height

var height: Double

Alias for y.

width

var width: Double

Alias for x.

var x: Double

The x value of this vector.

var y: Double

The y value of this vector.

Functions

add

fun add(v: Vector2): Vector2

Adds v to this instance.

addScalar

fun addScalar(s: Double): Vector2

Adds the scalar s to all components.

addScaledVector

fun addScaledVector(v: Vector2, s: Double): Vector2

Adds v scaled by s to this instance.

addVectors

fun addVectors(a: Vector2, b: Vector2): Vector2

Sets this vector to a + b.

angle

fun angle(): Double

Returns the angle of this vector relative to the positive x-axis, in radians, in [0, 2*PI).

angleTo

fun angleTo(v: Vector2): Double

Returns the angle between this vector and v, in radians.

applyMatrix3

fun applyMatrix3(m: Matrix3): Vector2

Multiplies this vector by the 3x3 matrix m.

ceil

fun ceil(): Vector2

Rounds each component up to the nearest integer.

clamp

fun clamp(min: Vector2, max: Vector2): Vector2

Clamps each component into the range [min, max] (assumed component-wise min <= max).

clampLength

fun clampLength(min: Double, max: Double): Vector2

Clamps this vector's length into [min, max].

clampScalar

fun clampScalar(minVal: Double, maxVal: Double): Vector2

Clamps each component into the scalar range [minVal, maxVal].

clone

fun clone(): Vector2

Returns a new vector with the same components.

copy

fun copy(v: Vector2): Vector2

Copies the components of v into this instance.

cross

fun cross(v: Vector2): Double

Returns the (scalar) cross product of this vector and v.

distanceTo

fun distanceTo(v: Vector2): Double

Returns the distance from this vector to v.

distanceToSquared

fun distanceToSquared(v: Vector2): Double

Returns the squared distance from this vector to v.

divide

fun divide(v: Vector2): Vector2

Divides this instance component-wise by v.

divideScalar

fun divideScalar(scalar: Double): Vector2

Divides all components by scalar.

dot

fun dot(v: Vector2): Double

Returns the dot product of this vector and v.

equals

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

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

floor

fun floor(): Vector2

Rounds each component down to the nearest integer.

fromArray

fun fromArray(array: DoubleArray, offset: Int = 0): Vector2

Sets x = array[offset], y = array[offset + 1].

fromBufferAttribute

fun fromBufferAttribute(attribute: AttributeLike, index: Int): Vector2

Sets this vector's components from attribute at index.

getComponent

fun getComponent(index: Int): Double

Returns the component at index (0 = x, 1 = y).

hashCode

open override fun hashCode(): Int

iterator

open operator override fun iterator(): Iterator<Double>

length

fun length(): Double

Returns the Euclidean length of this vector.

lengthSq

fun lengthSq(): Double

Returns the squared Euclidean length of this vector.

lerp

fun lerp(v: Vector2, alpha: Double): Vector2

Linearly interpolates from this vector toward v by alpha.

lerpVectors

fun lerpVectors(v1: Vector2, v2: Vector2, alpha: Double): Vector2

Sets this vector to the linear interpolation of v1 and v2 by alpha.

manhattanDistanceTo

fun manhattanDistanceTo(v: Vector2): Double

Returns the Manhattan distance from this vector to v.

manhattanLength

fun manhattanLength(): Double

Returns the Manhattan length of this vector.

max

fun max(v: Vector2): Vector2

Sets each component to the maximum of itself and v's corresponding component.

min

fun min(v: Vector2): Vector2

Sets each component to the minimum of itself and v's corresponding component.

multiply

fun multiply(v: Vector2): Vector2

Multiplies this instance component-wise by v.

multiplyScalar

fun multiplyScalar(scalar: Double): Vector2

Multiplies all components by scalar.

negate

fun negate(): Vector2

Negates each component.

normalize

fun normalize(): Vector2

Normalizes this vector to unit length (leaves a zero vector unchanged).

random

fun random(): Vector2

Sets each component to a pseudo-random value in [0, 1).

rotateAround

fun rotateAround(center: Vector2, angle: Double): Vector2

Rotates this vector around center by angle radians.

round

fun round(): Vector2

Rounds each component to the nearest integer (halves toward +infinity, as JS Math.round).

roundToZero

fun roundToZero(): Vector2

Rounds each component toward zero.

set

fun set(x: Double, y: Double): Vector2

Sets the vector components.

setComponent

fun setComponent(index: Int, value: Double): Vector2

Sets the component at index (0 = x, 1 = y) to value.

setLength

fun setLength(length: Double): Vector2

Sets this vector's length to length, preserving direction.

setScalar

fun setScalar(scalar: Double): Vector2

Sets all vector components to scalar.

setX

fun setX(x: Double): Vector2

Sets the vector's x component.

setY

fun setY(y: Double): Vector2

Sets the vector's y component.

sub

fun sub(v: Vector2): Vector2

Subtracts v from this instance.

subScalar

fun subScalar(s: Double): Vector2

Subtracts the scalar s from all components.

subVectors

fun subVectors(a: Vector2, b: Vector2): Vector2

Sets this vector to a - b.

toArray

fun toArray(array: MutableList<Double> = mutableListOf(), offset: Int = 0): MutableList<Double>

Writes this vector's components into array at offset, growing the list as needed, and returns it.

toString

open override fun toString(): String