Class Vector

StaticX_AXIS

StaticY_AXIS

StaticZ_AXIS

constructor

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

  Returns a new Vector.

  Parameters

  • x: number
  • y: number
  • z: number

  Returns Vector

x

y

z

abs

• abs(): Vector

  Returns the vector with nonnegative components.

  Returns Vector

add

• add(ov: Vector): Vector

  Returns the standard vector sum of v and ov.

  Parameters

  • ov: Vector

  Returns Vector

angle

• angle(ov: Vector): number

  Returns the angle between v and ov.

  Parameters

  • ov: Vector

  Returns number

approxEqual

• approxEqual(ov: Vector): boolean

  Reports whether v and ov are equal within a small epsilon.

  Parameters

  • ov: Vector

  Returns boolean

cmp

• cmp(ov: Vector): number

  Compares v and ov lexicographically and returns:

  -1 if v <  ov
   0 if v == ov
  +1 if v >  ov
  

  This method is based on C++'s std::lexicographical_compare. Two entities are compared element by element with the given operator. The first mismatch defines which is less (or greater) than the other. If both have equivalent values they are lexicographically equal.

  Parameters

  • ov: Vector

  Returns number

cross

• cross(ov: Vector): Vector

  Returns the standard cross product of v and ov.

  Parameters

  • ov: Vector

  Returns Vector

distance

• distance(ov: Vector): number

  Returns the Euclidean distance between v and ov.

  Parameters

  • ov: Vector

  Returns number

dot

• dot(ov: Vector): number

  Returns the standard dot product of v and ov.

  Parameters

  • ov: Vector

  Returns number

equals

• equals(ov: Vector): boolean

  Reports whether this Vector equals another Vector.

  Parameters

  • ov: Vector

  Returns boolean

isUnit

• isUnit(): boolean

  Returns whether this vector is of approximately unit length.

  Returns boolean

largestComponent

• largestComponent(): number

  Returns the Axis that represents the largest component in this vector.

  Returns number

mul

• mul(m: number): Vector

  Returns the standard scalar product of v and m.

  Parameters

  • m: number

  Returns Vector

norm

• norm(): number

  Returns number

norm2

• norm2(): number

  Returns the square of the norm.

  Returns number

normalize

• normalize(): Vector

  Returns a unit vector in the same direction as v.

  Returns Vector

ortho

• ortho(): Vector

  Returns a unit vector that is orthogonal to v. ortho(-v) = -ortho(v) for all v.

  Returns Vector

smallestComponent

• smallestComponent(): number

  Returns the Axis that represents the smallest component in this vector.

  Returns number

sub

• sub(ov: Vector): Vector

  Returns the standard vector difference of v and ov.

  Parameters

  • ov: Vector

  Returns Vector

toString

• toString(): string

  Generates a human readable string.

  Returns string