Class Vector3

The Vector3 implements a fixed-size three-dimensional vector. The class follows the 'copy-on-write' pattern, which means that every operation such as Vector3#normalized or Vector3.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 Vector3(x?: number, y?: number, z?: number): Vector3
Parameters
- Optionalx: number
- Optionaly: number
- Optionalz: number
Returns Vector3

Inherited from Vector3Generated.constructor

Properties

`Protected`_x

_x: number

`Protected`_y

_y: number

`Protected`_z

_z: number

`Static` `Readonly`one

one: Immutable<Vector3>

A Vector with all components set to one.

`Static` `Readonly`xAxis

xAxis: Immutable<Vector3>

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

`Static` `Readonly`yAxis

yAxis: Immutable<Vector3>

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

`Static` `Readonly`zAxis

zAxis: Immutable<Vector3>

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

`Static` `Readonly`zero

zero: Immutable<Vector3>

A Vector with all components set to zero.

Accessors

elementCount

get elementCount(): number

Gets the number of elements in this vector.

Returns number

isZero

get isZero(): boolean

Determines if this instance is zero length.

Returns boolean

x

get x(): number

Returns number

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

Inherited from Vector3Generated.x

y

get y(): number

Returns number

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

Inherited from Vector3Generated.y

z

get z(): number

Returns number

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

Inherited from Vector3Generated.z

Methods

add

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

addComponents

addComponents(x: number, y: number, z: number): Vector3
Returns a copy of the current vector added by the given components.
Parameters
- x: number
- y: number
- z: number
Returns Vector3

addScalar

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

addScaled

addScaled(rhs: Immutable<Vector3>, scale: number): Vector3
Adds two vectors together, a scale factor is applied to rhs before adding.
Parameters
- rhs: Immutable<Vector3>
- scale: number
Returns Vector3

assign

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

Inherited from Vector3Generated.assign

clone

clone(): Vector3

Clones this instance and returns a new Vector3 with identical values.

Returns Vector3

Inherited from Vector3Generated.clone

cross

cross(other: Immutable<Vector3>): Vector3
Calculates the cross product between this and the other vector.
Parameters
- other: Immutable<Vector3>
  Second three dimensional vector.
Returns Vector3
Cross product between two vectors.

directionTo

directionTo(position: Immutable<Vector3>): Vector3
Calculates the normalized direction vector from this to position.
Parameters
- position: Immutable<Vector3>
  Three dimensional position.
Returns Vector3
Directional vector from this to position.

distanceTo

distanceTo(position: Immutable<Vector3>): number
Calculates the distance to position.
Parameters
- position: Immutable<Vector3>
  Three dimensional position.
Returns number
Distance between the two points.

divide

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

divideScalar

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

doAdd

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

doAddComponents

doAddComponents(x: number, y: number, z: number): Vector3
Adds the specified components to the vector.
Parameters
- x: number
- y: number
- z: number
Returns Vector3

doAddScalar

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

doAddScaled

doAddScaled(rhs: Immutable<Vector3>, scale: number): Vector3
Adds another vector with a scale factor to this one and returns it.
Parameters
- rhs: Immutable<Vector3>
  The vector to add with scale applied.
- scale: number
  The scale factor to apply to the rhs vector.
Returns Vector3

Note
This operation is commonly called a multiply-add (MAD) operation. However, for clarity's sake, we call it addScaled.

doClear

doClear(): Vector3

Clears all elements of the vector to zero.

Returns Vector3

doDivide

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

doDivideScalar

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

doMultiply

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

doMultiplyScalar

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

doNegate

doNegate(): Vector3

Negates this instance and returns itself.

Returns Vector3

doNormalize

doNormalize(): number

Normalizes the vector.

Returns number

doSubtract

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

doSubtractScalar

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

dot

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

eval

eval(fnExpression: () => number): Vector3
Evaluates the expression and assigns it to the vector.
Parameters
- fnExpression: () => number
  The expression to evaluate.
Returns Vector3
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): number
Accesses a specific component of the vector.
Parameters
- index: number
  Index of the component.
Returns number
Value of the specific component.

getMaximumElement

getMaximumElement(): number

Gets the maximum element (non absolute).

Returns number

isAlmostEqual

isAlmostEqual(rhs: Immutable<Vector3>, epsilon?: number): boolean
Returns whether the provided vector, given a error margin, has the same vector components values as this one.
Parameters
- rhs: Immutable<Vector3>
  The other Vector3 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: Immutable<Vector3>): boolean
Returns whether the given vector contains the same vector components values as this one.
Parameters
- rhs: Immutable<Vector3>
Returns boolean

Overrides Vector3Generated.isEqual

length

length(): number

Computes the length of the vector.

Returns number

lengthSquared

lengthSquared(): number

Returns the squared length of the vector.

Returns number

multiply

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

multiplyScalar

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

negated

negated(): Vector3

Gets a negated copy of this instance.

Returns Vector3

normalized

normalized(): Vector3

Returns a normalized copy of the vector.

Returns Vector3

setElement

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

setElementAtIndex

setElementAtIndex(index: number, value: number): void
Sets a specific component of the vector.
Parameters
- index: number
  Index of the component.
- value: number
  The value to set.
Returns void

setValues

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

subtract

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

subtractScalar

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

toArray

toArray(): [number, number, number]

Converts this instance to an array with 3 elements.

Returns [number, number, number]

toFixed

toFixed(digits?: number): string
Parameters
- Optionaldigits: number
Returns string

