api/org.kryptonmc.api.util/Vec3d

Vec3d

@JvmRecord

data class Vec3d(val x: Double, val y: Double, val z: Double) : Record, Comparable<Vec3d>

A double vector with an X, Y, and Z component.

Constructors

Vec3d

constructor(x: Double, y: Double, z: Double)

Types

Companion

object Companion

Functions

abs

fun abs(): Vec3d

Returns a vector with the absolute values of the components of this vector.

add

fun add(amount: Double): Vec3d

Adds the given amount to this vector and returns the result.

fun add(other: Vec3d): Vec3d

fun add(other: Vec3i): Vec3d

Adds the given other vector to this vector and returns the result.

fun add(x: Double, y: Double, z: Double): Vec3d

Adds the given x, y, and z values to this vector and returns the result.

asPosition

fun asPosition(): Position

Converts this double vector to an equivalent position.

asVec3i

fun asVec3i(): Vec3i

Converts this double vector to an equivalent integer vector.

compareTo

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

cross

fun cross(other: Vec3d): Vec3d

Calculates the cross product of this vector and the given other vector.

distance

fun distance(other: Vec3d): Double

fun distance(other: Vec3i): Double

Calculates the distance between this vector and the given other vector.

fun distance(x: Double, y: Double, z: Double): Double

Calculates the distance between this vector and the given x, y, and z values.

distanceSquared

fun distanceSquared(other: Vec3d): Double

fun distanceSquared(other: Vec3i): Double

Calculates the squared distance between this vector and the given other vector.

fun distanceSquared(x: Double, y: Double, z: Double): Double

Calculates the squared distance between this vector and the given x, y, and z values.

divide

fun divide(factor: Double): Vec3d

Divides this vector by the given factor and returns the result.

fun divide(other: Vec3d): Vec3d

fun divide(other: Vec3i): Vec3d

Divides this vector by the given other vector and returns the result.

fun divide(x: Double, y: Double, z: Double): Vec3d

Divides this vector by the given x, y, and z values and returns the result.

dot

fun dot(other: Vec3d): Double

Calculates the dot product of this vector and the given other vector.

floorX

fun floorX(): Int

Gets the floored X component of this vector.

floorY

fun floorY(): Int

Gets the floored Y component of this vector.

floorZ

fun floorZ(): Int

Gets the floored Z component of this vector.

length

fun length(): Double

Calculates the length of this vector.

lengthSquared

fun lengthSquared(): Double

Computes the length of this vector.

multiply

fun multiply(factor: Double): Vec3d

Multiplies this vector by the given factor and returns the result.

fun multiply(other: Vec3d): Vec3d

fun multiply(other: Vec3i): Vec3d

Multiplies this vector by the given other vector and returns the result.

fun multiply(x: Double, y: Double, z: Double): Vec3d

Multiplies this vector by the given x, y, and z values and returns the result.

negate

fun negate(): Vec3d

Returns a vector with the components of this vector negated.

normalize

fun normalize(): Vec3d

Returns a normalized version of this vector.

subtract

fun subtract(amount: Double): Vec3d

Subtracts the given amount from this vector and returns the result.

fun subtract(other: Vec3d): Vec3d

fun subtract(other: Vec3i): Vec3d

Subtracts the given other vector from this vector and returns the result.

fun subtract(x: Double, y: Double, z: Double): Vec3d

Subtracts the given x, y, and z values from this vector and returns the result.

toString

open override fun toString(): String

withX

fun withX(x: Double): Vec3d

Creates a new vector with the given x component.

withY

fun withY(y: Double): Vec3d

Creates a new vector with the given y component.

withZ

fun withZ(z: Double): Vec3d

Creates a new vector with the given z component.

Properties

val x: Double

The X component of this vector.

val y: Double

The Y component of this vector.

val z: Double

The Z component of this vector.