Class Vector4

A four-component vector, such as a position with a w, an RGBA colour or a plane equation

Math methods work on all four components, change the vector they're called on and return it; pass an out point last to write the result there instead. Where a method takes a point, any PointData4D works, such as a plain { x, y, z, w } object.

Example

const clip = new Vector4(point.x, point.y, point.z, 1).applyMatrix4(camera.viewProjection);

if (clip.w > 0) clip.divideScalar(clip.w);

Implements

PointLike4D

Index

Constructors

constructor

new Vector4(x?: number, y?: number, z?: number, w?: number): Vector4
Creates a new Vector4
Parameters
- x: number = 0
  The x component
- y: number = 0
  The y component
- z: number = 0
  The z component
- w: number = 1
  The fourth component, defaults to 1
Returns Vector4

Properties

w

w: number = 1

The fourth component, by convention 1 for a position and 0 for a direction

Example

const behindCamera = clip.w <= 0;

x

x: number = 0

The x component

Example

const screenX = clip.x / clip.w;

y

y: number = 0

The y component

Example

const screenY = clip.y / clip.w;

z

z: number = 0

The z component

Example

const depth = clip.z / clip.w;

Accessors

`Static`shared

get shared(): Vector4
A static Vector4 reset to (0, 0, 0, 1) on every access, for a result used straight away

Important
This vector is shared and temporary. Do not store references to it.

Returns Vector4
Example
```
const clipW = Vector4.shared.set(point.x, point.y, point.z).applyMatrix4(camera.viewProjection).w;
```

Methods

add

add(v: PointData4D, out?: PointLike4D): this
Adds v to this vector
Parameters
- v: PointData4D
  The point to add
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
baseColor.add(hitFlash, displayColor);
```

addScaledVector

addScaledVector(v: PointData4D, s: number, out?: PointLike4D): this
Adds v * s to this vector
Parameters
- v: PointData4D
  The point to scale and add
- s: number
  The scalar applied to v
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
color.addScaledVector(colorStep, fadeSpeed * dt);
```

angleTo

angleTo(v: PointData4D): number
Computes the angle between this vector and v across all four components

Returns π/2 when either vector has zero length.
Parameters
- v: PointData4D
  The other vector
Returns number
The angle in radians, from 0 to π

applyMatrix4

applyMatrix4(m: Matrix4, out?: PointLike4D): this
Multiplies this vector by m, w included, without a divide

A position (w = 1) picks up the matrix's translation and a direction (w = 0) doesn't. With a projection matrix the result is in clip space; divide by w to get x and y from -1 to 1 across the view.
Parameters
- m: Matrix4
  The matrix to apply
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
clip.set(point.x, point.y, point.z).applyMatrix4(camera.viewProjection);
```

clamp

clamp(min: PointData4D, max: PointData4D, out?: PointLike4D): this
Clamps each component of this vector between the matching components of min and max

Assumes min <= max componentwise.
Parameters
- min: PointData4D
  The lower bound per component
- max: PointData4D
  The upper bound per component
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
hdrColor.clamp({ x: 0, y: 0, z: 0, w: 0 }, { x: 1, y: 1, z: 1, w: 1 }, displayColor);
```

clone

clone(): Vector4
Creates a copy of this vector

Returns Vector4
Example
```
const startColor = color.clone();
```

copyFrom

copyFrom(p: PointData4D): this
Copies x, y, z, w from the given point into this vector
Parameters
- p: PointData4D
  The point to copy from
Returns this
Example
```
previousClip.copyFrom(clip);
```
Implementation of PointLike4D.copyFrom

copyTo

copyTo<T extends PointLike4D>(p: T): T
Copies this vector's x, y, z, w into the given point
Type Parameters
- T extends PointLike4D
Parameters
- p: T
  The point to copy into
Returns T
The given point
Example
```
clip.copyTo(previousClip);
```
Implementation of PointLike4D.copyTo

distanceTo

distanceTo(v: PointData4D): number
Computes the distance from this vector to v across all four components
Parameters
- v: PointData4D
  The point to measure to
Returns number
Example
```
const colorDifference = pixel.distanceTo(keyColor);
```

distanceToSquared

distanceToSquared(v: PointData4D): number
Computes the squared distance from this vector to v

Cheaper than Vector4#distanceTo and enough to compare distances.
Parameters
- v: PointData4D
  The point to measure to
Returns number
Example
```
if (pixel.distanceToSquared(keyColor) < tolerance * tolerance) pixel.w = 0;
```

divide

divide(v: PointData4D, out?: PointLike4D): this
Divides each component of this vector by the matching component of v
Parameters
- v: PointData4D
  The point to divide by
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
hdrColor.divide(whitePoint, displayColor);
```

divideScalar

divideScalar(s: number, out?: PointLike4D): this
Divides each component of this vector by the scalar s
Parameters
- s: number
  The scalar to divide by
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
clip.divideScalar(clip.w);
```

dot

