low-alloc-math/com.sztorm.lowallocmath/Vector2F

Vector2F

@JvmInline

value class Vector2F

Represents a vector of two single-precision 32-bit IEEE 754 floating point numbers.

On the JVM, non-nullable values of this type are represented as values of the primitive type long.

Constructors

Vector2F

constructor(x: Float, y: Float)

Constructs a new vector with given x and y components.

Types

Companion

object Companion

Functions

coerceAtLeast

inline fun coerceAtLeast(minimum: Vector2F): Vector2F

Returns a vector composed of x and y components that are not less than the specified minimum components.

coerceAtMost

inline fun coerceAtMost(maximum: Vector2F): Vector2F

Returns a vector composed of x and y components that are not greater than the specified maximum components.

coerceIn

inline fun coerceIn(minimum: Vector2F, maximum: Vector2F): Vector2F

Returns a vector composed of x and y components coerced to specified range of minimum..maximum.

component1

inline operator fun component1(): Float

First component of the vector.

component2

inline operator fun component2(): Float

Second component of the vector.

distanceTo

inline fun distanceTo(other: Vector2F): Float

Returns the distance from this vector to the other.

div

inline operator fun div(other: Vector2F): Vector2F

Divides this vector by the other vector component-wise.

inline operator fun div(other: Float): Vector2F

Divides this vector by the other scalar.

dot

infix inline fun dot(other: Vector2F): Float

Returns the dot product of this and other vector.

get

inline operator fun get(index: Int): Float

Returns a component specified by an index.

isApproximately

inline fun isApproximately(other: Vector2F, epsilon: Float = 1.0E-5f): Boolean

Returns a value indicating whether this vector is approximately the other vector given the specified epsilon tolerance.

minus

inline operator fun minus(other: Vector2F): Vector2F

Subtracts the other vector from this vector.

plus

inline operator fun plus(other: Vector2F): Vector2F

Adds the other vector to this vector.

squaredDistanceTo

inline fun squaredDistanceTo(other: Vector2F): Float

Returns the squared distance from this vector to the other.

times

inline operator fun times(other: Vector2F): Vector2F

Multiplies this vector by the other vector component-wise.

inline operator fun times(other: Float): Vector2F

Multiplies this vector by the other scalar.

toString

open override fun toString(): String

Returns a String representation of this vector in "Vector2F(x=x, y=y)" format.

toVector2I

inline fun toVector2I(): Vector2I

Converts this Vector2F value to Vector2I.

unaryMinus

inline operator fun unaryMinus(): Vector2F

Returns the negative of this vector.

unaryPlus

inline operator fun unaryPlus(): Vector2F

Returns this vector.

Properties

magnitude

val magnitude: Float

Returns the magnitude (length) of this vector.

normalized

val normalized: Vector2F

Returns a normalized copy of this vector if this vector magnitude is large enough to safely normalize. Else returns ZERO.

squaredMagnitude

val squaredMagnitude: Float

Returns the squared magnitude of this vector.

val x: Float

First component of the vector.

val xx: Vector2F

Returns a vector composed of two x components of this vector.

val xy: Vector2F

Returns a vector composed of x and y components of this vector, respectively.

val y: Float

Second component of the vector.

val yx: Vector2F

Returns vector composed of y and x components of this vector, respectively.

val yy: Vector2F

Returns a vector composed of two y components of this vector.