Class Vector4

A vector with 4 components, labeled: X, Y, Z, W.

Hierarchy (View Summary)

Vector4
- Quaternion

Index

Constructors

Properties

k

Accessors

w x y z

Methods

add3 add3XYZ addMultiply3 addMultiply3XYZ clamp divide3 divide3Scale divide3XYZ invertAdd3 invertMultiply3 lerp multiply3 multiply3Scale multiply3XYZ set setXYZW subtract3 subtract3XYZ fromVector4

Constructors

constructor

new Vector4(x: number, y: number, z: number, w: number): Vector4
Constructs a new Vector4.
Parameters
- x: number
  The X component.
- y: number
  The Y component.
- z: number
  The Z component.
- w: number
  The W component.
Returns Vector4
- Defined in source/math/vector4.ts:73

Properties

k

k: number[] = ...

The components of the vector.

Accessors

w

get w(): number
Get the W component of the vector.

Returns number
The W component of the vector.
- Defined in source/math/vector4.ts:56
set w(value: number): void
Set the W component of the vector.
Parameters
- value: number
Returns void
- Defined in source/math/vector4.ts:62

x

get x(): number
Get the X component of the vector.

Returns number
The X component of the vector.
- Defined in source/math/vector4.ts:14
set x(value: number): void
Set the X component of the vector.
Parameters
- value: number
Returns void
- Defined in source/math/vector4.ts:20

y

get y(): number
Get the Y component of the vector.

Returns number
The Y component of the vector.
- Defined in source/math/vector4.ts:28
set y(value: number): void
Set the Y component of the vector.
Parameters
- value: number
Returns void
- Defined in source/math/vector4.ts:34

z

get z(): number
Get the Z component of the vector.

Returns number
The Z component of the vector.
- Defined in source/math/vector4.ts:42
set z(value: number): void
Set the Z component of the vector.
Parameters
- value: number
Returns void
- Defined in source/math/vector4.ts:48

Methods

add3

add3(vector: Readonly<Vector4>): this
Adds the XYZ components of another vector to this vector.
Parameters
- vector: Readonly<Vector4>
  The vector to add to this vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:119

add3XYZ

add3XYZ(x: number, y: number, z: number): this
Adds the XYZ components of another vector to this vector.
Parameters
- x: number
  The value to add to the X component.
- y: number
  The value to add to the Y component.
- z: number
  The value to add to the Z component.
Returns this
This instance.
- Defined in source/math/vector4.ts:130

addMultiply3

addMultiply3(vector: Readonly<Vector4>, scale: number): this
Scales another vector and adds its XYZ components to this vector.
Parameters
- vector: Readonly<Vector4>
  The vector to add to this vector.
- scale: number
  The scaling to apply to the input vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:143

addMultiply3XYZ

addMultiply3XYZ(x: number, y: number, z: number, scale: number): this
Scales another vector and adds its XYZ components to this vector.
Parameters
- x: number
  The value to add to the X component.
- y: number
  The value to add to the Y component.
- z: number
  The value to add to the Z component.
- scale: number
  The scaling to apply to the input vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:155

clamp

clamp(floor: number, ceil: number): this
Clamps the components of the vector at the given boundary.
Parameters
- floor: number
  The lowest value to allow.
- ceil: number
  The largest value to allow.
Returns this
This instance.
- Defined in source/math/vector4.ts:283

divide3

divide3(vector: Readonly<Vector4>): this
Divides the XYZ components of this vector by another vector.
Parameters
- vector: Readonly<Vector4>
  The vector to divide this vector with.
Returns this
This instance.
- Defined in source/math/vector4.ts:225

divide3Scale

divide3Scale(scale: number): this
Divides the XYZ components of the vector by the given scale.
Parameters
- scale: number
  The scaling to apply to the vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:248

divide3XYZ

divide3XYZ(x: number, y: number, z: number): this
Divides the XYZ components of this vector by another vector.
Parameters
- x: number
  The value to divide the X component with.
- y: number
  The value to divide the Y component with.
- z: number
  The value to divide the Z component with.
Returns this
This instance.
- Defined in source/math/vector4.ts:236

invertAdd3

invertAdd3(): this
Inverts the direction of the vector.

Returns this
This instance.
- Defined in source/math/vector4.ts:259

invertMultiply3

invertMultiply3(): this
Inverts the vectors scale.

Returns this
This instance.
- Defined in source/math/vector4.ts:270

lerp

lerp(vector: Readonly<Vector4>, t: number): this
Linearly moves this vector towards a target vector.
Parameters
- vector: Readonly<Vector4>
  The target vector.
- t: number
  The location on the scale, from 0 to 1.
Returns this
This instance.
- Defined in source/math/vector4.ts:317

multiply3

multiply3(vector: Readonly<Vector4>): this
Multiplies the XYZ components of this vector by another vector.
Parameters
- vector: Readonly<Vector4>
  The vector to multiply with this vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:190

multiply3Scale

multiply3Scale(scale: number): this
Multiplies the XYZ components of the vector by the given scale.
Parameters
- scale: number
  The scaling to apply to the vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:213

multiply3XYZ

multiply3XYZ(x: number, y: number, z: number): this
Multiplies the XYZ components of this vector by another vector.
Parameters
- x: number
  The value to multiply with the X component.
- y: number
  The value to multiply with the Y component.
- z: number
  The value to multiply with the Z component.
Returns this
This instance.
- Defined in source/math/vector4.ts:201

set

set(vector: Readonly<Vector4>): this
Sets the vector to new coordinates.
Parameters
- vector: Readonly<Vector4>
  The coordinates to set the vector to.
Returns this
This instance.
- Defined in source/math/vector4.ts:94

setXYZW

setXYZW(x: number, y: number, z: number, w: number): this
Sets the vector to new coordinates.
Parameters
- x: number
  The new X component for the vector.
- y: number
  The new Y component for the vector.
- z: number
  The new Z component for the vector.
- w: number
  The new W component for the vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:106

subtract3

subtract3(vector: Readonly<Vector4>): this
Subtracts the XYZ components of another vector from this vector.
Parameters
- vector: Readonly<Vector4>
  The vector to subtract from this vector.
Returns this
This instance.
- Defined in source/math/vector4.ts:167

subtract3XYZ

subtract3XYZ(x: number, y: number, z: number): this
Subtracts the XYZ components of another vector from this vector.
Parameters
- x: number
  The value to subtract from the X component.
- y: number
  The value to subtract from the Y component.
- z: number
  The value to subtract from the Z component.
Returns this
This instance.
- Defined in source/math/vector4.ts:178

`Static`fromVector4

fromVector4(vector: Readonly<Vector4>): Vector4
Creates a copy of another Vector4.
Parameters
- vector: Readonly<Vector4>
  The vector to copy.
Returns Vector4
A new vector.
- Defined in source/math/vector4.ts:85