Class Vector4

The Vector4 implements a fixed-size four-dimensional vector with a homogenous w coordinate. The class follows the 'copy-on-write' pattern, which means that every operation such as Vector4.normalized or Vector4.add returns a copy of the vector with updates values. It also implies that the values of the vector cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Constructors

constructor

new Vector4(x?, y?, z?, w?): Vector4
Parameters
- Optionalx: number
- Optionaly: number
- Optionalz: number
- Optionalw: number
Returns Vector4
Inherited from Vector4Generated.constructor

Properties

`Protected`_w

_w: number

`Protected`_x

_x: number

`Protected`_y

_y: number

`Protected`_z

_z: number

`Static` `Readonly`one

one: Immutable<Vector4>

A Vector with all components set to one.

`Static` `Readonly`wAxis

wAxis: Immutable<Vector4>

A Vector with the W component set to one and the rest set to zero.

`Static` `Readonly`xAxis

xAxis: Immutable<Vector4>

A Vector with the X component set to one and the rest set to zero.

`Static` `Readonly`yAxis

yAxis: Immutable<Vector4>

A Vector with the Y component set to one and the rest set to zero.

`Static` `Readonly`zAxis

zAxis: Immutable<Vector4>

A Vector with the Z component set to one and the rest set to zero.

`Static` `Readonly`zero

zero: Immutable<Vector4>

A Vector with all components set to zero.

Accessors

elementCount

get elementCount(): number
Gets the number of elements in this vector.

Returns number

w

get w(): number
Returns number
Inherited from Vector4Generated.w
set w(value): void
Parameters
- value: number
Returns void
Inherited from Vector4Generated.w

x

get x(): number
Returns number
Inherited from Vector4Generated.x
set x(value): void
Parameters
- value: number
Returns void
Inherited from Vector4Generated.x

y

get y(): number
Returns number
Inherited from Vector4Generated.y
set y(value): void
Parameters
- value: number
Returns void
Inherited from Vector4Generated.y

z

get z(): number
Returns number
Inherited from Vector4Generated.z
set z(value): void
Parameters
- value: number
Returns void
Inherited from Vector4Generated.z

Methods

add

add(rhs): Vector4
Returns a copy of the current vector added by the given one.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

addScalar

addScalar(rhs): Vector4
Returns a copy of the current vector added by the given scalar.
Parameters
- rhs: number
Returns Vector4

assign

assign(other): Vector4
Copies all properties defined by the prototype of Vector4 from other to this instance.
Parameters
- other: Immutable<Vector4>
Returns Vector4
Inherited from Vector4Generated.assign

clone

clone(): Vector4
Clones this instance and returns a new Vector4 with identical values.

Returns Vector4
Inherited from Vector4Generated.clone

divide

divide(rhs): Vector4
Returns a copy of the current vector divided by the given vector.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

divideScalar

divideScalar(factor): Vector4
Returns a copy of the current vector divided by a factor.
Parameters
- factor: number
Returns Vector4

doAdd

doAdd(rhs): Vector4
Adds another vector to this one and returns it.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

doAddScalar

doAddScalar(rhs): Vector4
Adds a scalar to this one and returns it.
Parameters
- rhs: number
Returns Vector4

doClear

doClear(): Vector4
Clears all elements of the vector to zero.

Returns Vector4

doDivide

doDivide(rhs): Vector4
Performs component-wise division with another vector.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

doDivideScalar

doDivideScalar(factor): Vector4
Divides this vector by a factor.
Parameters
- factor: number
Returns Vector4

doMultiply

doMultiply(rhs): Vector4
Performs component-wise multiplication with another vector.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

doMultiplyScalar

doMultiplyScalar(factor): Vector4
Performs scalar multiplication of this vector and returns it.
Parameters
- factor: number
Returns Vector4

doNormalize

doNormalize(): number
Normalizes the vector.

Returns number

