Class Vec3

constructor

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

  Create a vector from cartesian coordinates

  Parameters

  • x: number

    The cartesian x-coordinate

  • y: number

    The cartesian y-coordinate

  • z: number = 0

    The cartesian z-coordinate

  Returns Vec3

Readonlyphi

Readonlyr

Readonlytheta

Readonlyx

Readonlyy

Readonlyz

cross

• cross(other: Vec3): Vec3

  Compute the cross product between this vector and another vector

  Parameters

  • other: Vec3

    Arbitrary vector

  Returns Vec3

  v1 x v2

dot

• dot(other: Vec3): number

  Compute the dot product between this vector and another vector

  Parameters

  • other: Vec3

    Arbitrary vector

  Returns number

  v1 . v2

equals

• equals(other: Vec3, tolerance?: number): boolean

  Determine if two vectors are equal (or approximately equal)

  Parameters

  • other: Vec3

    Arbitrary vector

  • tolerance: number = 0

    Optional absolute tolerance

  Returns boolean

  true if v1 = v2

minus

• minus(other: Vec3): Vec3

  Subtract another vector from this vector

  Parameters

  • other: Vec3

    Arbitrary vector

  Returns Vec3

  v1 - v2

plus

• plus(other: Vec3): Vec3

  Add this vector and another vector

  Parameters

  • other: Vec3

    Arbitrary vector

  Returns Vec3

  v1 + v2

projectOnto

• projectOnto(other: Vec3): Vec3

  Project this vector onto another vector

  Parameters

  • other: Vec3

    Arbitrary vector

  Returns Vec3

  proj_v2(v1)

scaleBy

• scaleBy(factor: number): Vec3

  Scale this vector by a numeric factor

  Parameters

  • factor: number

    Scaling factor

  Returns Vec3

  A scaled vector

unit

• unit(): Vec3

  Get a unit vector in this direction

  Returns Vec3

  v1 (with length 1)

StaticfromPolar

• fromPolar(r: number, theta: number, phi?: number): Vec3

  Create a vector from polar coordinates

  Parameters

  • r: number

    The magnitude/length of the vector

  • theta: number

    The angle of the vector in radians, measured from the x-axis

  • phi: number = 0

    The angle of the vector in radians, measured from the xy-plane

  Returns Vec3

  A vector created from polar coordinates