math/ktx.math/ImmutableVector2

ImmutableVector2

data class ImmutableVector2(val x: Float, val y: Float) : ImmutableVector<ImmutableVector2>

Represent an immutable vector 2D

You may use ImmutableVector2.toMutable to create a (mutable) Vector2 from a an ImmutableVector2. And an ImmutableVector2 can be created from a Vector2 with Vector2.toImmutable.

Constructors

ImmutableVector2

constructor(x: Float, y: Float)

Types

object Companion

Properties

open val len: Float

Returns the euclidean length

open override val len2: Float

Returns the squared euclidean length

open override val nor: ImmutableVector2

Returns the unit vector of same direction or this vector if it is zero.

val x: Float

the x-component of this vector

val y: Float

the y-component of this vector

Functions

open fun ~~add~~(v: ImmutableVector2): ImmutableVector2

inline fun ~~angle~~(reference: ImmutableVector2 = X): Float

inline fun ImmutableVector2.angleDeg(reference: ImmutableVector2 = ImmutableVector2.X): Float

Returns the angle in degrees of this vector relative to the reference. Angles are towards the positive y-axis (typically counter-clockwise.) between -180 and +180

inline fun ImmutableVector2.angleDeg(referenceX: Float, referenceY: Float): Float

Returns the angle in degrees of this vector relative to the reference vector described by referenceX and referenceY.

fun angleRad(reference: ImmutableVector2 = X): Float

Returns the angle in radians of this vector relative to the reference. Angles are towards the positive y-axis. (typically counter-clockwise)

fun angleRad(referenceX: Float, referenceY: Float): Float

Returns the angle in radians of this vector relative to the (referenceX, referenceY) reference. Angles are towards the positive y-axis. (typically counter-clockwise)

open fun ~~clamp~~(min: Float, max: Float): ImmutableVector2

open operator override fun compareTo(other: ImmutableVector2): Int

fun ~~cpy~~(): ImmutableVector2

fun crs(otherX: Float, otherY: Float): Float

Calculates the 2D cross product between this and the (otherX, otherY) vector

infix inline fun ImmutableVector2.crs(other: ImmutableVector2): Float

Calculates the 2D cross product between this and the other vector

open operator override fun dec(): ImmutableVector2

Returns a new vector instance with all members decremented by 1

open infix override fun dot(vector: ImmutableVector2): Float

Returns the dot product of this vector by the given vector

fun dot(otherX: Float, otherY: Float): Float

Returns the dot product of this vector by the given (otherX, otherY) vector

fun dst(otherX: Float, otherY: Float): Float

open infix override fun dst2(vector: ImmutableVector2): Float

Returns the squared distance between this and the other vector

fun dst2(otherX: Float, otherY: Float): Float

Returns the squared distance between this and the (otherX, otherY) vector

open override fun epsilonEquals(other: ImmutableVector2, epsilon: Float): Boolean

Compares this vector with the other vector, using the supplied epsilon for fuzzy equality testing

fun epsilonEquals(otherX: Float, otherY: Float, epsilon: Float): Boolean

Compares this vector with the (otherX, otherY) vector, using the supplied epsilon for fuzzy equality testing

open operator override fun inc(): ImmutableVector2

Returns a new vector instance with all members incremented by 1

open fun ~~interpolate~~(target: ImmutableVector2, alpha: Float, interpolator: Interpolation): ImmutableVector2

open override fun isOnLine(other: ImmutableVector2, epsilon: Float): Boolean

Returns true if this vector is on-line with the other vector (either in the same or the opposite direction)

open fun isUnit(margin: Float = MathUtils.FLOAT_ROUNDING_ERROR): Boolean

Returns whether this vector is a unit length vector within the given margin. (no margin by default)

open override fun isZero(margin: Float): Boolean

Returns whether the length of this vector is smaller than the given margin

open fun ~~lerp~~(target: ImmutableVector2, alpha: Float): ImmutableVector2

open fun ~~limit~~(limit: Float): ImmutableVector2

open fun ~~limit2~~(limit2: Float): ImmutableVector2

open operator override fun minus(other: ImmutableVector2): ImmutableVector2

Returns the result of subtracting the other vector from this vector

