glimpse-core/graphics.glimpse.types/Vec3

Vec3

data class Vec3<T : Number, Comparable<T>>(val x: T, val y: T, val z: T, val type: KClass<T>) : Vec<T>

3D vector with coordinates (x, y, z).

Can also be used to specify RGB color values.

Constructors

Vec3

constructor(x: T, y: T, z: T, type: KClass<T>)

Types

Companion

object Companion

Functions

cross

infix fun cross(other: Vec3<T>): Vec3<T>

Calculates cross product of this vector and the other vector.

div

operator fun div(number: T): Vec3<T>

Divides this vector by the specified number.

dot

infix fun dot(other: Vec3<T>): T

Calculates dot product of this vector and the other vector.

magnitude

fun magnitude(): T

Returns the magnitude of this vector.

minus

operator fun minus(other: Vec3<T>): Vec3<T>

Subtracts the other vector from this vector.

normalize

fun normalize(): Vec3<T>

Returns a unit vector in the direction of this vector.

plus

operator fun plus(other: Vec3<T>): Vec3<T>

Adds the other vector to this vector.

times

operator fun times(number: T): Vec3<T>

Multiplies this vector by the specified number.

toColor

fun Vec3<Float>.toColor(): Color

Returns a Compose Color representation of this Vec3.

toColorInt

@ColorInt

fun Vec3<Float>.toColorInt(): Int

Returns a color int representation of this Vec3.

toDoubleArray

fun Vec3<Double>.toDoubleArray(): DoubleArray

Returns an array of coordinates of this vector.

toDoubleVector

fun toDoubleVector(): Vec3<Double>

Returns a 3D double-precision float vector equal to this vector.

toFloatArray

fun Vec3<Float>.toFloatArray(): FloatArray

Returns an array of coordinates of this vector.

toFloatVector

fun toFloatVector(): Vec3<Float>

Returns a 3D float vector equal to this vector.

toIntArray

fun Vec3<Int>.toIntArray(): IntArray

Returns an array of coordinates of this vector.

toIntVector

fun toIntVector(): Vec3<Int>

Returns a 3D integer vector equal to this vector.

toList

open override fun toList(): List<T>

Returns a list of coordinates of this vector.

toLongArray

fun Vec3<Long>.toLongArray(): LongArray

Returns an array of coordinates of this vector.

toLongVector

fun toLongVector(): Vec3<Long>

Returns a 3D long integer vector equal to this vector.

toRationalForm

fun toRationalForm(): Vec4<T>

Returns a 4D vector which is a rational form of this 3D vector.

toVec2

fun toVec2(): Vec2<T>

Returns a 2D vector with x and y coordinates of this vector.

toVec4

fun toVec4(w: T = zero(this.type)): Vec4<T>

Returns a 4D vector with x, y and `z coordinates of this vector and the given w coordinate.

unaryMinus

operator fun unaryMinus(): Vec3<T>

Returns a vector opposite to this vector.

unaryPlus

operator fun unaryPlus(): Vec3<T>

Returns this vector.

Properties

val b: T

Blue channel of RGB color.

val g: T

Green channel of RGB color.

val r: T

Red channel of RGB color.

type

val type: KClass<T>

Type of vector coordinates.

val x: T

X coordinate of this vector.

val y: T

Y coordinate of this vector.

val z: T

Z coordinate of this vector.