Header menu logo Nu

Vector3 Module

Functions and values

Function or value Description

v3 x y z

Full Usage: v3 x y z

Parameters:
    x : float32
    y : float32
    z : float32

Returns: Vector3
Modifiers: inline
x : float32
y : float32
z : float32
Returns: Vector3

v3Back

Full Usage: v3Back

Returns: Vector3
Returns: Vector3

v3Down

Full Usage: v3Down

Returns: Vector3
Returns: Vector3

v3Dup a

Full Usage: v3Dup a

Parameters:
    a : single

Returns: Vector3
Modifiers: inline
a : single
Returns: Vector3

v3Eq v v2

Full Usage: v3Eq v v2

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

v3EqApprox v v2 epsilon

Full Usage: v3EqApprox v v2 epsilon

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

v3Forward

Full Usage: v3Forward

Returns: Vector3
Returns: Vector3

v3Left

Full Usage: v3Left

Returns: Vector3
Returns: Vector3

v3Neq v v2

Full Usage: v3Neq v v2

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

v3NeqApprox v v2 epsilon

Full Usage: v3NeqApprox v v2 epsilon

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

v3One

Full Usage: v3One

Returns: Vector3
Returns: Vector3

v3Right

Full Usage: v3Right

Returns: Vector3
Returns: Vector3

v3UncenteredOffset

Full Usage: v3UncenteredOffset

Returns: Vector3
Returns: Vector3

v3UnitX

Full Usage: v3UnitX

Returns: Vector3
Returns: Vector3

v3UnitY

Full Usage: v3UnitY

Returns: Vector3
Returns: Vector3

v3UnitZ

Full Usage: v3UnitZ

Returns: Vector3
Returns: Vector3

v3Up

Full Usage: v3Up

Returns: Vector3
Returns: Vector3

v3Zero

Full Usage: v3Zero

Returns: Vector3
Returns: Vector3

Type extensions

Type extension Description

this.Absolute

Full Usage: this.Absolute

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector3

this.Absolute

Full Usage: this.Absolute

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

Returns: Vector3

this.AngleBetween

Full Usage: this.AngleBetween

Parameters:
Returns: float32

Compute angle between vectors.

Extended Type: Vector3

that : Vector3
Returns: float32

this.Cross

Full Usage: this.Cross

Parameters:
Returns: Vector3
Modifiers: inline

Extended Type: Vector3

that : Vector3
Returns: Vector3

this.Distance

Full Usage: this.Distance

Parameters:
Returns: float32
Modifiers: inline

Extended Type: Vector3

that : Vector3
Returns: float32

Vector3.Distance(v, p)

Full Usage: Vector3.Distance(v, p)

Parameters:
Returns: float32

Compute distance of a vector from the nearest point on a plane.

Extended Type: Vector3

v : Vector3
p : Plane3
Returns: float32

this.DistanceSquared

Full Usage: this.DistanceSquared

Parameters:
Returns: float32
Modifiers: inline

Extended Type: Vector3

that : Vector3
Returns: float32

this.Dot

Full Usage: this.Dot

Parameters:
Returns: float32
Modifiers: inline

Extended Type: Vector3

that : Vector3
Returns: float32

Vector3.FromPlane(v, p)

Full Usage: Vector3.FromPlane(v, p)

Parameters:
Returns: Vector3

Compute offset to a vector from the nearest point on a plane.

Extended Type: Vector3

v : Vector3
p : Plane3
Returns: Vector3

this.Magnitude

Full Usage: this.Magnitude

Parameters:
    () : unit

Returns: float32
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: float32

this.Magnitude

Full Usage: this.Magnitude

Returns: float32
Modifiers: inline

Extended Type: Vector3

Returns: float32

this.MagnitudeSquared

Full Usage: this.MagnitudeSquared

Parameters:
    () : unit

Returns: float32
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: float32

this.MagnitudeSquared

Full Usage: this.MagnitudeSquared

Returns: float32
Modifiers: inline

Extended Type: Vector3

Returns: float32

this.MapX

Full Usage: this.MapX

Parameters:
    mapper : float32 -> float32

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

mapper : float32 -> float32
Returns: Vector3

