Interface IMutableVector4

Interface for mutable 4D vectors. Provides in-place operations for 4-component vectors including 3D normalization.

interface IMutableVector4 {
    _v: TypedArray;
    bytesPerComponent: number;
    className: string;
    glslStrAsFloat: string;
    glslStrAsInt: string;
    w: number;
    wgslStrAsFloat: string;
    wgslStrAsInt: string;
    x: number;
    y: number;
    z: number;
    add(vec: IVector4): IMutableVector4;
    at(i: number): number;
    clone(): IMutableVector4;
    copyComponents(vec: IVector4): IMutableVector4;
    divide(value: number): IMutableVector4;
    divideVector(vec: IVector4): IMutableVector4;
    dot(vec: IVector4): number;
    flattenAsArray(): number[];
    isDummy(): boolean;
    isEqual(vec: IVector4, delta?: number): boolean;
    isStrictEqual(vec: IVector4): boolean;
    isTheSourceSame(arrayBuffer: ArrayBuffer): boolean;
    length(): number;
    lengthSquared(): number;
    lengthTo(vec: IVector4): number;
    multiply(value: number): IMutableVector4;
    multiplyVector(vec: IVector4): IMutableVector4;
    normalize(): IMutableVector4;
    normalize3(): IMutableVector4;
    one(): IMutableVector4;
    raw(): TypedArray;
    setAt(i: number, value: number): IMutableVector4;
    setComponents(x: number, y: number, z: number, w: number): IMutableVector4;
    subtract(vec: IVector4): IMutableVector4;
    toString(): string;
    toStringApproximately(): string;
    v(i: number): number;
    zero(): IMutableVector4;
}

Hierarchy (view full)

IMutableVector
- IMutableVector4

Implemented by

Properties

_v

_v: TypedArray

The underlying typed array containing vector components (mutable)

`Readonly`bytesPerComponent

bytesPerComponent: number

Number of bytes per component in the underlying array

`Readonly`className

className: string

The class name identifier

`Readonly`glslStrAsFloat

glslStrAsFloat: string

GLSL string representation for float type

`Readonly`glslStrAsInt

glslStrAsInt: string

GLSL string representation for integer type

w

w: number

The w component (mutable)

`Readonly`wgslStrAsFloat

wgslStrAsFloat: string

WGSL string representation for float type

`Readonly`wgslStrAsInt

wgslStrAsInt: string

WGSL string representation for integer type

x

x: number

The x component (mutable)

y

y: number

The y component (mutable)

z

z: number

The z component (mutable)

Methods

add

add(vec): IMutableVector4
Adds another Vector4 to this vector.
Parameters
- vec: IVector4
  Vector to add
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.add
- Defined in foundation/math/IVector.ts:1056

at

at(i): number
Gets component at index.
Parameters
- i: number
  Component index (0=x, 1=y, 2=z, 3=w)
Returns number
Component value
Overrides IMutableVector.at
- Defined in foundation/math/IVector.ts:961

clone

clone(): IMutableVector4
Creates a copy of this vector.

Returns IMutableVector4
New mutable Vector4 instance
- Defined in foundation/math/IVector.ts:993

copyComponents

copyComponents(vec): IMutableVector4
Copies components from another Vector4.
Parameters
- vec: IVector4
  Source vector
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.copyComponents
- Defined in foundation/math/IVector.ts:1025

divide

divide(value): IMutableVector4
Divides vector by scalar.
Parameters
- value: number
  Scalar divisor
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.divide
- Defined in foundation/math/IVector.ts:1084

divideVector

divideVector(vec): IMutableVector4
Divides vector component-wise by another Vector4.
Parameters
- vec: IVector4
  Vector to divide by
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.divideVector
- Defined in foundation/math/IVector.ts:1091

dot

dot(vec): number
Calculates dot product with another Vector4.
Parameters
- vec: IVector4
  Other vector
Returns number
Dot product
Overrides IMutableVector.dot
- Defined in foundation/math/IVector.ts:987

flattenAsArray

flattenAsArray(): number[]
Converts the vector to a flat array.

Returns number[]
Array containing [x, y, z, w]
Overrides IMutableVector.flattenAsArray
- Defined in foundation/math/IVector.ts:933

isDummy

isDummy(): boolean
Checks if this is a dummy vector.

Returns boolean
True if dummy
Overrides IMutableVector.isDummy
- Defined in foundation/math/IVector.ts:939

isEqual

isEqual(vec, delta?): boolean
Checks equality with another Vector4 within tolerance.
Parameters
- vec: IVector4
  Vector to compare with
- Optionaldelta: number
  Optional tolerance
Returns boolean
True if approximately equal
Overrides IMutableVector.isEqual
- Defined in foundation/math/IVector.ts:947

isStrictEqual

isStrictEqual(vec): boolean
Checks strict equality with another Vector4.
Parameters
- vec: IVector4
  Vector to compare with
Returns boolean
True if exactly equal
Overrides IMutableVector.isStrictEqual
- Defined in foundation/math/IVector.ts:954

isTheSourceSame

