Vector4

A 4D vector, often used for homogeneous coordinates in WebGL shaders and transforms.

Implements

• Clonable<Vector4>

Index

Constructors

• constructor

Properties

• EQUALS_EPSILON

Accessors

• magnitude
• w
• x
• y
• z
• One
• Zero

Methods

• add
• addEqual
• average
• clampMagnitude
• clone
• distance
• dot
• equals
• lerp
• negate
• normalize
• scale
• scaleEqual
• setTo
• squareDistance
• sub
• subEqual
• toArray
• toFloat32Array
• toString
• toVector3
• transform
• distance
• fromArray
• fromDirection
• fromPoint
• isValid
• max
• min

Constructors

constructor

• Vector4(x: number, y: number, z: number, w: number): Vector4

• Parameters

  • x: number

    X component

  • y: number

    Y component

  • z: number

    Z component

  • w: number

    W component

  Returns Vector4

Properties

publicstaticEQUALS_EPSILON

EQUALS_EPSILON: number = 0.001

Get or set the vector equals epsilon, by default 0.001 meaning vectors within that tolerance will be considered equal.

Accessors

publicmagnitude

• get magnitude(): number
• set magnitude(newMagnitude: number): void

• Magnitude (length) of the Vector

  ---

  Returns number

• Parameters

  • newMagnitude: number

  Returns void

publicw

• get w(): number
• set w(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicx

• get x(): number
• set x(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicy

• get y(): number
• set y(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicz

• get z(): number
• set z(val: number): void

• Returns number

• Parameters

  • val: number

  Returns void

publicstaticOne

• get One(): Vector4

• A (1, 1, 1, 1) vector

  ---

  Returns Vector4

publicstaticZero

• get Zero(): Vector4

• A (0, 0, 0, 0) vector

  ---

  Returns Vector4

Methods

publicadd

• add(v: Vector4, dest?: Vector4): Vector4

• Adds one vector to another

  ---

  Parameters

  • v: Vector4

  • optionaldest: Vector4

  Returns Vector4

publicaddEqual

• addEqual(v: Vector4): Vector4

• Adds one vector to this one modifying the original

  ---

  Parameters

  • v: Vector4

  Returns Vector4

publicaverage

• average(vec: Vector4): Vector4

• Returns midpoint between this and target point

  ---

  Parameters

  • vec: Vector4

  Returns Vector4

publicclampMagnitude

• clampMagnitude(magnitude: number): Vector4

• Clamps the current vector's magnitude mutating it

  ---

  Parameters

  • magnitude: number

  Returns Vector4

publicclone

• clone(dest?: Vector4): Vector4

• Implementation of Clonable.clone

  Creates new vector that has the same values as the previous.

  ---

  Parameters

  • optionaldest: Vector4

  Returns Vector4

publicdistance

• distance(v?: Vector4): number

• Distance to another vector or magnitude if omitted

  ---

  Parameters

  • optionalv: Vector4

  Returns number

publicdot

• dot(v: Vector4): number

• Performs a dot product with another vector

  ---

  Parameters

  • v: Vector4

  Returns number

publicequals

• equals(vector: Vector4, tolerance?: number): boolean

• Compares this vector against another and tests for equality

  ---

  Parameters

  • vector: Vector4

  • tolerance: number = Vector4.EQUALS_EPSILON

  Returns boolean

publiclerp

• lerp(target: Vector4, t: number): Vector4

• Linearly interpolates between current vector and target vector.

  ---

  Parameters

  • target: Vector4

  • t: number

  Returns Vector4

publicnegate

• negate(): Vector4

• Negates current vector

  ---

  Returns Vector4

publicnormalize

• normalize(): Vector4

• Normalizes a non-zero vector. Zero vectors return a new zero vector.

  ---

  Returns Vector4

publicscale

• scale(scale: Vector4, dest?: Vector4): Vector4
• scale(size: number, dest?: Vector4): Vector4

• Scales vector component-wise or by scalar

  ---

  Parameters

  • scale: Vector4

  • optionaldest: Vector4

  Returns Vector4

publicscaleEqual

• scaleEqual(size: number): Vector4

• Scales this vector by a factor and modifies the original

  ---

  Parameters

  • size: number

  Returns Vector4

publicsetTo

• setTo(x: number, y: number, z: number, w: number): void

• Sets all 4 components at once, THIS MUTATES the current vector.

  ---

  Parameters

  • x: number

  • y: number

  • z: number

  • w: number

  Returns void

publicsquareDistance

• squareDistance(v?: Vector4): number

• Parameters

  • optionalv: Vector4

  Returns number

publicsub

• sub(v: Vector4, dest?: Vector4): Vector4

• Subtracts a vector from another

  ---

  Parameters

  • v: Vector4

  • optionaldest: Vector4

  Returns Vector4

publicsubEqual

• subEqual(v: Vector4): Vector4

• Subtracts a vector from this one modifying the original

  ---

  Parameters

  • v: Vector4

  Returns Vector4

publictoArray

• toArray(dest?: number[], offset?: number): number[]
• toArray(dest: Float32Array, offset?: number): Float32Array

• Copies components out into an array or Float32Array

  ---

  Parameters

  • optionaldest: number[]

  • optionaloffset: number

  Returns number[]

publictoFloat32Array

• toFloat32Array(): Float32Array

• Converts to a Float32Array suitable for WebGL uniforms

  ---

  Returns Float32Array

publictoString

• toString(fixed?: number): string

• Returns a string representation of the vector.

  ---

  Parameters

  • optionalfixed: number

  Returns string

publictoVector3

• toVector3(): Vector3

• Projects back down to 3D via perspective divide (x/w, y/w, z/w)

  ---

  Returns Vector3

publictransform

• transform(matrix: Matrix, dest?: Vector4): Vector4

• Transforms this vector using a 4x4 Matrix

  ---

  Parameters

  • matrix: Matrix

  • optionaldest: Vector4

  Returns Vector4

publicstaticdistance

• distance(vec1: Vector4, vec2: Vector4): number

• Calculates distance between two Vectors

  ---

  Parameters

  • vec1: Vector4

  • vec2: Vector4

  Returns number

publicstaticfromArray

• fromArray(array: number[] | Float32Array<ArrayBufferLike>, offset?: number): Vector4

• Creates a Vector4 from an array [x, y, z, w]

  ---

  Parameters

  • array: number[] | Float32Array<ArrayBufferLike>

  • offset: number = 0

  Returns Vector4

publicstaticfromDirection

• fromDirection(v: Vector3): Vector4

• Creates a homogeneous direction vector (w = 0) from a Vector3

  ---

  Parameters

  • v: Vector3

  Returns Vector4

publicstaticfromPoint

• fromPoint(v: Vector3): Vector4

• Creates a homogeneous point vector (w = 1) from a Vector3

  ---

  Parameters

  • v: Vector3

  Returns Vector4

publicstaticisValid

• isValid(vec: Vector4): boolean

• Checks if vector is not null, undefined, or if any of its components are NaN or Infinity.

  ---

  Parameters

  • vec: Vector4

  Returns boolean

publicstaticmax

• max(vec1: Vector4, vec2: Vector4): Vector4

• Parameters

  • vec1: Vector4

  • vec2: Vector4

  Returns Vector4

publicstaticmin

• min(vec1: Vector4, vec2: Vector4): Vector4

• Parameters

  • vec1: Vector4

  • vec2: Vector4

  Returns Vector4