doSubtract

doSubtract(rhs): Vector4
Subtracts another vector from this one and returns it.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

doSubtractScalar

doSubtractScalar(rhs): Vector4
Subtracts a scalar from this one and returns it.
Parameters
- rhs: number
Returns Vector4

dot

dot(other): number
Calculates the inner product of this and the other vector.
Parameters
- other: Immutable<Vector4>
  Second four dimensional vector.
Returns number
Inner product between the two vectors.

eval

eval(fnExpression): Vector4
Evaluates the expression and assigns it to the vector.
Parameters
- fnExpression: (() => number)
  The expression to evaluate.
  - - (): number
    - Returns number
Returns Vector4
A reference to this vector

Note
Make sure to read up on how Vector expressions work in Typescript.

See
MathEx.eval for detailed documentation, limitations and considerations.

getElementAtIndex

getElementAtIndex(index): number
Accesses a specific component of the vector.
Parameters
- index: number
  Index of the component.
Returns number
Value of the specific component.

isAlmostEqual

isAlmostEqual(rhs, epsilon?): boolean
Returns whether the provided vector, given a error margin, has the same vector components values as this one.
Parameters
- rhs: Immutable<Vector4>
  The other Vector4 to compare with.
- Optionalepsilon: number
  Optional. Error margin within which the numbers should be considered equal.
Returns boolean
True if equal, false otherwise.

isEqual

isEqual(rhs): boolean
Returns whether the given vector contains the same vector components values as this one.
Parameters
- rhs: Immutable<Vector4>
Returns boolean
Overrides Vector4Generated.isEqual

length

length(): number
Returns the length of the vector.

Returns number

lengthSquared

lengthSquared(): number
Returns the squared length of the vector.

Returns number

multiply

multiply(rhs): Vector4
Returns a copy of the current vector multiplied by the given vector.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

multiplyScalar

multiplyScalar(factor): Vector4
Returns a copy of this vector multiplied by the factor.
Parameters
- factor: number
Returns Vector4

normalized

normalized(): Vector4
Returns a normalized copy of the vector.

Returns Vector4

setElementAtIndex

setElementAtIndex(index, value): void
Assigns the value to the element at the specified index.
Parameters
- index: number
- value: number
Returns void

setValues

setValues(x, y, z, w): void
Assigns the specified values.
Parameters
- x: number
- y: number
- z: number
- w: number
Returns void

subtract

subtract(rhs): Vector4
Returns a copy of the current vector subtracted by the given vector.
Parameters
- rhs: Immutable<Vector4>
Returns Vector4

subtractScalar

subtractScalar(rhs): Vector4
Returns a copy of the current vector subtracted by the given vector.
Parameters
- rhs: number
Returns Vector4

toArray

toArray(): [number, number, number, number]
Converts this instance to an array with 4 elements.

Returns [number, number, number, number]

toString

toString(): string
Returns a string representation of an object.

Returns string

toVector3

toVector3(): Vector3
Converts this instance to a Vector3.

Returns Vector3

`Static`add

add(lhs, rhs): Vector4
Adds two vectors together.
Parameters
- lhs: Immutable<Vector4>
- rhs: Immutable<Vector4>
Returns Vector4

`Static`addScalar

addScalar(lhs, rhs): Vector4
Adds a scalar to each element of the vector.
Parameters
- lhs: Immutable<Vector4>
- rhs: number
Returns Vector4

`Static`distance

distance(lhs, rhs): number
Calculates the distance between two points.
Parameters
- lhs: Immutable<Vector4>
  First four dimensional point.
- rhs: Immutable<Vector4>
  Second four dimensional point.
Returns number
Distance between the two points.

`Static`divide

divide(lhs, rhs): Vector4
Divides one vector by another.
Parameters
- lhs: Immutable<Vector4>
- rhs: Immutable<Vector4>
Returns Vector4

`Static`divideScalar

