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

Vector2I

@JvmInline
value class Vector2I

Represents a vector of two 32-bit signed integers.

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

Constructors

Link copied to clipboard
constructor(x: Int, y: Int)

Constructs a new vector with given x and y components.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
inline fun coerceAtLeast(minimum: Vector2I): Vector2I

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

Link copied to clipboard
inline fun coerceAtMost(maximum: Vector2I): Vector2I

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

Link copied to clipboard
inline fun coerceIn(minimum: Vector2I, maximum: Vector2I): Vector2I

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

Link copied to clipboard
inline operator fun component1(): Int

First component of the vector.

Link copied to clipboard
inline operator fun component2(): Int

Second component of the vector.

Link copied to clipboard
inline fun distanceTo(other: Vector2I): Float

Returns the distance from this vector to the other.

Link copied to clipboard
inline operator fun div(other: Vector2I): Vector2I

Divides this vector by the other vector component-wise.

inline operator fun div(other: Int): Vector2I

Divides this vector by the other scalar.

Link copied to clipboard
infix inline fun dot(other: Vector2I): Long

Returns the dot product of this and other vector.

Link copied to clipboard
inline operator fun get(index: Int): Int

Returns a component specified by an index.

Link copied to clipboard
inline operator fun minus(other: Vector2I): Vector2I

Subtracts the other vector from this vector.

Link copied to clipboard
inline operator fun plus(other: Vector2I): Vector2I

Adds the other vector to this vector.

Link copied to clipboard
inline fun squaredDistanceTo(other: Vector2I): Float

Returns the squared distance from this vector to the other.

Link copied to clipboard
inline operator fun times(other: Vector2I): Vector2I

Multiplies this vector by the other vector component-wise.

inline operator fun times(other: Int): Vector2I

Multiplies this vector by the other scalar.

Link copied to clipboard
open override fun toString(): String

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

Link copied to clipboard
inline fun toVector2F(): Vector2F

Converts this Vector2I value to Vector2F.

Link copied to clipboard
inline operator fun unaryMinus(): Vector2I

Returns the negative of this vector.

Link copied to clipboard
inline operator fun unaryPlus(): Vector2I

Returns this vector.

Properties

Link copied to clipboard
val magnitude: Float

Returns the magnitude (length) of this vector.

Link copied to clipboard
val squaredMagnitude: Float

Returns the squared magnitude of this vector.

Link copied to clipboard
val x: Int

First component of the vector.

Link copied to clipboard
val xx: Vector2I

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

Link copied to clipboard
val xy: Vector2I

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

Link copied to clipboard
val y: Int

Second component of the vector.

Link copied to clipboard
val yx: Vector2I

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

Link copied to clipboard
val yy: Vector2I

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