Class Vector4

Describes a 4D-vector.

Hierarchy

Vector4

Index

Constructors

Properties

_onValueChanged _w _x _y _z _one _zero

Accessors

w x y z

Constructors

constructor

new Vector4(x?: number, y?: number, z?: number, w?: number): Vector4
Constructor of Vector4.
Parameters
- x: number = 0
  
  The x component of the vector, default 0
- y: number = 0
  
  The y component of the vector, default 0
- z: number = 0
  
  The z component of the vector, default 0
- w: number = 0
  
  The w component of the vector, default 0
Returns Vector4
- Defined in math/Vector4.ts:321

Properties

_onValueChanged

_onValueChanged: (() => void) = null

Type declaration

- (): void
- Internal
  Returns void

`Internal` _w

_w: number

`Internal` _x

_x: number

`Internal` _y

_y: number

`Internal` _z

_z: number

`Static` `Readonly` `Internal` _one

_one: Vector4 = ...

`Static` `Readonly` `Internal` _zero

_zero: Vector4 = ...

Accessors

w

get w(): number
The w component of the vector.

Returns number
- Defined in math/Vector4.ts:305
set w(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector4.ts:309

x

get x(): number
The x component of the vector.

Returns number
- Defined in math/Vector4.ts:269
set x(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector4.ts:273

y

get y(): number
The y component of the vector.

Returns number
- Defined in math/Vector4.ts:281
set y(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector4.ts:285

z

get z(): number
The z component of the vector.

Returns number
- Defined in math/Vector4.ts:293
set z(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector4.ts:297

Methods

add

add(right: Vector4): Vector4
Determines the sum of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector4
  
  The specified vector
Returns Vector4
- Defined in math/Vector4.ts:365

clone

clone(): Vector4
Creates a clone of this vector.

Returns
A clone of this vector

Returns Vector4
- Defined in math/Vector4.ts:486

cloneTo

cloneTo(out: Vector4): Vector4
Clones this vector to the specified vector.

Returns
The specified vector
Parameters
- out: Vector4
  
  The specified vector
Returns Vector4
- Defined in math/Vector4.ts:496

divide

divide(right: Vector4): Vector4
Determines the divisor of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector4
  
  the specified vector
Returns Vector4
- Defined in math/Vector4.ts:407

length

length(): number
Calculate the length of this vector.

Returns
The length of this vector

Returns number
- Defined in math/Vector4.ts:420

lengthSquared

lengthSquared(): number
Calculate the squared length of this vector.

Returns
The squared length of this vector

Returns number
- Defined in math/Vector4.ts:429

multiply

multiply(right: Vector4): Vector4
Determines the product of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector4
  
  the specified vector
Returns Vector4
- Defined in math/Vector4.ts:393

negate

negate(): Vector4
Reverses the direction of this vector.

Returns
This vector

Returns Vector4
- Defined in math/Vector4.ts:438

normalize

normalize(): Vector4
Converts this vector into a unit vector.

Returns
This vector

Returns Vector4
- Defined in math/Vector4.ts:451

scale

scale(s: number): Vector4
Scale this vector by the given value.

Returns
This vector
Parameters
- s: number
  
  The amount by which to scale the vector
Returns Vector4
- Defined in math/Vector4.ts:461

setValue

setValue(x: number, y: number, z: number, w: number): Vector4
Set the value of this vector.

Returns
This vector
Parameters
- x: number
  
  The x component of the vector
- y: number
  
  The y component of the vector
- z: number
  
  The z component of the vector
- w: number
  
  The w component of the vector
Returns Vector4
- Defined in math/Vector4.ts:336

setValueByArray

setValueByArray(array: ArrayLike<number>, offset?: number): Vector4
Set the value of this vector by an array.

Returns
This vector
Parameters
- array: ArrayLike<number>
  
  The array
- offset: number = 0
  
  The start offset of the array
Returns Vector4
- Defined in math/Vector4.ts:351

subtract

subtract(right: Vector4): Vector4
Determines the difference of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector4
  
  the specified vector
Returns Vector4
- Defined in math/Vector4.ts:379

toArray

toArray(out: Float32Array | Float64Array | number[], outOffset?: number): void
Clone the value of this vector to an array.
Parameters
- out: Float32Array | Float64Array | number[]
  
  The array
- outOffset: number = 0
  
  The start offset of the array
Returns void
- Defined in math/Vector4.ts:475

`Static` add

add(left: Vector4, right: Vector4, out: Vector4): void
Determines the sum of two vectors.
Parameters
- left: Vector4
  
  The first vector to add
- right: Vector4
  
  The second vector to add
- out: Vector4
  
  The sum of two vectors
Returns void
- Defined in math/Vector4.ts:20

`Static` distance

distance(a: Vector4, b: Vector4): number
Determines the distance of two vectors.

Returns
The distance of two vectors
Parameters
- a: Vector4
  
  The first vector
- b: Vector4
  
  The second vector
Returns number
- Defined in math/Vector4.ts:86

`Static` distanceSquared

distanceSquared(a: Vector4, b: Vector4): number
Determines the squared distance of two vectors.

Returns
The squared distance of two vectors
Parameters
- a: Vector4
  
  The first vector
- b: Vector4
  
  The second vector
Returns number
- Defined in math/Vector4.ts:100

`Static` divide

divide(left: Vector4, right: Vector4, out: Vector4): void
Determines the divisor of two vectors.
Parameters
- left: Vector4
  
  The first vector to divide
- right: Vector4
  
  The second vector to divide
- out: Vector4
  
  The divisor of two vectors
Returns void
- Defined in math/Vector4.ts:62

`Static` dot

dot(left: Vector4, right: Vector4): number
Determines the dot product of two vectors.

Returns
The dot product of two vectors
Parameters
- left: Vector4
  
  The first vector to dot
- right: Vector4
  
  The second vector to dot
Returns number
- Defined in math/Vector4.ts:76

`Static` equals

equals(left: Vector4, right: Vector4): boolean
Determines whether the specified vectors are equals.

Returns
True if the specified vectors are equals, false otherwise
Parameters
- left: Vector4
  
  The first vector to compare
- right: Vector4
  
  The second vector to compare
Returns boolean
- Defined in math/Vector4.ts:114

`Static` lerp

lerp(start: Vector4, end: Vector4, t: number, out: Vector4): void
Performs a linear interpolation between two vectors.
Parameters
- start: Vector4
  
  The first vector
- end: Vector4
  
  The second vector
- t: number
  
  The blend amount where 0 returns start and 1 end
- out: Vector4
  
  The result of linear blending between two vectors
Returns void
- Defined in math/Vector4.ts:130

`Static` max

max(left: Vector4, right: Vector4, out: Vector4): void
Calculate a vector containing the largest components of the specified vectors.
Parameters
- left: Vector4
  
  The first vector
- right: Vector4
  
  The second vector
- out: Vector4
  
  The vector containing the largest components of the specified vectors
Returns void
- Defined in math/Vector4.ts:145

`Static` min

min(left: Vector4, right: Vector4, out: Vector4): void
Calculate a vector containing the smallest components of the specified vectors.
Parameters
- left: Vector4
  
  The first vector
- right: Vector4
  
  The second vector
- out: Vector4
  
  The vector containing the smallest components of the specified vectors
Returns void
- Defined in math/Vector4.ts:159

`Static` multiply

multiply(left: Vector4, right: Vector4, out: Vector4): void
Determines the product of two vectors.
Parameters
- left: Vector4
  
  The first vector to multiply
- right: Vector4
  
  The second vector to multiply
- out: Vector4
  
  The product of two vectors
Returns void
- Defined in math/Vector4.ts:48

`Static` negate

negate(a: Vector4, out: Vector4): void
Reverses the direction of a given vector.
Parameters
- a: Vector4
  
  The vector to negate
- out: Vector4
  
  The vector facing in the opposite direction
Returns void
- Defined in math/Vector4.ts:172

`Static` normalize

normalize(a: Vector4, out: Vector4): void
Converts the vector into a unit vector.
Parameters
- a: Vector4
  
  The vector to normalize
- out: Vector4
  
  The normalized vector
Returns void
- Defined in math/Vector4.ts:185

`Static` scale

scale(a: Vector4, s: number, out: Vector4): void
Scale a vector by the given value.
Parameters
- a: Vector4
  
  The vector to scale
- s: number
  
  The amount by which to scale the vector
- out: Vector4
  
  The scaled vector
Returns void
- Defined in math/Vector4.ts:204

`Static` subtract

subtract(left: Vector4, right: Vector4, out: Vector4): void
Determines the difference between two vectors.
Parameters
- left: Vector4
  
  The first vector to subtract
- right: Vector4
  
  The second vector to subtract
- out: Vector4
  
  The difference between two vectors
Returns void
- Defined in math/Vector4.ts:34

`Static` transform

transform(v: Vector4, m: Matrix4, out: Vector4): void
Performs a transformation using the given 4x4 matrix.
Parameters
- v: Vector4
  
  The vector to transform
- m: Matrix4
  
  The transform matrix
- out: Vector4
  
  The transformed vector3
Returns void
- Defined in math/Vector4.ts:218

`Static` transformByQuat

transformByQuat(v: Vector4, q: Quaternion, out: Vector4): void
Performs a transformation using the given quaternion.
Parameters
- v: Vector4
  
  The vector to transform
- q: Quaternion
  
  The transform quaternion
- out: Vector4
  
  The transformed vector
Returns void
- Defined in math/Vector4.ts:234

Generated using TypeDoc