Class Vector

constructor

• new Vector(x: number, y: number, z?: number): Vector

  ↗ Constructs a new Vector object.

  Parameters

  • x: number

    x component of the vector

  • y: number

    y component of the vector

  • Optionalz: number

    optional. The z component of the vector

  Returns Vector

  Example

  await Canvas(200);
  background(0.8);
  
  let v = createVector(0, 0);
  circle(v.x, v.y, 50);
  Copy

x

y

z

add

• add(v: Vector): Vector

  ↗ Adds a vector to this vector.

  Parameters

  • v: Vector

    vector to add

  Returns Vector

  resulting vector after addition

copy

• copy(): Vector

  ↗ Copies this vector.

  Returns Vector

  a new vector with the same components as this one

cross

• cross(v: Vector): Vector

  ↗ Calculates the cross product of this vector and another vector.

  Parameters

  • v: Vector

    other vector

  Returns Vector

  a new vector that is the cross product of this vector and the given vector

dist

• dist(v: Vector): number

  ↗ Calculates the distance between this vector and another vector.

  Parameters

  • v: Vector

    other vector

  Returns number

  distance

div

• div(n: number | Vector): Vector

  ↗ Divides this vector by a scalar or element-wise by another vector.

  Parameters

  • n: number | Vector

    scalar to divide by, or a vector for element-wise division

  Returns Vector

  resulting vector after division

dot

• dot(v: Vector): number

  ↗ Calculates the dot product of this vector and another vector.

  Parameters

  • v: Vector

    other vector

  Returns number

  dot product

heading

• heading(): number

  ↗ Calculates the angle of rotation for this vector (only 2D vectors).

  Returns number

  angle of rotation

lerp

• lerp(v: Vector, amt: number): Vector

  ↗ Linearly interpolates between this vector and another vector.

  Parameters

  • v: Vector

    vector to interpolate towards

  • amt: number

    amount of interpolation; a number between 0.0 (close to the current vector) and 1.0 (close to the target vector)

  Returns Vector

  this vector after interpolation

limit

• limit(max: number): Vector

  ↗ Limits the magnitude of the vector to the value used for the max parameter.

  Parameters

  • max: number

    maximum magnitude for the vector

  Returns Vector

  this vector after limiting

mag

• mag(): number

  ↗ Calculates the magnitude (length) of the vector.

  Returns number

  magnitude of the vector

mult

• mult(n: number | Vector): Vector

  ↗ Multiplies this vector by a scalar or element-wise by another vector.

  Parameters

  • n: number | Vector

    scalar to multiply by, or a vector for element-wise multiplication

  Returns Vector

  resulting vector after multiplication

normalize

• normalize(): Vector

  ↗ Normalizes the vector to a length of 1 (making it a unit vector).

  Returns Vector

  this vector after normalization

rotate

• rotate(angle: number): Vector

  ↗ Rotates the vector by the given angle (only 2D vectors).

  Parameters

  • angle: number

    angle of rotation in radians

  Returns Vector

  this vector after rotation

set

• set(x: number, y: number, z?: number): void

  ↗ Sets the components of the vector.

  Parameters

  • x: number

    x component

  • y: number

    y component

  • Optionalz: number

    optional. The z component

  Returns void

setHeading

• setHeading(angle: number): Vector

  ↗ Rotates the vector to a specific angle without changing its magnitude.

  Parameters

  • angle: number

    angle in radians

  Returns Vector

  this vector after setting the heading

setMag

• setMag(len: number): Vector

  ↗ Sets the magnitude of the vector to the specified length.

  Parameters

  • len: number

    new length of the vector

  Returns Vector

  this vector after setting magnitude

slerp

• slerp(v: Vector, amt: number): Vector

  ↗ Linearly interpolates between this vector and another vector, including the magnitude.

  Parameters

  • v: Vector

    vector to interpolate towards

  • amt: number

    amount of interpolation; a number between 0.0 (close to the current vector) and 1.0 (close to the target vector)

  Returns Vector

  this vector after spherical interpolation

sub

• sub(v: Vector): Vector

  ↗ Subtracts a vector from this vector.

  Parameters

  • v: Vector

    vector to subtract

  Returns Vector

  resulting vector after subtraction

StaticfromAngle

• fromAngle(angle: number, length?: number): Vector

  Parameters

  • angle: number
  • Optionallength: number

  Returns Vector