isTheSourceSame(arrayBuffer): boolean
Checks if this vector shares the same source array buffer.
Parameters
- arrayBuffer: ArrayBuffer
  The array buffer to check
Returns boolean
True if using the same source buffer
Inherited from IMutableVector.isTheSourceSame
- Defined in foundation/math/IVector.ts:110

length

length(): number
Calculates vector length.

Returns number
Vector magnitude
Overrides IMutableVector.length
- Defined in foundation/math/IVector.ts:967

lengthSquared

lengthSquared(): number
Calculates squared length.

Returns number
Squared magnitude
Overrides IMutableVector.lengthSquared
- Defined in foundation/math/IVector.ts:973

lengthTo

lengthTo(vec): number
Calculates distance to another Vector4.
Parameters
- vec: IVector4
  Target vector
Returns number
Distance
Overrides IMutableVector.lengthTo
- Defined in foundation/math/IVector.ts:980

multiply

multiply(value): IMutableVector4
Multiplies vector by scalar.
Parameters
- value: number
  Scalar multiplier
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.multiply
- Defined in foundation/math/IVector.ts:1070

multiplyVector

multiplyVector(vec): IMutableVector4
Multiplies vector component-wise by another Vector4.
Parameters
- vec: IVector4
  Vector to multiply by
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.multiplyVector
- Defined in foundation/math/IVector.ts:1077

normalize

normalize(): IMutableVector4
Normalizes vector to unit length (4D normalization).

Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.normalize
- Defined in foundation/math/IVector.ts:1043

normalize3

normalize3(): IMutableVector4
Normalizes only the xyz components, leaving w unchanged (3D normalization).

Returns IMutableVector4
This vector for chaining
- Defined in foundation/math/IVector.ts:1049

one

one(): IMutableVector4
Sets vector to (1, 1, 1, 1).

Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.one
- Defined in foundation/math/IVector.ts:1037

raw

raw(): TypedArray
Gets the raw underlying typed array.

Returns TypedArray
The raw typed array
Overrides IMutableVector.raw
- Defined in foundation/math/IVector.ts:1000

setAt

setAt(i, value): IMutableVector4
Sets component at index.
Parameters
- i: number
  Component index (0=x, 1=y, 2=z, 3=w)
- value: number
  New value
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.setAt
- Defined in foundation/math/IVector.ts:1008

setComponents

setComponents(x, y, z, w): IMutableVector4
Sets all four components.
Parameters
- x: number
  X component value
- y: number
  Y component value
- z: number
  Z component value
- w: number
  W component value
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.setComponents
- Defined in foundation/math/IVector.ts:1018

subtract

subtract(vec): IMutableVector4
Subtracts another Vector4 from this vector.
Parameters
- vec: IVector4
  Vector to subtract
Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.subtract
- Defined in foundation/math/IVector.ts:1063

toString

toString(): string
Returns a string representation of the vector.

Returns string
String representation
Overrides IMutableVector.toString
- Defined in foundation/math/IVector.ts:921

toStringApproximately

toStringApproximately(): string
Returns an approximate string representation with rounded values.

Returns string
Approximate string representation
Overrides IMutableVector.toStringApproximately
- Defined in foundation/math/IVector.ts:927

v

v(i): number
Gets the component value at the specified index (alias for at).
Parameters
- i: number
  The component index
Returns number
The component value
Inherited from IMutableVector.v
- Defined in foundation/math/IVector.ts:77

zero

zero(): IMutableVector4
Sets vector to (0, 0, 0, 0).

Returns IMutableVector4
This vector for chaining
Overrides IMutableVector.zero
- Defined in foundation/math/IVector.ts:1031

Interface IMutableVector4

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

_v

ReadonlybytesPerComponent

ReadonlyclassName

ReadonlyglslStrAsFloat

ReadonlyglslStrAsInt

w

ReadonlywgslStrAsFloat

ReadonlywgslStrAsInt

x

y

z

Methods

add

Parameters

Returns IMutableVector4

at

Parameters

Returns number

clone

Returns IMutableVector4

copyComponents

Parameters

Returns IMutableVector4

divide

Parameters

Returns IMutableVector4

divideVector

Parameters

Returns IMutableVector4

dot

Parameters

Returns number

flattenAsArray

Returns number[]

isDummy

Returns boolean

isEqual

Parameters

Returns boolean

isStrictEqual

Parameters

Returns boolean

isTheSourceSame

Parameters

Returns boolean

length

Returns number

lengthSquared

Returns number

lengthTo

Parameters

Returns number

multiply

Parameters

Returns IMutableVector4

multiplyVector

Parameters

Returns IMutableVector4

normalize

Returns IMutableVector4

normalize3

Returns IMutableVector4

one

Returns IMutableVector4

raw

Returns TypedArray

setAt

Parameters

Returns IMutableVector4

setComponents

Parameters

Returns IMutableVector4

subtract

`Readonly`bytesPerComponent

`Readonly`className

`Readonly`glslStrAsFloat

`Readonly`glslStrAsInt

`Readonly`wgslStrAsFloat

`Readonly`wgslStrAsInt