Class Vec3

constructor

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

  Constructor.

  Parameters

  • x: number

    The x component.
  • y: number

    The y component.
  • z: number

    The z component.

  Returns Vec3

Readonlyx

Readonlyy

Readonlyz

Staticnx

• get nx(): Vec3

  The negative x-axis vector.

  Returns Vec3

Staticny

• get ny(): Vec3

  The negative y-axis vector.

  Returns Vec3

Staticnz

• get nz(): Vec3

  The negative z-axis vector.

  Returns Vec3

Staticone

• get one(): Vec3

  The vector with all components set to one.

  Returns Vec3

Staticx

• get x(): Vec3

  The x-axis vector.

  Returns Vec3

Staticy

• get y(): Vec3

  The y-axis vector.

  Returns Vec3

Staticz

• get z(): Vec3

  The z-axis vector.

  Returns Vec3

Staticzero

• get zero(): Vec3

  The zero vector.

  Returns Vec3

toString

• toString(): string

  Converts the vector to a string.

  Returns string

  The string representation of the vector.

Staticadd

• add(lhs: IVec3, rhs: IVec3): Vec3

  Adds two vectors.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns Vec3

  The sum of the two vectors.

Staticangle

• angle(v1: IVec3, v2: IVec3): number

  Calculates the shortest unsigned angle between two vectors.

  Parameters

  • v1: IVec3

    The first vector.
  • v2: IVec3

    The second vector.

  Returns number

  The shortest unsigned angle (radians).

  Remarks

  The vectors must have non-zero lengths.

StaticangleUnit

• angleUnit(n1: IVec3, n2: IVec3): number

  Calculates the shortest unsigned angle between two unit vectors.

  Parameters

  • n1: IVec3

    The first unit vector.
  • n2: IVec3

    The second unit vector.

  Returns number

  The shortest unsigned angle (radians).

Staticcross

• cross(lhs: IVec3, rhs: IVec3): Vec3

  The cross (vector) product of two vectors.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns Vec3

  The cross product.

Staticdirection

• direction(start: IVec3, end: IVec3): Vec3

  Calculates the unit direction vector from the start point to the end point.

  Parameters

  • start: IVec3

    The start point.
  • end: IVec3

    The end point.

  Returns Vec3

  The unit direction vector.

  Remarks

  The start and end points must not be coincident.

Staticdistance

• distance(p1: IVec3, p2: IVec3): number

  Calculates the Euclidean distance between two points.

  Parameters

  • p1: IVec3

    The first point.
  • p2: IVec3

    The second point.

  Returns number

  The distance.

StaticdistanceSq

• distanceSq(p1: IVec3, p2: IVec3): number

  Calculates the square of the Euclidean distance between two points.

  Parameters

  • p1: IVec3

    The first point.
  • p2: IVec3

    The second point.

  Returns number

  The square of the distance.

Staticdot

• dot(lhs: IVec3, rhs: IVec3): number

  Calculates the dot (scalar) product of two vectors.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns number

  The dot product.

Staticequals

• equals(lhs: IVec3, rhs: IVec3): boolean

  Determines whether two vectors are exactly equal.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns boolean

  True if the two vectors are exactly equal, false otherwise.

StaticinverseScale

• inverseScale(lhs: IVec3, rhs: IVec3): Vec3

  Divides the first vector by the second vector component-wise.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns Vec3

  The component-wise division of the first vector by the second vector.

Staticlerp

• lerp(lhs: IVec3, rhs: IVec3, weight: number): Vec3

  Linearly interpolates between two vectors.

  Parameters

  • lhs: IVec3

    The start vector.
  • rhs: IVec3

    The end vector.
  • weight: number

    The interpolation fraction between the two quaternions.

  Returns Vec3

  The interpolated quaternion.

Staticmid

• mid(first: IVec3, second: IVec3): Vec3

  Calculates the mid point between the two points.

  Parameters

  • first: IVec3

    The first point.
  • second: IVec3

    The second point.

  Returns Vec3

  The mid point.

Staticnegate

• negate(rhs: IVec3): Vec3

  Negates the vector.

  Parameters

  • rhs: IVec3

    The vector.

  Returns Vec3

  The negated vector.

Staticnorm

• norm(v: IVec3): number

  The magnitude of the vector.

  Parameters

  • v: IVec3

    The vector.

  Returns number

  The length of the vector.

