ktx.math.vector3.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ktx-math Show documentation
Kotlin utilities for LibGDX math API.
There is a newer version: 1.9.6-b1
package ktx.math

import com.badlogic.gdx.math.Vector2
import com.badlogic.gdx.math.Vector3

/**
 * Constructs a new [Vector3] instance. Basically a "copy" of [Vector3] constructor that supports Kotlin syntax features:
 * named parameters with default values.
 * @param x the X component. Defaults to 0f.
 * @param y the Y component. Defaults to 0f.
 * @param z the Z component. Defaults to 0f.
 * @return a new [Vector3] instance storing the passed values.
 */
fun vec3(x: Float = 0f, y: Float = 0f, z: Float = 0f): Vector3 = Vector3(x, y, z)

/**
 * Inverts currently stored X, Y and Z values.
 * @return this vector for chaining.
 */
operator fun Vector3.unaryMinus(): Vector3 {
  this.x = -this.x
  this.y = -this.y
  this.z = -this.z
  return this
}

/**
 * @param vector3 values from this vector will be added to this vector.
 * @return this vector for chaining.
 */
operator fun Vector3.plus(vector3: Vector3): Vector3 = this.add(vector3)

/**
 * Modifies x and y components of this vector.
 * @param vector2 values from this vector will be added to this vector.
 * @return this vector for chaining.
 */
operator fun Vector3.plus(vector2: Vector2): Vector3 {
  this.x += vector2.x
  this.y += vector2.y
  return this
}

/**
 * @param vector3 values from this vector will be subtracted from this vector.
 * @return this vector for chaining.
 */
operator fun Vector3.minus(vector3: Vector3): Vector3 = this.sub(vector3)


/**
 * Modifies x and y components of this vector.
 * @param vector2 values from this vector will be subtracted from this vector.
 * @return this vector for chaining.
 */
operator fun Vector3.minus(vector2: Vector2): Vector3 {
  this.x -= vector2.x
  this.y -= vector2.y
  return this
}

/**
 * @param vector3 values from this vector will multiply this vector.
 * @return this vector for chaining.
 */
operator fun Vector3.times(vector3: Vector3): Vector3 = this.scl(vector3)

/**
 * @param vector3 values from this vector will divide this vector.
 * @return this vector for chaining.
 */
operator fun Vector3.div(vector3: Vector3): Vector3 {
  this.x /= vector3.x
  this.y /= vector3.y
  this.z /= vector3.z
  return this
}

/**
 * @param scalar will be used to multiply all vector values.
 * @return this vector for chaining.
 */
operator fun Vector3.times(scalar: Float): Vector3 = this.scl(scalar)

/**
 * @param scalar will be used to divide all vector values.
 * @return this vector for chaining.
 */
operator fun Vector3.div(scalar: Float): Vector3 {
  this.x /= scalar
  this.y /= scalar
  this.z /= scalar
  return this
}

/**
 * @param scalar will be used to multiply all vector values.
 * @return this vector for chaining.
 */
operator fun Vector3.times(scalar: Int): Vector3 = this.scl(scalar.toFloat())

/**
 * @param scalar will be used to divide all vector values.
 * @return this vector for chaining.
 */
operator fun Vector3.div(scalar: Int): Vector3 {
  this.x /= scalar
  this.y /= scalar
  this.z /= scalar
  return this
}

/**
 * Increments all vector values - adds 1 to x, y and z. Note that since [Vector3] is mutable and its instances are usually
 * reused, this operation DOES NOT create a new [Vector3] or keep its previous state. That means that both vector++ and
 * ++vector have the same effect and both will modify the internal state of the vector.
 * @return this vector for chaining.
 */
operator fun Vector3.inc(): Vector3 = this.add(1f, 1f, 1f)

/**
 * Decrements all vector values - subtracts 1 from x, y and z. Note that since [Vector3] is mutable and its instances are
 * usually reused, this operation DOES NOT create a new [Vector3] or keep its previous state. That means that both
 * vector-- and --vector have the same effect and both will modify the internal state of the vector.
 * @return this vector for chaining.
 */
operator fun Vector3.dec(): Vector3 = this.sub(1f, 1f, 1f)

/**
 * Operator function that allows to deconstruct this vector.
 * @return X component.
 */
operator fun Vector3.component1(): Float = this.x

/**
 * Operator function that allows to deconstruct this vector.
 * @return Y component.
 */
operator fun Vector3.component2(): Float = this.y

/**
 * Operator function that allows to deconstruct this vector.
 * @return Z component.
 */
operator fun Vector3.component3(): Float = this.z

/**
 * Allows to compare which [Vector3] has greater overall length.
 * @param vector3 will be compared to this vector.
 * @return 1 if this vector has greater length. 0 if vectors are equal. -1 if the other vector is greater.
 */
operator fun Vector3.compareTo(vector3: Vector3): Int = this.len2().compareTo(vector3.len2())