dot(v: PointData4D): number
Computes the dot product of this vector and v

With a plane (nx, ny, nz, d) whose normal has unit length and a point whose w is 1, it's the point's signed distance from the plane.
Parameters
- v: PointData4D
  The other vector
Returns number
Example
```
const inFront = clipPlane.dot(point) > 0;
```

equals

equals(p: PointData4D): boolean
Checks whether x, y, z and w all match p exactly, with no tolerance
Parameters
- p: PointData4D
  The point to compare against
Returns boolean
Example
```
if (!tint.equals(lastTint)) applyTint(tint);
```
Implementation of PointLike4D.equals

fromArray

fromArray(
array: Float32Array<ArrayBufferLike> | number[],
offset?: number,
): this
Reads x, y, z, w from array starting at offset
Parameters
- array: Float32Array<ArrayBufferLike> | number[]
  The source array
- offset: number = 0
  Index of the first component in array
Returns this
Example
```
tangent.fromArray(tangents, vertexIndex * 4);
```

magnitude

magnitude(): number

Computes the length of this vector across all four components

Returns number

magnitudeSquared

magnitudeSquared(): number
Computes the squared length of this vector

Cheaper than Vector4#magnitude, since it skips the square root, and enough to compare lengths.

Returns number
Example
```
const moving = velocity.magnitudeSquared() > 0.0001;
```

max

max(v: PointData4D, out?: PointLike4D): this
Sets each component to the larger of this vector's and v's
Parameters
- v: PointData4D
  The point to compare against
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
color.max({ x: 0, y: 0, z: 0, w: 0 });
```

min

min(v: PointData4D, out?: PointLike4D): this
Sets each component to the smaller of this vector's and v's
Parameters
- v: PointData4D
  The point to compare against
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
color.min({ x: 1, y: 1, z: 1, w: 1 });
```

multiply

multiply(v: PointData4D, out?: PointLike4D): this
Multiplies each component of this vector by the matching component of v
Parameters
- v: PointData4D
  The point to multiply by
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
baseColor.multiply(teamTint, displayColor);
```

multiplyScalar

multiplyScalar(s: number, out?: PointLike4D): this
Multiplies each component of this vector by the scalar s
Parameters
- s: number
  The scalar to multiply by
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
color.multiplyScalar(brightness);
```

negate

negate(out?: PointLike4D): this
Negates each component of this vector
Parameters
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
clipPlane.negate();
```

normalize

normalize(out?: PointLike4D): this
Scales this vector to unit length across all four components

A zero vector stays zero.
Parameters
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point

set

set(x?: number, y?: number, z?: number, w?: number): this
Sets all four components
Parameters
- x: number = 0
  The x component
- y: number = x
  The y component, defaults to x
- z: number = x
  The z component, defaults to x
- w: number = 1
  The fourth component, defaults to 1, not to x
Returns this
Example
```
position.set(0, 2, -5);
direction.set(0, 0, -1, 0);
```
Implementation of PointLike4D.set

setLength

setLength(length: number, out?: PointLike4D): this
Scales this vector so its length across all four components equals length

A zero vector stays zero.
Parameters
- length: number
  The target length
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point

subtract

subtract(v: PointData4D, out?: PointLike4D): this
Subtracts v from this vector
Parameters
- v: PointData4D
  The point to subtract
- out: PointLike4D = ...
  The target to write the result into, defaults to this vector
Returns this
The out point
Example
```
targetColor.subtract(color, colorStep);
```

toArray

toArray<T extends Float32Array<ArrayBufferLike> | number[] = number[]>(
array?: T,
offset?: number,
): T
Writes this vector's values into array starting at offset
Type Parameters
- T extends Float32Array<ArrayBufferLike> | number[] = number[]
Parameters
- array: T = ...
  The destination array; a new one is allocated when omitted
- offset: number = 0
  Index of the first component in array
Returns T
The destination array
Example
```
color.toArray(instanceColors, instanceIndex * 4);
```

toString

toString(): string
Builds a debug string for this vector

Returns string
A string of the form [@pixi/3d/math:Vector4 x=... y=... z=... w=...]
Example
```
console.log(clip.toString());
```

Class Vector4

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector4

Properties

w

Example

x

Example

y

Example

z

Example

Accessors

Staticshared

Returns Vector4

Example

Methods

add

Parameters

Returns this

Example

addScaledVector

Parameters

Returns this

Example

angleTo

Parameters

Returns number

applyMatrix4

Parameters

Returns this

Example

clamp

Parameters

Returns this

Example

clone

Returns Vector4

Example

copyFrom

Parameters

Returns this

Example

copyTo

Type Parameters

Parameters

Returns T

Example

distanceTo

Parameters

Returns number

Example

distanceToSquared

Parameters

Returns number

Example

divide

Parameters

Returns this

Example

divideScalar

Parameters

Returns this

Example

dot

Parameters

Returns number

Example

equals

Parameters

Returns boolean

`Static`shared