Staticnormalized

• normalized(v: IVec3): Vec3

  Normalizes a vector.

  Parameters

  • v: IVec3

    The vector.

  Returns Vec3

  The unit vector with the same direction.

  Remarks

  The vector must have non-zero length.

StaticnormSq

• normSq(v: IVec3): number

  The square of the magnitude of the vector.

  Parameters

  • v: IVec3

    The vector.

  Returns number

  The length squared of the vector.

StaticnotEquals

• notEquals(lhs: IVec3, rhs: IVec3): boolean

  Determines whether two vectors are not exactly equal.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns boolean

  True if the two vectors are different, false otherwise.

Staticorthonormal

• orthonormal(n: IVec3): Vec3

  Finds a vector orthonormal to the specified unit vector.

  Parameters

  • n: IVec3

    The unit vector.

  Returns Vec3

  The orthonormal vector.

  Remarks

  The specified vector must have non-zero length.

Staticorthonormalize

• orthonormalize(n1: Vec3, n2: Vec3): Vec3

  Makes the second supplied unit vector orthonormal to the first supplied unit vector.

  Parameters

  • n1: Vec3

    The first unit vector.
  • n2: Vec3

    The second unit vector.

  Returns Vec3

  The orthonormalized second unit vector.

  Remarks

  Uses the Gram-Schmidt process.

Staticparallel

• parallel(v1: IVec3, v2: IVec3, eps?: number): boolean

  Determines whether two vectors are (anti-)parallel.

  Parameters

  • v1: IVec3

    The first vector.
  • v2: IVec3

    The second vector.
  • eps: number = 0.000175

    The angular tolerance (radians).

  Returns boolean

  True if the vectors are (anti-)parallel, false otherwise.

  Remarks

  The two vectors are (anti-)parallel if the shortest angle between them is less than the specified tolerance.

StaticparallelUnit

• parallelUnit(n1: IVec3, n2: IVec3, eps?: number): boolean

  Determines whether two unit vectors are (anti-)parallel.

  Parameters

  • n1: IVec3

    The first unit vector.
  • n2: IVec3

    The second unit vector.
  • eps: number = 0.000175

    The angular tolerance (radians).

  Returns boolean

  True if the unit vectors are (anti-)parallel, false otherwise.

  Remarks

  The two unit vectors are (anti-)parallel if the shortest angle between them is less than the specified tolerance.

StaticrandomUnit

• randomUnit(): Vec3

  Creates a random unit vector.

  Returns Vec3

  The random unit vector.

Staticscale

• scale(lhs: IVec3, rhs: IVec3): Vec3

  Multiplies the two vectors component-wise.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns Vec3

  The component-wise product of the two vectors.

StaticscaleUniform

• scaleUniform(lhs: IVec3, rhs: number): Vec3

  Scales a vector uniformly.

  Parameters

  • lhs: IVec3

    The vector.
  • rhs: number

    The uniform scale factor.

  Returns Vec3

  The scaled vector.

StaticsignedAngle

• signedAngle(start: IVec3, end: IVec3, n: IVec3): number

  Calculates the shortest signed angle between two vectors.

  Parameters

  • start: IVec3

    The vector from which the angle is measured.
  • end: IVec3

    The vector to which the angle is measured.
  • n: IVec3

    The plane in which the vectors lie.

  Returns number

  The shortest signed angle (radians).

  Remarks

  The sign of the angle is determined by the specified plane normal. The vectors must lie in the plane.

StaticsignedAngleUnit

• signedAngleUnit(start: IVec3, end: IVec3, n: IVec3): number

  Calculates the shortest signed angle between two unit vectors.

  Parameters

  • start: IVec3

    The unit vector from which the angle is measured.
  • end: IVec3

    The unit vector to which the angle is measured.
  • n: IVec3

    The plane in which the vectors lie.

  Returns number

  The shortest signed angle (radians).

  Remarks

  The sign of the angle is determined by the specified plane normal. The unit vectors must lie in the plane.

Staticsubtract

• subtract(lhs: IVec3, rhs: IVec3): Vec3

  Subtracts the second vector from the first vector.

  Parameters

  • lhs: IVec3

    The first vector.
  • rhs: IVec3

    The second vector.

  Returns Vec3

  The subtraction of the second vector from the first vector.