Interface IMutableVector3

Interface for mutable 3D vectors. Provides in-place operations for 3-component vectors including cross product and quaternion multiplication.

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

Hierarchy (view full)

IMutableVector
- IMutableVector3

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

`Readonly`w

w: number

The w component (homogeneous coordinate, read-only)

`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): IMutableVector3
Adds another Vector3 to this vector.
Parameters
- vec: IVector3
  Vector to add
Returns IMutableVector3
This vector for chaining
Overrides IMutableVector.add
- Defined in foundation/math/IVector.ts:751

at

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

clone

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

Returns IMutableVector3
New mutable Vector3 instance
- Defined in foundation/math/IVector.ts:695

copyComponents

copyComponents(vec): IMutableVector3
Copies components from another Vector3.
Parameters
- vec: IVector3
  Source vector
Returns IMutableVector3
This vector for chaining
Overrides IMutableVector.copyComponents
- Defined in foundation/math/IVector.ts:726

cross

cross(vec): IMutableVector3
Calculates the cross product with another Vector3.
Parameters
- vec: IVector3
  Vector to cross with
Returns IMutableVector3
This vector for chaining
- Defined in foundation/math/IVector.ts:793

divide

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

divideVector

divideVector(vec): IMutableVector3
Divides vector component-wise by another Vector3.
Parameters
- vec: IVector3
  Vector to divide by
Returns IMutableVector3
This vector for chaining
Overrides IMutableVector.divideVector
- Defined in foundation/math/IVector.ts:786

dot

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

flattenAsArray

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

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

isDummy

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

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

isEqual

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

isStrictEqual

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

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:669

lengthSquared

lengthSquared(): number
Calculates squared length.

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

lengthTo

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

multiply

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

multiplyQuaternion

multiplyQuaternion(quat): IMutableVector3
Multiplies this vector by a quaternion rotation.
Parameters
- quat: IQuaternion
  Quaternion to multiply by
Returns IMutableVector3
This vector for chaining
- Defined in foundation/math/IVector.ts:800

multiplyVector

multiplyVector(vec): IMutableVector3
Multiplies vector component-wise by another Vector3.
Parameters
- vec: IVector3
  Vector to multiply by
Returns IMutableVector3
This vector for chaining
Overrides IMutableVector.multiplyVector
- Defined in foundation/math/IVector.ts:772

normalize

normalize(): IMutableVector3
Normalizes vector to unit length.

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

one

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

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

raw

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

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

setAt

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

setComponents

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

subtract

subtract(vec): IMutableVector3
Subtracts another Vector3 from this vector.
Parameters
- vec: IVector3
  Vector to subtract
Returns IMutableVector3
This vector for chaining
Overrides IMutableVector.subtract
- Defined in foundation/math/IVector.ts:758

toString

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

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

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:629

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(): IMutableVector3
Sets vector to (0, 0, 0).

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

Interface IMutableVector3

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

_v

ReadonlybytesPerComponent

ReadonlyclassName

ReadonlyglslStrAsFloat

ReadonlyglslStrAsInt

Readonlyw

ReadonlywgslStrAsFloat

ReadonlywgslStrAsInt

x

y

z

Methods

add

Parameters

Returns IMutableVector3

at

Parameters

Returns number

clone

Returns IMutableVector3

copyComponents

Parameters

Returns IMutableVector3

cross

Parameters

Returns IMutableVector3

divide

Parameters

Returns IMutableVector3

divideVector

Parameters

Returns IMutableVector3

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 IMutableVector3

multiplyQuaternion

Parameters

Returns IMutableVector3

multiplyVector

Parameters

Returns IMutableVector3

normalize

Returns IMutableVector3

one

Returns IMutableVector3

raw

Returns TypedArray

setAt

Parameters

Returns IMutableVector3

`Readonly`bytesPerComponent

`Readonly`className

`Readonly`glslStrAsFloat

`Readonly`glslStrAsInt

`Readonly`w

`Readonly`wgslStrAsFloat

`Readonly`wgslStrAsInt