Skip to content

class Vec4 (shared-side)

Available since version: 0.3.0

4D vector with basic math utilities.

Constructor

Vec4.new(number value)

Parameters:

  • number value: Value assigned to x, y, z and w.

Constructor

Vec4.new(number x, number y, number z, number w)

Parameters:

  • number x: X component.
  • number y: Y component.
  • number z: Z component.
  • number w: W component.

Properties

number x

X component.

number y

Y component.

number z

Z component.

number w

W component.

Methods

len

Returns the vector length (magnitude).

number len()

Returns number:

Vector length.

len2

Returns the squared vector length.

number len2()

Returns number:

Squared vector length.

lenApprox

Returns an approximate vector length.

number lenApprox()

Returns number:

Approximate vector length.

normalize

Normalizes the vector in-place.

If the vector length is zero, no change is applied.

Vec4 normalize()

Returns Vec4:

This vector (normalized).

normalizeSafe

Normalizes the vector in-place using an epsilon check.

If the vector length is below a small threshold, no change is applied.

Vec4 normalizeSafe()

Returns Vec4:

This vector (normalized).

normalizeApprox

Normalizes the vector in-place using an approximate inverse square root.

Vec4 normalizeApprox()

Returns Vec4:

This vector (normalized).

set

Sets all components of the vector.

void set(number x, number y, number z, number w)

Parameters:

  • number x: X component.
  • number y: Y component.
  • number z: Z component.
  • number w: W component.

isEqualEps

Compares this vector with another vector using an epsilon tolerance.

bool isEqualEps(Vec4 vec)

Parameters:

  • Vec4 vec: Other vector.

Returns bool:

True if all components are equal within epsilon.

abs

Returns a vector with absolute component values.

Vec4 abs()

Returns Vec4:

Vector with abs(x), abs(y), abs(z) and abs(w).

static swap

Swaps two vectors.

void swap(Vec4 vec1, Vec4 vec2)

Parameters:

  • Vec4 vec1: First vector.
  • Vec4 vec2: Second vector.

static min

Returns the component-wise minimum of two vectors.

Vec4 min(Vec4 vec1, Vec4 vec2)

Parameters:

  • Vec4 vec1: First vector.
  • Vec4 vec2: Second vector.

Returns Vec4:

Component-wise minimum.

static max

Returns the component-wise maximum of two vectors.

Vec4 max(Vec4 vec1, Vec4 vec2)

Parameters:

  • Vec4 vec1: First vector.
  • Vec4 vec2: Second vector.

Returns Vec4:

Component-wise maximum.

static prod

Returns the component-wise product of two vectors.

Vec4 prod(Vec4 vec1, Vec4 vec2)

Parameters:

  • Vec4 vec1: First vector.
  • Vec4 vec2: Second vector.

Returns Vec4:

Component-wise product.

static dot

Returns the dot product of two vectors.

number dot(Vec4 vec1, Vec4 vec2)

Parameters:

  • Vec4 vec1: First vector.
  • Vec4 vec2: Second vector.

Returns number:

Dot product.

static lerp

Linearly interpolates between two vectors.

Vec4 lerp(number t, Vec4 v1, Vec4 v2)

Parameters:

  • number t: Interpolation factor (typically 0..1).
  • Vec4 v1: Start vector.
  • Vec4 v2: End vector.

Returns Vec4:

Interpolated vector.

Callbacks

No callbacks.