Header menu logo Nu

Vector2 Module

Functions and values

Function or value Description

v2 x y

Full Usage: v2 x y

Parameters:
    x : float32
    y : float32

Returns: Vector2
Modifiers: inline
x : float32
y : float32
Returns: Vector2

v2Down

Full Usage: v2Down

Returns: Vector2
Returns: Vector2

v2Dup a

Full Usage: v2Dup a

Parameters:
    a : single

Returns: Vector2
Modifiers: inline
a : single
Returns: Vector2

v2Eq v v2

Full Usage: v2Eq v v2

Parameters:
Returns: bool
Modifiers: inline
v : Vector2
v2 : Vector2
Returns: bool

v2EqApprox v v2 epsilon

Full Usage: v2EqApprox v v2 epsilon

Parameters:
Returns: bool
v : Vector2
v2 : Vector2
epsilon : float32
Returns: bool

v2Left

Full Usage: v2Left

Returns: Vector2
Returns: Vector2

v2Neq v v2

Full Usage: v2Neq v v2

Parameters:
Returns: bool
Modifiers: inline
v : Vector2
v2 : Vector2
Returns: bool

v2NeqApprox v v2 epsilon

Full Usage: v2NeqApprox v v2 epsilon

Parameters:
Returns: bool
Modifiers: inline
v : Vector2
v2 : Vector2
epsilon : float32
Returns: bool

v2One

Full Usage: v2One

Returns: Vector2
Returns: Vector2

v2Right

Full Usage: v2Right

Returns: Vector2
Returns: Vector2

v2UnitX

Full Usage: v2UnitX

Returns: Vector2
Returns: Vector2

v2UnitY

Full Usage: v2UnitY

Returns: Vector2
Returns: Vector2

v2Up

Full Usage: v2Up

Returns: Vector2
Returns: Vector2

v2Zero

Full Usage: v2Zero

Returns: Vector2
Returns: Vector2

Type extensions

Type extension Description

this.Absolute

Full Usage: this.Absolute

Parameters:
    () : unit

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector2

this.Absolute

Full Usage: this.Absolute

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

Returns: Vector2

this.AngleBetween

Full Usage: this.AngleBetween

Parameters:
Returns: float32

Compute angle between vectors.

Extended Type: Vector2

that : Vector2
Returns: float32

this.Distance

Full Usage: this.Distance

Parameters:
Returns: float32
Modifiers: inline

Extended Type: Vector2

that : Vector2
Returns: float32

this.DistanceSquared

Full Usage: this.DistanceSquared

Parameters:
Returns: float32
Modifiers: inline

Extended Type: Vector2

that : Vector2
Returns: float32

this.Dot

Full Usage: this.Dot

Parameters:
Returns: float32
Modifiers: inline

Extended Type: Vector2

that : Vector2
Returns: float32

this.Magnitude

Full Usage: this.Magnitude

Parameters:
    () : unit

Returns: float32
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: float32

this.Magnitude

Full Usage: this.Magnitude

Returns: float32
Modifiers: inline

Extended Type: Vector2

Returns: float32

this.MagnitudeSquared

Full Usage: this.MagnitudeSquared

Parameters:
    () : unit

Returns: float32
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: float32

this.MagnitudeSquared

Full Usage: this.MagnitudeSquared

Returns: float32
Modifiers: inline

Extended Type: Vector2

Returns: float32

this.MapX

Full Usage: this.MapX

Parameters:
    mapper : float32 -> float32

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

mapper : float32 -> float32
Returns: Vector2

this.MapY

Full Usage: this.MapY

Parameters:
    mapper : float32 -> float32

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

mapper : float32 -> float32
Returns: Vector2

Vector2.Modulo(a, b)

Full Usage: Vector2.Modulo(a, b)

Parameters:
Returns: Vector2

Compute modulo of vector components.

Extended Type: Vector2

a : Vector2
b : Vector2
Returns: Vector2

this.Normalized

Full Usage: this.Normalized

Parameters:
    () : unit

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector2

this.Normalized

Full Usage: this.Normalized

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

Returns: Vector2

Vector2.Pow(a, b)

Full Usage: Vector2.Pow(a, b)

Parameters:
Returns: Vector2

Compute power of vector components.

Extended Type: Vector2

a : Vector2
b : Vector2
Returns: Vector2

this.Rotate

Full Usage: this.Rotate

Parameters:
    r : float32

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

r : float32
Returns: Vector2

this.Transform

Full Usage: this.Transform

Parameters:
Returns: Vector2
Modifiers: inline

Extended Type: Vector2

m : Matrix4x4
Returns: Vector2

this.Transform

Full Usage: this.Transform

Parameters:
Returns: Vector2
Modifiers: inline

Extended Type: Vector2

m : Matrix3x2
Returns: Vector2

this.Transform

Full Usage: this.Transform

Parameters:
Returns: Vector2
Modifiers: inline

Extended Type: Vector2

q : Quaternion
Returns: Vector2

this.V2i

Full Usage: this.V2i

Parameters:
    () : unit

Returns: Vector2i
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector2i

this.V2i

Full Usage: this.V2i

Returns: Vector2i
Modifiers: inline

Extended Type: Vector2

Returns: Vector2i

this.V3

Full Usage: this.V3

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector3

this.V3

Full Usage: this.V3

Returns: Vector3
Modifiers: inline

Extended Type: Vector2

Returns: Vector3

this.V3i

Full Usage: this.V3i

Parameters:
    () : unit

Returns: Vector3i
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector3i

this.V3i

Full Usage: this.V3i

Returns: Vector3i
Modifiers: inline

Extended Type: Vector2

Returns: Vector3i

this.V4

Full Usage: this.V4

Parameters:
    () : unit

Returns: Vector4
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector4

this.V4

Full Usage: this.V4

Returns: Vector4
Modifiers: inline

Extended Type: Vector2

Returns: Vector4

this.V4i

Full Usage: this.V4i

Parameters:
    () : unit

Returns: Vector4i
Modifiers: inline

Extended Type: Vector2

() : unit
Returns: Vector4i

this.V4i

Full Usage: this.V4i

Returns: Vector4i
Modifiers: inline

Extended Type: Vector2

Returns: Vector4i

this.WithX

Full Usage: this.WithX

Parameters:
    x : float32

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

x : float32
Returns: Vector2

this.WithY

Full Usage: this.WithY

Parameters:
    y : float32

Returns: Vector2
Modifiers: inline

Extended Type: Vector2

y : float32
Returns: Vector2

Type something to start searching.