Interface IMutableScalar

Interface for mutable scalar values.

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

Hierarchy (view full)

IMutableVector
- IMutableScalar

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`wgslStrAsFloat

wgslStrAsFloat: string

WGSL string representation for float type

`Readonly`wgslStrAsInt

wgslStrAsInt: string

WGSL string representation for integer type

`Readonly`x

x: number

The scalar value (x component)

Methods

add

add(vec): IMutableVector
Adds another vector to this vector.
Parameters
- vec: any
  The vector to add
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.add
- Defined in foundation/math/IVector.ts:174

at

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

copyComponents

copyComponents(vec): IMutableVector
Copies components from another vector.
Parameters
- vec: any
  The source vector
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.copyComponents
- Defined in foundation/math/IVector.ts:149

divide

divide(value): IMutableVector
Divides this vector by a scalar value.
Parameters
- value: number
  The scalar divisor
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.divide
- Defined in foundation/math/IVector.ts:202

divideVector

divideVector(vec): IMutableVector
Divides this vector component-wise by another vector.
Parameters
- vec: any
  The vector to divide by
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.divideVector
- Defined in foundation/math/IVector.ts:209

dot

dot(vec): number
Calculates the dot product with another vector.
Parameters
- vec: IVector
  The other vector
Returns number
The dot product result
Inherited from IMutableVector.dot
- Defined in foundation/math/IVector.ts:103

flattenAsArray

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

Returns number[]
Array containing all vector components
Inherited from IMutableVector.flattenAsArray
- Defined in foundation/math/IVector.ts:42

isDummy

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

Returns boolean
True if this is a dummy vector
Inherited from IMutableVector.isDummy
- Defined in foundation/math/IVector.ts:48

isEqual

isEqual(vec, delta?): boolean
Checks if this vector is equal to another vector within a tolerance.
Parameters
- vec: IVector
  The vector to compare with
- Optionaldelta: number
  Optional tolerance value (default: small epsilon)
Returns boolean
True if vectors are approximately equal
Inherited from IMutableVector.isEqual
- Defined in foundation/math/IVector.ts:56

isStrictEqual

isStrictEqual(vec): boolean
Checks if this vector is strictly equal to another vector.
Parameters
- vec: IVector
  The vector to compare with
Returns boolean
True if vectors are exactly equal
Inherited from IMutableVector.isStrictEqual
- Defined in foundation/math/IVector.ts:63

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 the length (magnitude) of the vector.

Returns number
The vector length
Inherited from IMutableVector.length
- Defined in foundation/math/IVector.ts:83

lengthSquared

lengthSquared(): number
Calculates the squared length of the vector (faster than length).

Returns number
The squared vector length
Inherited from IMutableVector.lengthSquared
- Defined in foundation/math/IVector.ts:89

lengthTo

lengthTo(vec): number
Calculates the distance to another vector.
Parameters
- vec: IVector
  The target vector
Returns number
The distance between vectors
Inherited from IMutableVector.lengthTo
- Defined in foundation/math/IVector.ts:96

multiply

multiply(value): IMutableVector
Multiplies this vector by a scalar value.
Parameters
- value: number
  The scalar multiplier
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.multiply
- Defined in foundation/math/IVector.ts:188

multiplyVector

multiplyVector(vec): IMutableVector
Multiplies this vector component-wise by another vector.
Parameters
- vec: any
  The vector to multiply by
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.multiplyVector
- Defined in foundation/math/IVector.ts:195

normalize

normalize(): IMutableVector
Normalizes the vector to unit length.

Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.normalize
- Defined in foundation/math/IVector.ts:167

one

one(): IMutableVector
Sets all components to one.

Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.one
- Defined in foundation/math/IVector.ts:161

raw

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

Returns TypedArray
The raw typed array
Inherited from IMutableVector.raw
- Defined in foundation/math/IVector.ts:127

setAt

setAt(i, value): IMutableVector
Sets the component value at the specified index.
Parameters
- i: number
  The component index
- value: number
  The new value
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.setAt
- Defined in foundation/math/IVector.ts:135

setComponents

setComponents(...num): IMutableVector
Sets all components of the vector.
Parameters
- Rest...num: number[]
  The component values
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.setComponents
- Defined in foundation/math/IVector.ts:142

subtract

subtract(vec): IMutableVector
Subtracts another vector from this vector.
Parameters
- vec: any
  The vector to subtract
Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.subtract
- Defined in foundation/math/IVector.ts:181

toString

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

Returns string
String representation of the vector
Inherited from IMutableVector.toString
- Defined in foundation/math/IVector.ts:30

toStringApproximately

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

Returns string
Approximate string representation
Inherited from IMutableVector.toStringApproximately
- Defined in foundation/math/IVector.ts:36

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(): IMutableVector
Sets all components to zero.

Returns IMutableVector
This vector for method chaining
Inherited from IMutableVector.zero
- Defined in foundation/math/IVector.ts:155

Interface IMutableScalar

Hierarchy (view full)

Index

Properties

Methods

Properties

_v

ReadonlybytesPerComponent

ReadonlyclassName

ReadonlyglslStrAsFloat

ReadonlyglslStrAsInt

ReadonlywgslStrAsFloat

ReadonlywgslStrAsInt

Readonlyx

Methods

add

Parameters

Returns IMutableVector

at

Parameters

Returns number

copyComponents

Parameters

Returns IMutableVector

divide

Parameters

Returns IMutableVector

divideVector

Parameters

Returns IMutableVector

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 IMutableVector

multiplyVector

Parameters

Returns IMutableVector

normalize

Returns IMutableVector

one

Returns IMutableVector

raw

Returns TypedArray

setAt

Parameters

Returns IMutableVector

setComponents

Parameters

Returns IMutableVector

subtract

Parameters

Returns IMutableVector

toString

Returns string

toStringApproximately

Returns string

v

Parameters

`Readonly`bytesPerComponent

`Readonly`className

`Readonly`glslStrAsFloat

`Readonly`glslStrAsInt

`Readonly`wgslStrAsFloat

`Readonly`wgslStrAsInt

`Readonly`x