Class VectorXZUtils

Utilities operating on VectorXZ objects. All methods are static and do not modify the input objects.

Index

Constructors

Methods

add clamp distance dot equals floor fromString lerp magnitude multiply normalize scale slerp subtract toString

Constructors

constructor

new VectorXZUtils(): VectorXZUtils
Returns VectorXZUtils

Methods

`Static`add

add(v1: VectorXZ, v2: Partial<VectorXZ>): VectorXZ
add

Add two vectors to produce a new vector
Parameters
- v1: VectorXZ
- v2: Partial<VectorXZ>
Returns VectorXZ

`Static`clamp

clamp(
v: VectorXZ,
limits?: { max?: Partial<VectorXZ>; min?: Partial<VectorXZ> },
): VectorXZ
clamp

Clamps the components of a vector to limits to produce a new vector
Parameters
- v: VectorXZ
- Optionallimits: { max?: Partial<VectorXZ>; min?: Partial<VectorXZ> }
Returns VectorXZ

`Static`distance

distance(a: VectorXZ, b: VectorXZ): number
distance

Calculate the distance between two vectors
Parameters
- a: VectorXZ
- b: VectorXZ
Returns number

`Static`dot

dot(a: VectorXZ, b: VectorXZ): number
dot

Calculate the dot product of two vectors
Parameters
- a: VectorXZ
- b: VectorXZ
Returns number

`Static`equals

equals(v1: VectorXZ, v2: VectorXZ): boolean
equals

Check the equality of two vectors
Parameters
- v1: VectorXZ
- v2: VectorXZ
Returns boolean

`Static`floor

floor(v: VectorXZ): VectorXZ
floor

Floor the components of a vector to produce a new vector
Parameters
- v: VectorXZ
Returns VectorXZ

`Static`fromString

fromString(str: string, delimiter?: string): VectorXZ
fromString

Gets a VectorXZ from the string representation produced by VectorXZUtils.toString. If any numeric value is not a number or the format is invalid, undefined is returned.
Parameters
- str: string
  The string to parse
- Optionaldelimiter: string
  The delimiter used to separate the components. Defaults to the same as the default for VectorXZUtils.toString
Returns VectorXZ

`Static`lerp

lerp(a: VectorXZ, b: VectorXZ, t: number): VectorXZ
lerp

Constructs a new vector using linear interpolation on each component from two vectors.
Parameters
- a: VectorXZ
- b: VectorXZ
- t: number
Returns VectorXZ

`Static`magnitude

magnitude(v: VectorXZ): number
magnitude

The magnitude of a vector
Parameters
- v: VectorXZ
Returns number

`Static`multiply

multiply(a: VectorXZ, b: VectorXZ): VectorXZ
multiply

Element-wise multiplication of two vectors together. Not to be confused with VectorXZUtils.dot product
Parameters
- a: VectorXZ
- b: VectorXZ
Returns VectorXZ

`Static`normalize

normalize(v: VectorXZ): VectorXZ
normalize

Takes a vector 3 and normalizes it to a unit vector
Parameters
- v: VectorXZ
Returns VectorXZ

`Static`scale

scale(v1: VectorXZ, scale: number): VectorXZ
scale

Multiple all entries in a vector by a single scalar value producing a new vector
Parameters
- v1: VectorXZ
- scale: number
Returns VectorXZ

`Static`slerp

slerp(a: VectorXZ, b: VectorXZ, t: number): VectorXZ
slerp

Constructs a new vector using spherical linear interpolation on each component from two vectors.
Parameters
- a: VectorXZ
- b: VectorXZ
- t: number
Returns VectorXZ

`Static`subtract

subtract(v1: VectorXZ, v2: Partial<VectorXZ>): VectorXZ
subtract

Subtract two vectors to produce a new vector (v1-v2)
Parameters
- v1: VectorXZ
- v2: Partial<VectorXZ>
Returns VectorXZ

`Static`toString

toString(
v: VectorXZ,
options?: { decimals?: number; delimiter?: string },
): string
toString

Create a string representation of a vectorxz
Parameters
- v: VectorXZ
- Optionaloptions: { decimals?: number; delimiter?: string }
Returns string