Interface Vec3

Readonlyx

Readonlyxy

Readonlyy

Readonlyz

angle

• angle(): number

• Return this' angle in the XY plane (treats this as a Vec2).

  This is equivalent to Math.atan2(vec.y, vec.x).

  As such, observing that Math.atan2(-0, -1) $\approx -\pi$ and Math.atan2(0, -1) $\approx \pi$ the resultant angle is in the range $[-\pi, \pi]$.

  Example:

  import { Vec2 } from '@js-draw/math';
  console.log(Vec2.of(-1, -0).angle()); // atan2(-0, -1)
  console.log(Vec2.of(-1, 0).angle());  // atan2(0, -1)
  

  Returns number

asArray

• asArray(): [number, number, number]

• Returns [number, number, number]

at

• at(i: number): number

• Returns the vector's idxth component. For example, Vec3.of(1, 2, 3).at(1) → 2.

  Parameters

  • i: number

  Returns number

cross

• cross(v: Vec3): Vec3

• Computes the cross product between this and v

  Parameters

  • v: Vec3

  Returns Vec3

distanceTo

• distanceTo(p: Vec3): number

• Interpreting this vector as a point in ℝ³, returns the distance to the point p.

  Equivalent to .minus(p).magnitude().

  Parameters

  • p: Vec3

  Returns number

dot

• dot(v: Vec3): number

• Computes the scalar product between this and v.

  In particular, a.dot(b) is equivalent to a.x * b.x + a.y * b.y + a.z * b.z.

  Parameters

  • v: Vec3

  Returns number

eq

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

• Parameters

  • other: Vec3
  • Optionaltolerance: number

    The maximum difference between two components for this and [other] to be considered equal.

  Returns boolean

  Example

  Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 100);  // → true
  Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 0.1);  // → false
  Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3);    // → true
  Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3.01); // → true
  Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 2.99); // → false
  Copy

extend

• extend(distance: number, direction: Vec3): Vec3

• Returns this plus a vector of length distance in direction.

  Parameters

  • distance: number
  • direction: Vec3

  Returns Vec3

length

• length(): number

• Alias for .magnitude.

  Returns number

lerp

• lerp(target: Vec3, fractionTo: number): Vec3

• Returns a vector fractionTo of the way to target from this.

  Parameters

  • target: Vec3
  • fractionTo: number

  Returns Vec3

magnitude

• magnitude(): number

• Returns the length of this vector in ℝ^3.

  Returns number

magnitudeSquared

• magnitudeSquared(): number

• Returns number

map

• map(fn: (component: number, index: number) => number): Vec3

• Returns a vector with each component acted on by fn.

  Parameters

  • fn: (component: number, index: number) => number

  Returns Vec3

  Example

  import { Vec3 } from '@js-draw/math';
  console.log(Vec3.of(1, 2, 3).map(val => val + 1)); // → Vec(2, 3, 4)
  

maximumEntryMagnitude

• maximumEntryMagnitude(): number

• Returns the entry of this with the greatest magnitude.

  In other words, returns $\max { |x| : x \in {\bf v} }$, where ${\bf v}$ is the set of all entries of this vector.

  Example:

  import { Vec3 } from '@js-draw/math';
  console.log(Vec3.of(-1, -10, 8).maximumEntryMagnitude()); // -> 10
  

  Returns number

minus

• minus(v: Vec3): Vec3

• Parameters

  • v: Vec3

  Returns Vec3

normalized

• normalized(): Vec3

• Returns a unit vector in the same direction as this.

  If this has zero length, the resultant vector has NaN components.

  Returns Vec3

normalizedOrZero

• normalizedOrZero(): Vec3

• Like normalized, except returns zero if this has zero magnitude.

  Returns Vec3

orthog

• orthog(): Vec3

• Returns a vector orthogonal to this. If this is a Vec2, returns this rotated 90 degrees counter-clockwise.

  Returns Vec3

plus

• plus(v: Vec3): Vec3

• Performs vector addition.

  Parameters

  • v: Vec3

  Returns Vec3

scale

• scale(other: number | Vec3): Vec3

• If other is a Vec3, multiplies this component-wise by other. Otherwise, if other is a number`, returns the result of scalar multiplication.

  Parameters

  • other: number | Vec3

  Returns Vec3

  Example

  Vec3.of(1, 2, 3).scale(Vec3.of(2, 4, 6)); // → Vec3(2, 8, 18)
  Copy

squareDistanceTo

• squareDistanceTo(other: Vec3): number

• Interpreting this vector as a point in ℝ^3, computes the square distance to another point, p.

  Equivalent to .minus(p).magnitudeSquared().

  Parameters

  • other: Vec3

  Returns number

times

• times(c: number): Vec3

• Parameters

  • c: number

  Returns Vec3

  A copy of this multiplied by a scalar.

toString

• toString(): string

• Returns string

zip

• zip(
      other: Vec3,
      zip: (componentInThis: number, componentInOther: number) => number,
  ): Vec3

• zip Maps a component of this and a corresponding component of other to a component of the output vector.

  Parameters

  • other: Vec3
  • zip: (componentInThis: number, componentInOther: number) => number

  Returns Vec3

  Example

  const a = Vec3.of(1, 2, 3);
  const b = Vec3.of(0.5, 2.1, 2.9);
  
  const zipped = a.zip(b, (aComponent, bComponent) => {
    return Math.min(aComponent, bComponent);
  });
  
  console.log(zipped.toString()); // → Vec(0.5, 2, 2.9)
  Copy