openrndr-math/org.openrndr.math/Vector3

Vector3

@Serializable

data class Vector3(val x: Double, val y: Double, val z: Double) : LinearType<Vector3> , EuclideanVector<Vector3> (source)

Double-precision 3D vector.

Constructors

Vector3

constructor(x: Double)

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

Types

Axis

enum Axis : Enum<Vector3.Axis>

Companion

object Companion

Properties

length

open override val length: Double

The Euclidean length of the vector.

normalized

open val normalized: Vector3

normalized vector

spherical

val spherical: Spherical

squaredLength

open override val squaredLength: Double

The squared Euclidean length of the vector.

val x: Double

val xy: Vector2

xyz0

val xyz0: Vector4

xyz1

val xyz1: Vector4

val xz: Vector2

val y: Double

val yx: Vector2

val z: Double

zero

open override val zero: Vector3

returns the zero vector

val zx: Vector2

Functions

areaBetween

open fun areaBetween(other: Vector3): Double

returns the area of the parallelogram formed by extruding this over other

atan2

open fun atan2(other: Vector3): Double

atan2 style angle between this and other

clamp

fun Vector3.clamp(min: Vector3, max: Vector3): Vector3

Returns Vector3 whose value is limited between min and max per vector component.

cross

infix fun cross(v: Vector3): Vector3

Calculates a cross product between this Vector2 and v.

distanceTo

open override fun distanceTo(other: Vector3): Double

distance to other in Euclidean space

div

open operator override fun div(scale: Double): Vector3

Divides the current object by the given scale factor.

operator fun div(v: Vector3): Vector3

dot

open infix override fun dot(right: Vector3): Double

Calculates a dot product between this Vector2 and right.

get

operator fun get(i: Int): Double

map

open override fun map(function: (Double) -> Double): Vector3

Applies a given function to each component of the vector and returns a new vector with the transformed components.

map

fun Vector3.map(beforeLeft: Vector3, beforeRight: Vector3, afterLeft: Vector3, afterRight: Vector3, clamp: Boolean = false): Vector3

minus

operator fun minus(d: Double): Vector3

open operator override fun minus(right: Vector3): Vector3

Subtracts the specified value from the current value.

mix

fun mix(o: Vector3, mix: Double): Vector3

mod

fun Vector3.mod(b: Vector3): Vector3

plus

operator fun plus(d: Double): Vector3

open operator override fun plus(right: Vector3): Vector3

Adds the given value right to this value and returns the result.

projectedOn

open infix fun projectedOn(on: Vector3): Vector3

project this vector on on

reflectedOver

open infix fun reflectedOver(surfaceNormal: Vector3): Vector3

reflect this vector over surfaceNormal

saturate

fun Vector3.saturate(): Vector3

smoothstep

fun Vector3.smoothstep(edge0: Vector3, edge1: Vector3): Vector3

squaredDistanceTo

open override fun squaredDistanceTo(other: Vector3): Double

squared distance to other in Euclidean space

times

open operator override fun times(scale: Double): Vector3

Multiplies the current instance by the specified scalar value.

operator fun times(v: Vector3): Vector3

toDoubleArray

fun toDoubleArray(): DoubleArray

Casts to DoubleArray.

toInt

fun toInt(): IntVector3

Casts to IntVector3.

unaryMinus

operator fun unaryMinus(): Vector3