Class Vector3d

constructor

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

  Parameters

  • Optionalx: number = 0

    x value of the vector

  • Optionaly: number = 0

    y value of the vector

  • Optionalz: number = 0

    z value of the vector

  Returns Vector3d

x

y

z

abs

• abs(): Vector3d

  Update this vector values to absolute values

  Returns Vector3d

  Reference to this object for method chaining

add

• add(v: Vector2d | Vector3d): Vector3d

  Add the passed vector to this vector

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

angle

• angle(v: Vector2d | Vector3d): number

  return the angle between this vector and the passed one

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns number

  angle in radians

ceil

• ceil(): Vector3d

  Ceil the vector values

  Returns Vector3d

  new Vector3d

ceilSelf

• ceilSelf(): Vector3d

  Ceil this vector values

  Returns Vector3d

  Reference to this object for method chaining

clamp

• clamp(low: number, high: number): Vector3d

  Clamp the vector value within the specified value range

  Parameters

  • low: number

    lower bound

  • high: number

    upper bound

  Returns Vector3d

  new Vector3d

clampSelf

• clampSelf(low: number, high: number): Vector3d

  Clamp this vector value within the specified value range

  Parameters

  • low: number

    lower bound

  • high: number

    upper bound

  Returns Vector3d

  Reference to this object for method chaining

clone

• clone(): Vector3d

  return a clone copy of this vector

  Returns Vector3d

  new Vector3d

copy

• copy(v: Vector2d | Vector3d): Vector3d

  Copy the components of the given vector into this one

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

cross

• cross(v: Vector3d): Vector3d

  calculate the cross product of this vector and the passed one

  Parameters

  • v: Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

distance

• distance(v: Vector2d | Vector3d): number

  return the distance between this vector and the passed one

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns number

  distance

div

• div(n: number): Vector3d

  Divide this vector values by the passed value

  Parameters

  • n: number

    the value to divide the vector by

  Returns Vector3d

  Reference to this object for method chaining

dot

• dot(v: Vector2d | Vector3d): number

  return the dot product of this vector and the passed one

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns number

  The dot product.

equals

• equals(
      ...args:
          | [number, number]
          | [number, number, number]
          | [number]
          | [Vector2d]
          | [Vector3d],
  ): boolean

  return true if this vector is equal to the given values or vector

  Parameters

  • ...args: [number, number] | [number, number, number] | [number] | [Vector2d] | [Vector3d]

    other vector or vector components

  Returns boolean

  true if both vectors are equal

floor

• floor(): Vector3d

  Floor the vector values

  Returns Vector3d

  new Vector3d

floorSelf

• floorSelf(): Vector3d

  Floor this vector values

  Returns Vector3d

  Reference to this object for method chaining

length

• length(): number

  return the length (magnitude) of this vector

  Returns number

  the length of this vector

length2

• length2(): number

  return the square length of this vector

  Returns number

  The length^2 of this vector.

lerp

• lerp(v: Vector3d, alpha: number): Vector3d

  Linearly interpolate between this vector and the given one.

  Parameters

  • v: Vector3d

    other vector

  • alpha: number

    distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).

  Returns Vector3d

  Reference to this object for method chaining

maxV

• maxV(v: Vector2d | Vector3d): Vector3d

  Update this vector with the maximum value between this and the passed vector

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

minV

• minV(v: Vector2d | Vector3d): Vector3d

  Update this vector with the minimum value between this and the passed vector

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

moveTowards

• moveTowards(target: Vector2d | Vector3d, step: number): Vector2d | Vector3d

  interpolate the position of this vector on the x and y axis towards the given one by the given maximum step.

  Parameters

  • target: Vector2d | Vector3d

    other vector

  • step: number

    the maximum step per iteration (Negative values will push the vector away from the target)

  Returns Vector2d | Vector3d

  Reference to this object for method chaining

negate

• negate(): Vector3d

  Negate the vector values

  Returns Vector3d

  new Vector3d

negateSelf

• negateSelf(): Vector3d

  Negate this vector values

  Returns Vector3d

  Reference to this object for method chaining

normalize

• normalize(): Vector3d

  normalize this vector (scale the vector so that its magnitude is 1)

  Returns Vector3d

  Reference to this object for method chaining

onResetEvent

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

  Parameters

  • x: number = 0
  • y: number = 0
  • z: number = 0

  Returns void

perp

• perp(): Vector3d

  change this vector to be perpendicular to what it was before.
  (Effectively rotates it 90 degrees in a clockwise direction around the z axis)

  Returns Vector3d

  Reference to this object for method chaining

project

• project(v: Vector2d | Vector3d): Vector3d

  project this vector on to another vector.

  Parameters

  • v: Vector2d | Vector3d

    The vector to project onto.

  Returns Vector3d

  Reference to this object for method chaining

projectN

• projectN(v: Vector2d | Vector3d): Vector3d

  Project this vector onto a vector of unit length.
  This is slightly more efficient than project when dealing with unit vectors.

  Parameters

  • v: Vector2d | Vector3d

    The unit vector to project onto.

  Returns Vector3d

  Reference to this object for method chaining

rotate

• rotate(angle: number, v?: XYPoint): Vector3d

  Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis

  Parameters

  • angle: number

    The angle to rotate (in radians)

  • Optionalv: XYPoint

    an optional point to rotate around (on the same z axis)

  Returns Vector3d

  Reference to this object for method chaining

scale

• scale(x: number, y?: number, z?: number): Vector3d

  Multiply this vector values by the given scalar

  Parameters

  • x: number

    x component

  • Optionaly: number = x

    y component

  • Optionalz: number = 1

    z component

  Returns Vector3d

  Reference to this object for method chaining

scaleV

• scaleV(v: Vector3d): Vector3d

  Multiply this vector values by the passed vector

  Parameters

  • v: Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

set

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

  set the Vector x and y properties to the given values

  Parameters

  • x: number

    x component

  • y: number

    y component

  • Optionalz: number = 0

    z component

  Returns Vector3d

  Reference to this object for method chaining

setV

• setV(v: Vector2d | Vector3d): Vector3d

  set the Vector x and y properties using the passed vector

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

setZero

• setZero(): Vector3d

  set the Vector x and y properties to 0

  Returns Vector3d

  Reference to this object for method chaining

sub

• sub(v: Vector2d | Vector3d): Vector3d

  Substract the passed vector to this vector

  Parameters

  • v: Vector2d | Vector3d

    other vector

  Returns Vector3d

  Reference to this object for method chaining

to2d

• to2d(): Vector3d

  Convert this vector into 2d coordinate space

  Returns Vector3d

  Reference to this object for method chaining

toIso

• toIso(): Vector3d

  Convert this vector into isometric coordinate space

  Returns Vector3d

  Reference to this object for method chaining

toString

• toString(): `x:${number},y:${number},z:${number}`

  convert the object to a string representation

  Returns `x:${number},y:${number},z:${number}`

  stringified representation