divideScalar(rhs, factor): Vector4
Divides the given vector by a factor.
Parameters
- rhs: Immutable<Vector4>
- factor: number
Returns Vector4

`Static`dot

dot(lhs, rhs): number
Calculates the inner product of the two vectors.
Parameters
- lhs: Immutable<Vector4>
  First four dimensional vector.
- rhs: Immutable<Vector4>
  Second four dimensional vector.
Returns number
Inner product between the two vectors.

`Static`isAlmostEqual

isAlmostEqual(lhs, rhs, epsilon?): boolean
Compares two 4D vectors with an error margin.
Parameters
- lhs: Immutable<Vector4>
  First vector to compare.
- rhs: Immutable<Vector4>
  Second vector to compare.
- Optionalepsilon: number
  Optional. Error margin within which the numbers should be considered equal.
Returns boolean
True if equal, false otherwise.

`Static`isEqual

isEqual(lhs, rhs): boolean
Returns whether all the vectors components contains the same values.
Parameters
- lhs: Immutable<Vector4>
- rhs: Immutable<Vector4>
Returns boolean
Overrides Vector4Generated.isEqual

`Static`max

max(lhs, rhs): Vector4
Returns the maximum of all the vector components as a new vector.
Parameters
- lhs: Immutable<Vector4>
  First vector.
- rhs: Immutable<Vector4>
  Second vector.
Returns Vector4
Vector consisting of maximum components of the first and second vector.

`Static`min

min(lhs, rhs): Vector4
Returns the minimum of all the vector components as a new vector.
Parameters
- lhs: Immutable<Vector4>
  First vector.
- rhs: Immutable<Vector4>
  Second vector.
Returns Vector4
Vector consisting of minimum components of the first and second vector.

`Static`multiply

multiply(lhs, rhs): Vector4
Multiplies both vectors.
Parameters
- lhs: Immutable<Vector4>
- rhs: Immutable<Vector4>
Returns Vector4

`Static`multiplyScalar

multiplyScalar(lhs, factor): Vector4
Multiply the vector by the scalar.
Parameters
- lhs: Immutable<Vector4>
- factor: number
Returns Vector4

`Static`subtract

subtract(lhs, rhs): Vector4
Subtract both vectors.
Parameters
- lhs: Immutable<Vector4>
- rhs: Immutable<Vector4>
Returns Vector4

`Static`subtractScalar

subtractScalar(lhs, rhs): Vector4
Subtracts a scalar from each element of the vector.
Parameters
- lhs: Immutable<Vector4>
- rhs: number
Returns Vector4

Class Vector4

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector4

Properties

Protected_w

Protected_x

Protected_y

Protected_z

Static Readonlyone

Static ReadonlywAxis

Static ReadonlyxAxis

Static ReadonlyyAxis

Static ReadonlyzAxis

Static Readonlyzero

Accessors

elementCount

Returns number

w

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

z

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns Vector4

addScalar

Parameters

Returns Vector4

assign

Parameters

Returns Vector4

clone

Returns Vector4

divide

Parameters

Returns Vector4

divideScalar

Parameters

Returns Vector4

doAdd

Parameters

Returns Vector4

doAddScalar

Parameters

Returns Vector4

doClear

Returns Vector4

doDivide

Parameters

Returns Vector4

doDivideScalar

Parameters

Returns Vector4

doMultiply

Parameters

Returns Vector4

doMultiplyScalar

Parameters

Returns Vector4

doNormalize

Returns number

`Protected`_w

`Protected`_x

`Protected`_y

`Protected`_z

`Static` `Readonly`one

`Static` `Readonly`wAxis

`Static` `Readonly`xAxis

`Static` `Readonly`yAxis

`Static` `Readonly`zAxis

`Static` `Readonly`zero

`Static`add

`Static`addScalar

`Static`distance

`Static`divide

`Static`divideScalar

`Static`dot