openrndr-math/org.openrndr.math/Vector2

Vector2

@Serializable

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

A 2D vector representation in Cartesian coordinates with methods for mathematical operations and conversions. Implements linear algebra functionalities and provides utility methods for creating and manipulating 2D vectors.

Constructors

Vector2

constructor(x: Double)

constructor(x: Double, y: Double)

Types

Axis

enum Axis : Enum<Vector2.Axis>

Represents an axis in 2D space. Each axis is associated with a unit vector defining its direction.

Companion

object Companion

Properties

length

open override val length: Double

The Euclidean length of the vector.

normalized

open val normalized: Vector2

normalized vector

squaredLength

open override val squaredLength: Double

The squared Euclidean length of the vector.

val x: Double

The x-coordinate of the vector.

val xx: Vector2

val xy0: Vector3

val xy00: Vector4

val xy01: Vector4

val xy1: Vector3

val y: Double

The y-coordinate of the vector.

val yx: Vector2

val yy: Vector2

zero

open override val zero: Vector2

returns the zero vector

Functions

areaBetween

open override fun areaBetween(other: Vector2): Double

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

atan2

open fun atan2(other: Vector2): Double

atan2 style angle between this and other

clamp

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

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

cross

infix fun cross(right: Vector2): Double

Calculates a cross product between this Vector2 and right.

distanceTo

open override fun distanceTo(other: Vector2): Double

Calculates the Euclidean distance to other.

div

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

Divides the current object by the given scale factor.

operator fun div(d: Vector2): Vector2

dot

open infix override fun dot(right: Vector2): 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): Vector2

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

map

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

minus

operator fun minus(d: Double): Vector2

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

Subtracts the specified value from the current value.

mix

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

Interpolates between the current vector and the given vector o by the specified mixing factor.

mod

fun Vector2.mod(b: Vector2): Vector2

perpendicular

fun perpendicular(polarity: YPolarity = YPolarity.CW_NEGATIVE_Y): Vector2

Calculates a vector perpendicular to the current one.

plus

operator fun plus(d: Double): Vector2

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

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

projectedOn

open infix fun projectedOn(on: Vector2): Vector2

project this vector on on

reflect

infix fun reflect(surfaceNormal: Vector2): Vector2

reflectedOver

open infix fun reflectedOver(surfaceNormal: Vector2): Vector2

reflect this vector over surfaceNormal

rotate

fun rotate(degrees: Double, origin: Vector2 = ZERO): Vector2

Creates a new Vector2 with the given rotation and origin.

saturate

fun Vector2.saturate(): Vector2

smoothstep

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

squaredDistanceTo

open override fun squaredDistanceTo(other: Vector2): Double

Calculates the squared Euclidean distance to other.

times

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

Multiplies the current instance by the specified scalar value.

operator fun times(v: Vector2): Vector2

toDoubleArray

fun toDoubleArray(): DoubleArray

Casts to DoubleArray.

toInt

fun toInt(): IntVector2

Casts to IntVector2.

unaryMinus

operator fun unaryMinus(): Vector2

vector3

fun vector3(x: Double = this.x, y: Double = this.y, z: Double = 0.0): Vector3

Upcasts to Vector3.

vector4

fun vector4(x: Double = this.x, y: Double = this.y, z: Double = 0.0, w: Double = 0.0): Vector4

Upcasts to Vector4.