toString

toString(): string

Returns a string representation of an object.

Returns string

`Static`add

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

`Static`addComponents

addComponents(lhs: Immutable<Vector3>, x: number, y: number, z: number): Vector3
Adds the specified components to the vector.
Parameters
- lhs: Immutable<Vector3>
- x: number
- y: number
- z: number
Returns Vector3

`Static`addScalar

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

`Static`addScaled

addScaled(
    lhs: Immutable<Vector3>,
    rhs: Immutable<Vector3>,
    scale: number,
): Vector3
Adds two vectors together, a scale factor is applied to rhs before adding.
Parameters
- lhs: Immutable<Vector3>
- rhs: Immutable<Vector3>
- scale: number
Returns Vector3

`Static`angleBetween

angleBetween(lhs: Immutable<Vector3>, rhs: Immutable<Vector3>): rsx.Radian
Returns the angle between two vectors in Radian.
Parameters
- lhs: Immutable<Vector3>
  First vector.
- rhs: Immutable<Vector3>
  Second vector.
Returns rsx.Radian
Angle between the two vectors.

Note
Both vectors must be unit-length normalized.

`Static`cross

cross(lhs: Immutable<Vector3>, rhs: Immutable<Vector3>): Vector3
Calculates the cross product between two vectors.
Parameters
- lhs: Immutable<Vector3>
  First three dimensional vector.
- rhs: Immutable<Vector3>
  Second three dimensional vector.
Returns Vector3
Cross product between two vectors.

`Static`distance

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

`Static`divide

divide(rhs: Immutable<Vector3>, lhs: Immutable<Vector3>): Vector3
Divides the given vector by another vector.
Parameters
- rhs: Immutable<Vector3>
- lhs: Immutable<Vector3>
Returns Vector3

`Static`divideScalar

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

`Static`dot

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

`Static`isAlmostEqual

isAlmostEqual(
    lhs: Immutable<Vector3>,
    rhs: Immutable<Vector3>,
    epsilon?: number,
): boolean
Compares two 3D vectors with an error margin.
Parameters
- lhs: Immutable<Vector3>
  First vector to compare.
- rhs: Immutable<Vector3>
  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: Immutable<Vector3>, rhs: Immutable<Vector3>): boolean
Returns whether all the vectors components contains the same values.
Parameters
- lhs: Immutable<Vector3>
- rhs: Immutable<Vector3>
Returns boolean

Overrides Vector3Generated.isEqual

`Static`lengthSquared

lengthSquared(vector: Immutable<Vector3>): number
Calculates the squared magnitude of the provided vector.
Parameters
- vector: Immutable<Vector3>
  Vector to calculate the magnitude for.
Returns number
Squared magnitude of the vector.

`Static`lerp

lerp(a: Immutable<Vector3>, b: Immutable<Vector3>, t: number): Vector3
Linearly interpolates between two values.
Parameters
- a: Immutable<Vector3>
  Starting value to interpolate from.
- b: Immutable<Vector3>
  Ending value to interpolate towards.
- t: number
  Interpolation factor in specified range.
Returns Vector3
Interpolated vector.

`Static`magnitude

magnitude(vector: Immutable<Vector3>): number
Calculates the magnitude of the provided vector.
Parameters
- vector: Immutable<Vector3>
  Vector to calculate the magnitude for.
Returns number
Magnitude of the vector.

`Static`max

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

`Static`min

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

`Static`multiply

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

`Static`multiplyScalar

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

`Static`orthogonalComplement

orthogonalComplement(x: Vector3, y: Vector3, z: Vector3): void
Calculates two vectors orthonormal to the first vector.
Parameters
- x: Vector3
  Normalized vector to calculate orthonormal vectors for.
- y: Vector3
  First orthonormal vector.
- z: Vector3
  Second orthonormal vector.
Returns void

`Static`orthonormalize

orthonormalize(x: Vector3, y: Vector3, z: Vector3): void
Performs Gram-Schmidt orthonormalization on the specified basis, making all the vectors normal and orthogonal to each other.
Parameters
- x: Vector3
  First vector to orthogonalize.
- y: Vector3
  Second vector to orthogonalize.
- z: Vector3
  Third vector to orthogonalize.
Returns void

`Static`subtract

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

`Static`subtractScalar

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

Class Vector3

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector3

Properties

Protected_x

Protected_y

Protected_z

Static Readonlyone

Static ReadonlyxAxis

Static ReadonlyyAxis

Static ReadonlyzAxis

Static Readonlyzero

Accessors

elementCount

Returns number

isZero

Returns boolean

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

z

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns Vector3

addComponents

Parameters

Returns Vector3

addScalar

Parameters

Returns Vector3

addScaled

Parameters

Returns Vector3

assign

Parameters

Returns Vector3

clone

Returns Vector3

cross

Parameters

Returns Vector3

directionTo

Parameters

Returns Vector3

distanceTo

Parameters

Returns number

divide

Parameters

Returns Vector3

divideScalar

Parameters

Returns Vector3

doAdd

Parameters

Returns Vector3

doAddComponents

Parameters

Returns Vector3

doAddScalar

Parameters

Returns Vector3

doAddScaled

Parameters

`Protected`_x

`Protected`_y

`Protected`_z

`Static` `Readonly`one

`Static` `Readonly`xAxis

`Static` `Readonly`yAxis

`Static` `Readonly`zAxis

`Static` `Readonly`zero