use math — Vectors

Vector types for 2D, 3D, and 4D math. All types are part of the math module.

See also: Scalar functions | Matrices & Quaternions

Vec2

2D vector with x and y components.

Struct

Constructors

fn vec2_one

Create a Vec2 with all components set to one.

Signature: ( -- v:Vec2)

Example:

math::vec2_one  // v

fn vec2_zero

Create a Vec2 with all components set to zero.

Signature: ( -- v:Vec2)

Example:

math::vec2_zero  // v

Methods

fn add

Add another Vec2 to this vector.

Signature: (v:Vec2) add(other:Vec2 -- result:Vec2)

Example:

other v add  // sum

fn dot

Dot product with another Vec2.

Signature: (v:Vec2) dot(other:Vec2 -- result:f64)

Example:

other v dot  // d

fn length_sq

Squared length of this vector (avoids sqrt).

Signature: (v:Vec2) length_sq( -- result:f64)

Example:

v length_sq  // len_sq

fn length

Length (magnitude) of this vector.

Signature: (v:Vec2) length( -- result:f64)

Example:

v length  // len

fn lerp

Linear interpolation to another Vec2.

Signature: (v:Vec2) lerp(other:Vec2 t:f64 -- result:Vec2)

Example:

other 0.5 v lerp  // mid

fn neg

Negate this vector.

Signature: (v:Vec2) neg( -- result:Vec2)

Example:

v neg  // neg_v

fn normalize

Normalize this vector to unit length.

Signature: (v:Vec2) normalize( -- result:Vec2)

Example:

v normalize  // unit

fn scale

Multiply this vector by a scalar.

Signature: (v:Vec2) scale(s:f64 -- result:Vec2)

Example:

2.0 v scale  // scaled

fn subtract

Subtract another Vec2 from this vector.

Signature: (v:Vec2) subtract(other:Vec2 -- result:Vec2)

Example:

other v subtract  // diff

fn distance

Distance to another Vec2.

Signature: (v:Vec2) distance(other:Vec2 -- result:f64)

Example:

other v distance -> d

fn angle

Angle of this vector from positive X axis.

Signature: (v:Vec2) angle( -- result:f64)

Example:

v angle -> a

fn rotate

Rotate this vector by an angle.

Signature: (v:Vec2) rotate(angle:f64 -- result:Vec2)

Example:

1.57 v rotate -> rotated

fn perpendicular

Get perpendicular vector (90 degrees counterclockwise rotation).

Signature: (v:Vec2) perpendicular( -- result:Vec2)

Example:

v perpendicular -> perp

Vec3

3D vector with x, y, and z components.

Struct

Constructors

fn vec3_one

Create a Vec3 with all components set to one.

Signature: ( -- v:Vec3)

Example:

math::vec3_one  // v

fn vec3_unit_x

Unit vector along the X axis.

Signature: ( -- v:Vec3)

Example:

math::vec3_unit_x  // v

fn vec3_unit_y

Unit vector along the Y axis.

Signature: ( -- v:Vec3)

Example:

math::vec3_unit_y  // v

fn vec3_unit_z

Unit vector along the Z axis.

Signature: ( -- v:Vec3)

Example:

math::vec3_unit_z  // v

fn vec3_zero

Create a Vec3 with all components set to zero.

Signature: ( -- v:Vec3)

Example:

math::vec3_zero  // v

Methods

fn add

Add another Vec3 to this vector.

Signature: (v:Vec3) add(other:Vec3 -- result:Vec3)

Example:

other v add  // sum

fn cross

Cross product with another Vec3.

Signature: (v:Vec3) cross(other:Vec3 -- result:Vec3)

Example:

other v cross  // c

fn dot

Dot product with another Vec3.

Signature: (v:Vec3) dot(other:Vec3 -- result:f64)

Example:

other v dot  // d

fn length_sq

Squared length of this vector (avoids sqrt).

Signature: (v:Vec3) length_sq( -- result:f64)

Example:

v length_sq  // len_sq

fn length

Length (magnitude) of this vector.

Signature: (v:Vec3) length( -- result:f64)

Example:

v length  // len

fn lerp

Linear interpolation to another Vec3.

Signature: (v:Vec3) lerp(other:Vec3 t:f64 -- result:Vec3)

Example:

other 0.5 v lerp  // mid

fn neg

Negate this vector.

Signature: (v:Vec3) neg( -- result:Vec3)

Example:

v neg  // neg_v

fn normalize

Normalize this vector to unit length.

Signature: (v:Vec3) normalize( -- result:Vec3)

Example:

v normalize  // unit

fn reflect

Reflect this vector around a normal.

Signature: (v:Vec3) reflect(n:Vec3 -- result:Vec3)

Example:

normal v reflect  // reflected

fn scale

Multiply this vector by a scalar.

Signature: (v:Vec3) scale(s:f64 -- result:Vec3)

Example:

2.0 v scale  // scaled

fn subtract

Subtract another Vec3 from this vector.

Signature: (v:Vec3) subtract(other:Vec3 -- result:Vec3)

Example:

other v subtract  // diff

fn distance

Distance to another Vec3.

Signature: (v:Vec3) distance(other:Vec3 -- result:f64)

Example:

other v distance -> d

fn angle_between

Angle between this vector and another.

Signature: (v:Vec3) angle_between(other:Vec3 -- result:f64)

Example:

other v angle_between -> a

Vec4

4D vector with x, y, z, and w components.

Struct

Constructors

fn vec4_one

Create a Vec4 with all components set to one.

Signature: ( -- v:Vec4)

Example:

math::vec4_one  // v

fn vec4_zero

Create a Vec4 with all components set to zero.

Signature: ( -- v:Vec4)

Example:

math::vec4_zero  // v

Methods

fn add

Add another Vec4 to this vector.

Signature: (v:Vec4) add(other:Vec4 -- result:Vec4)

Example:

other v add  // sum

fn dot

Dot product with another Vec4.

Signature: (v:Vec4) dot(other:Vec4 -- result:f64)

Example:

other v dot  // d

fn length

Length (magnitude) of this vector.

Signature: (v:Vec4) length( -- result:f64)

Example:

v length  // len

fn normalize

Normalize this vector to unit length.

Signature: (v:Vec4) normalize( -- result:Vec4)

Example:

v normalize  // unit

fn scale

Multiply this vector by a scalar.

Signature: (v:Vec4) scale(s:f64 -- result:Vec4)

Example:

2.0 v scale  // scaled

fn subtract

Subtract another Vec4 from this vector.

Signature: (v:Vec4) subtract(other:Vec4 -- result:Vec4)

Example:

other v subtract  // diff

fn length_sq

Squared length of this vector (avoids sqrt).

Signature: (v:Vec4) length_sq( -- result:f64)

Example:

v length_sq -> len_sq

fn neg

Negate this vector.

Signature: (v:Vec4) neg( -- result:Vec4)

Example:

v neg -> neg_v

fn lerp

Linear interpolation to another Vec4.

Signature: (v:Vec4) lerp(other:Vec4 t:f64 -- result:Vec4)

Example:

other 0.5 v lerp -> mid