this.MapY

Full Usage: this.MapY

Parameters:
    mapper : float32 -> float32

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

mapper : float32 -> float32
Returns: Vector3

this.MapZ

Full Usage: this.MapZ

Parameters:
    mapper : float32 -> float32

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

mapper : float32 -> float32
Returns: Vector3

Vector3.Modulo(a, b)

Full Usage: Vector3.Modulo(a, b)

Parameters:
Returns: Vector3

Compute modulo of vector components.

Extended Type: Vector3

a : Vector3
b : Vector3
Returns: Vector3

this.Normalized

Full Usage: this.Normalized

Parameters:
    () : unit

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector3

this.Normalized

Full Usage: this.Normalized

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

Returns: Vector3

Vector3.Pow(a, b)

Full Usage: Vector3.Pow(a, b)

Parameters:
Returns: Vector3

Compute power of vector components.

Extended Type: Vector3

a : Vector3
b : Vector3
Returns: Vector3

Vector3.Project(v, p)

Full Usage: Vector3.Project(v, p)

Parameters:
Returns: Vector3

Project a vector onto a plane.

Extended Type: Vector3

v : Vector3
p : Plane3
Returns: Vector3

Vector3.Reflect(v, p)

Full Usage: Vector3.Reflect(v, p)

Parameters:
Returns: Vector3

Reflect a vector on a plane.

Extended Type: Vector3

v : Vector3
p : Plane3
Returns: Vector3

this.RollPitchYaw

Full Usage: this.RollPitchYaw

Parameters:
    () : unit

Returns: Quaternion
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Quaternion

this.RollPitchYaw

Full Usage: this.RollPitchYaw

Returns: Quaternion
Modifiers: inline

Extended Type: Vector3

Returns: Quaternion

Vector3.ToPlane(v, p)

Full Usage: Vector3.ToPlane(v, p)

Parameters:
Returns: Vector3

Compute offset from a vector to the nearest point on a plane.

Extended Type: Vector3

v : Vector3
p : Plane3
Returns: Vector3

this.Transform

Full Usage: this.Transform

Parameters:
Returns: Vector3
Modifiers: inline

Extended Type: Vector3

m : Matrix4x4
Returns: Vector3

this.Transform

Full Usage: this.Transform

Parameters:
Returns: Vector3
Modifiers: inline

Extended Type: Vector3

q : Quaternion
Returns: Vector3

this.V2

Full Usage: this.V2

Parameters:
    () : unit

Returns: Vector2
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector2

this.V2

Full Usage: this.V2

Returns: Vector2
Modifiers: inline

Extended Type: Vector3

Returns: Vector2

this.V2i

Full Usage: this.V2i

Parameters:
    () : unit

Returns: Vector2i
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector2i

this.V2i

Full Usage: this.V2i

Returns: Vector2i
Modifiers: inline

Extended Type: Vector3

Returns: Vector2i

this.V3i

Full Usage: this.V3i

Parameters:
    () : unit

Returns: Vector3i
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector3i

this.V3i

Full Usage: this.V3i

Returns: Vector3i
Modifiers: inline

Extended Type: Vector3

Returns: Vector3i

this.V4

Full Usage: this.V4

Parameters:
    () : unit

Returns: Vector4
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector4

this.V4

Full Usage: this.V4

Returns: Vector4
Modifiers: inline

Extended Type: Vector3

Returns: Vector4

this.V4i

Full Usage: this.V4i

Parameters:
    () : unit

Returns: Vector4i
Modifiers: inline

Extended Type: Vector3

() : unit
Returns: Vector4i

this.V4i

Full Usage: this.V4i

Returns: Vector4i
Modifiers: inline

Extended Type: Vector3

Returns: Vector4i

this.WithX

Full Usage: this.WithX

Parameters:
    x : float32

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

x : float32
Returns: Vector3

this.WithY

Full Usage: this.WithY

Parameters:
    y : float32

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

y : float32
Returns: Vector3

this.WithZ

Full Usage: this.WithZ

Parameters:
    z : float32

Returns: Vector3
Modifiers: inline

Extended Type: Vector3

z : float32
Returns: Vector3

Type something to start searching.