Class VectorXZBuilder

constructor

• new VectorXZBuilder(vecStr: string, delim?: string): VectorXZBuilder

  Parameters

  • vecStr: string
  • Optionaldelim: string

  Returns VectorXZBuilder

• new VectorXZBuilder(vec: VectorXZ, arg?: never): VectorXZBuilder

  Parameters

  • vec: VectorXZ
  • Optionalarg: never

  Returns VectorXZBuilder

• new VectorXZBuilder(x: number, y: number): VectorXZBuilder

  Parameters

  • x: number
  • y: number

  Returns VectorXZBuilder

x

z

add

• add(v: Partial<VectorXZ>): this

  add

  Adds the vector v to this, returning itself.

  Parameters

  • v: Partial<VectorXZ>

  Returns this

assign

• assign(vec: VectorXZ): this

  Assigns the values of the passed in vector to this vector. Returns itself.

  Parameters

  • vec: VectorXZ

  Returns this

clamp

• clamp(limits: { max?: Partial<VectorXZ>; min?: Partial<VectorXZ> }): this

  clamp

  Clamps the components of a vector to limits to produce a new vector

  Parameters

  • limits: { max?: Partial<VectorXZ>; min?: Partial<VectorXZ> }

  Returns this

distance

• distance(vec: VectorXZ): number

  distance

  Calculate the distance between two vectors

  Parameters

  • vec: VectorXZ

  Returns number

dot

• dot(vec: VectorXZ): number

  dot

  Computes the dot product of this and the passed in vector.

  Parameters

  • vec: VectorXZ

  Returns number

equals

• equals(v: VectorXZ): boolean

  equals

  Check the equality of two vectors

  Parameters

  • v: VectorXZ

  Returns boolean

floor

• floor(): this

  floor

  Floor the components of a vector to produce a new vector

  Returns this

lerp

• lerp(vec: VectorXZ, t: number): this

  lerp

  Constructs a new vector using linear interpolation on each component from two vectors.

  Parameters

  • vec: VectorXZ
  • t: number

  Returns this

magnitude

• magnitude(): number

  magnitude

  The magnitude of the vector

  Returns number

multiply

• multiply(vec: VectorXZ): this

  multiply

  Element-wise multiplication of two vectors together. Not to be confused with VectorXZBuilder.dot product

  Parameters

  • vec: VectorXZ

  Returns this

normalize

• normalize(): this

  normalize

  Normalizes this vector, returning itself.

  Returns this

scale

• scale(val: number): this

  scale

  Scales this by the passed in value, returning itself.

  Parameters

  • val: number

  Returns this

slerp

• slerp(vec: VectorXZ, t: number): this

  slerp

  Constructs a new vector using spherical linear interpolation on each component from two vectors.

  Parameters

  • vec: VectorXZ
  • t: number

  Returns this

subtract

• subtract(v: Partial<VectorXZ>): this

  subtract

  Subtracts the vector v from this, returning itself.

  Parameters

  • v: Partial<VectorXZ>

  Returns this

toString

• toString(options?: { decimals?: number; delimiter?: string }): string

  Returns a string representation of an object.

  Parameters

  • Optionaloptions: { decimals?: number; delimiter?: string }

  Returns string