fun minus(deltaX: Float = 0.0f, deltaY: Float = 0.0f): ImmutableVector2

Returns the result of subtracting the (deltaX, deltaY) vector from this vector

fun ~~mul~~(matrix: Matrix3): ImmutableVector2

open fun ~~mulAdd~~(v: ImmutableVector2, scalar: Float): ImmutableVector2

open fun ~~mulAdd~~(v: ImmutableVector2, mulVec: ImmutableVector2): ImmutableVector2

open fun ~~nor~~(): ImmutableVector2

open operator override fun plus(other: ImmutableVector2): ImmutableVector2

Returns the result of adding the other vector to this vector

fun plus(deltaX: Float = 0.0f, deltaY: Float = 0.0f): ImmutableVector2

Returns the result of adding the given (deltaX, deltaY) vector to this vector

inline fun ~~rotate~~(angle: Float): ImmutableVector2

open fun ~~scl~~(scalar: Float): ImmutableVector2

open fun ~~scl~~(v: ImmutableVector2): ImmutableVector2

open fun ~~set~~(v: ImmutableVector2): ImmutableVector2

open fun ~~setLength~~(len: Float): ImmutableVector2

open fun ~~setLength2~~(len2: Float): ImmutableVector2

setToRandomDirection

open fun ~~setToRandomDirection~~(): ImmutableVector2

fun ~~setZero~~(): ImmutableVector2

open fun ~~sub~~(v: ImmutableVector2): ImmutableVector2

operator fun times(transformation: Affine2): ImmutableVector2

Apply the given affine transformation and return the resulting vector

open operator override fun times(scalar: Float): ImmutableVector2

Returns a new vector instance scaled by the given scalar

open operator override fun times(vector: ImmutableVector2): ImmutableVector2

Returns a new vector instance scaled by the given vector

fun times(factorX: Float, factorY: Float): ImmutableVector2

Returns a new vector instance scaled by the given factorX and factorY factors

inline fun ImmutableVector2.toMutable(): Vector2

open override fun toString(): String

open operator override fun unaryMinus(): ImmutableVector2

Returns the opposite vector of same length

inline fun ImmutableVector2.withAngleDeg(angle: Float): ImmutableVector2

Returns a vector of same length with the given angle in degree

fun withAngleRad(angle: Float): ImmutableVector2

Returns a vector of same length with the given angle in radians

open fun withClamp(min: Float, max: Float): ImmutableVector2

Returns a vector of same direction and the length clamped between min and max

open override fun withClamp2(min2: Float, max2: Float): ImmutableVector2

Returns a vector of same direction and the squared length clamped between min2 and max2

withInterpolation

open fun withInterpolation(target: ImmutableVector2, alpha: Float, interpolation: Interpolation): ImmutableVector2

Returns the result of interpolation between this vector and the given target vector by alpha (within range 0,1) using the given interpolation method.

open fun withLength(length: Float): ImmutableVector2

Returns a vector of same direction and the given length

open override fun withLength2(length2: Float): ImmutableVector2

Returns a vector of the same direction and a squared length of length2

open override fun withLerp(target: ImmutableVector2, alpha: Float): ImmutableVector2

Linearly interpolates between this vector and the target vector by alpha

open fun withLimit(limit: Float): ImmutableVector2

Returns this vector if the ImmutableVector.len is <= limit or a vector with the same direction and length limit otherwise

open override fun withLimit2(limit2: Float): ImmutableVector2

Returns this vector if the ImmutableVector.len2 is <= limit2 or a vector with the same direction and length limit2 otherwise

withRandomDirection

open override fun withRandomDirection(rng: Random): ImmutableVector2

Returns a vector of same length and a random direction.

fun withRotation90(direction: Int): ImmutableVector2

Returns a vector of same length rotated by 90 degrees in the given direction

withRotationDeg

inline fun ImmutableVector2.withRotationDeg(angle: Float): ImmutableVector2

Returns a vector of same length rotated by the given angle in degree

withRotationRad

fun withRotationRad(angle: Float): ImmutableVector2

Returns a vector of same length rotated by the given angle in radians

infix inline fun ImmutableVector2.x(other: ImmutableVector2): Float

Calculates the 2D cross product between this and the other vector