foundation/com.pico.spatial.core.math/Vector2

Vector2

class Vector2

Represents a vector2.

Constructors

Vector2

constructor(x: Float, y: Float)

Creates a new Vector2 instance with the specified x, y components.

constructor(value: Float)

Initializes a Vector2 instance with a single float value.

constructor(other: Vector2)

Initializes a Vector2 instance from another Vector2 instance.

constructor(other: Vector3)

Initializes a Vector2 instance from a Vector3 instance's x and y.

Types

Companion

object Companion

The companion object of Vector2.

Properties

val x: Float

The x position of the Vector2.

val y: Float

The x position of the Vector2.

Functions

dec

operator fun dec(): Vector2

Overloads the unary decrement operator (--).

div

operator fun div(other: Vector2): Vector2

Divides this Vector2 instance by another Vector2 instance.

operator fun div(scalar: Float): Vector2

Divides this Vector2 instance by a scalar.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

inc

operator fun inc(): Vector2

Overloads the unary increment operator (++).

isFinite

fun isFinite(): Boolean

Checks if the value of the Vector2 instance is finite.

length

fun length(): Float

Gets the length of the Vector2 instance.

minus

operator fun minus(other: Vector2): Vector2

Subtracts another Vector2 instance from this Vector2 instance.

normalize

fun normalize(): Vector2

Normalizes the Vector2 instance.

plus

operator fun plus(other: Vector2): Vector2

Adds another Vector2 instance to this Vector2 instance.

times

operator fun times(other: Vector2): Vector2

Multiplies this Vector2 instance by another Vector2 instance.

operator fun times(scalar: Float): Vector2

Multiplies this Vector2 instance by a scalar.

toString

open override fun toString(): String

unaryMinus

operator fun unaryMinus(): Vector2

Returns the negation of this Vector2 instance, changing (x, y) to (-x, -y).