Class MutableScalar_<T>`Internal`

Base class for mutable scalar values with typed array backing. This class extends the immutable Scalar_ class to provide mutable operations.

Type Parameters

T extends TypedArrayConstructor
The typed array constructor type (Float32Array, Float64Array, etc.)

Hierarchy (view full)

Scalar_<T>
- MutableScalar_
  - MutableScalar
  - MutableScalard

Index

Constructors

constructor

new MutableScalar_<T>(x, options): MutableScalar_<T>
Creates a new mutable scalar with the specified value and type.
Type Parameters
- T extends TypedArrayConstructor
Parameters
- x: TypedArray
  The typed array containing the scalar value
- options: {
  type: T;
  }
  Configuration object containing the array type
  - type: T
    The typed array constructor to use
Returns MutableScalar_<T>
Overrides Scalar_.constructor
- Defined in foundation/math/MutableScalar.ts:18

Properties

_v

_v: TypedArray = ...

Internal typed array storage for vector components

Accessors

bytesPerComponent

get bytesPerComponent(): number
Gets the number of bytes per component in the underlying typed array.

Returns number
The number of bytes per element
Overrides Scalar_.bytesPerComponent
- Defined in foundation/math/MutableScalar.ts:100

className

get className(): string
Gets the class name of this vector instance.

Returns string
The constructor name of the class
Inherited from Scalar_.className
- Defined in foundation/math/AbstractVector.ts:191

glslStrAsFloat

get glslStrAsFloat(): string
Gets the scalar value as a GLSL-compatible float string.

Returns string
The scalar value formatted as a GLSL float literal
Inherited from Scalar_.glslStrAsFloat
- Defined in foundation/math/Scalar.ts:93

glslStrAsInt

get glslStrAsInt(): string
Gets the scalar value as a GLSL-compatible integer string.

Returns string
The scalar value formatted as a GLSL integer literal
Inherited from Scalar_.glslStrAsInt
- Defined in foundation/math/Scalar.ts:101

raw

get raw(): TypedArray
Gets the raw typed array containing the scalar value.

Returns TypedArray
The underlying typed array
Inherited from Scalar_.raw
- Defined in foundation/math/Scalar.ts:57

w

get w(): number
Gets the w component (always 1 for scalars).

Returns number
Always returns 1
- Defined in foundation/math/MutableScalar.ts:66

wgslStrAsFloat

get wgslStrAsFloat(): string
Gets the scalar value as a WGSL-compatible float string.

Returns string
The scalar value formatted as a WGSL float literal
Inherited from Scalar_.wgslStrAsFloat
- Defined in foundation/math/Scalar.ts:109

wgslStrAsInt

get wgslStrAsInt(): string
Gets the scalar value as a WGSL-compatible integer string.

Returns string
The scalar value formatted as a WGSL integer literal
Inherited from Scalar_.wgslStrAsInt
- Defined in foundation/math/Scalar.ts:117

x

get x(): number
Gets the x component (scalar value).

Returns number
The scalar value
Overrides Scalar_.x
- Defined in foundation/math/MutableScalar.ts:34
set x(x): void
Sets the x component (scalar value).
Parameters
- x: number
  The new scalar value
Returns void
Overrides Scalar_.x
- Defined in foundation/math/MutableScalar.ts:42

y

get y(): number
Gets the y component (always 0 for scalars).

Returns number
Always returns 0
- Defined in foundation/math/MutableScalar.ts:50

z

get z(): number
Gets the z component (always 0 for scalars).

Returns number
Always returns 0
- Defined in foundation/math/MutableScalar.ts:58

`Static`compositionType

get compositionType(): CompositionTypeClass<"SCALAR">
Gets the composition type for this scalar.

Returns CompositionTypeClass<"SCALAR">
The scalar composition type
Overrides Scalar_.compositionType
- Defined in foundation/math/MutableScalar.ts:92

Methods

at

at(i): number
Gets the component value at the specified index.
Parameters
- i: number
  The index of the component to retrieve
Returns number
The component value at the given index
Inherited from Scalar_.at
- Defined in foundation/math/AbstractVector.ts:122

copyComponents

copyComponents(vec): void
Copies the components from another scalar to this scalar.
Parameters
- vec: Scalar_<T>
  The source scalar to copy from
Returns void
- Defined in foundation/math/MutableScalar.ts:26

dot

dot(vec): number
Calculates the dot product between this vector and another vector.
Parameters
- vec: IVector
  The vector to calculate dot product with
Returns number
The dot product result

Throws
Error - Must be implemented by subclasses
Inherited from Scalar_.dot
- Defined in foundation/math/AbstractVector.ts:113

flattenAsArray

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

Returns number[]
Array containing all vector components

Throws
Error - Must be implemented by subclasses
Inherited from Scalar_.flattenAsArray
- Defined in foundation/math/AbstractVector.ts:150

getValue

getValue(): number
Gets the scalar value as a number.

Returns number
The scalar value
Inherited from Scalar_.getValue
- Defined in foundation/math/Scalar.ts:33

getValueInArray

getValueInArray(): number[]
Gets the scalar value wrapped in an array.

Returns number[]
An array containing the scalar value
Inherited from Scalar_.getValueInArray
- Defined in foundation/math/Scalar.ts:41

isDummy

isDummy(): boolean
Checks if this vector is a dummy (empty) vector. A dummy vector has no components and is typically used as a placeholder.

Returns boolean
True if the vector is dummy, false otherwise
Inherited from Scalar_.isDummy
- Defined in foundation/math/AbstractVector.ts:159

isEqual

isEqual(scalar, delta?): boolean
Performs approximate equality comparison with another scalar within a tolerance.
Parameters
- scalar: Scalar_<T>
  The scalar to compare with
- delta: number = Number.EPSILON
  The tolerance for comparison (default: Number.EPSILON)
Returns boolean
True if the scalars are equal within the specified tolerance
Inherited from Scalar_.isEqual
- Defined in foundation/math/Scalar.ts:81

isStrictEqual

isStrictEqual(scalar): boolean
Performs strict equality comparison with another scalar. Uses exact floating-point comparison without tolerance.
Parameters
- scalar: Scalar_<T>
  The scalar to compare with
Returns boolean
True if the scalars are exactly equal, false otherwise
Inherited from Scalar_.isStrictEqual
- Defined in foundation/math/Scalar.ts:67

isTheSourceSame

isTheSourceSame(arrayBuffer): boolean
Checks if the internal storage shares the same ArrayBuffer as the provided one. Useful for determining if vectors share underlying memory.
Parameters
- arrayBuffer: ArrayBuffer
  The ArrayBuffer to compare against
Returns boolean
True if the same ArrayBuffer is used, false otherwise
Inherited from Scalar_.isTheSourceSame
- Defined in foundation/math/AbstractVector.ts:183

length

length(): number
Calculates the length (magnitude) of the vector.

Returns number
The length of the vector

Throws
Error - Must be implemented by subclasses
Inherited from Scalar_.length
- Defined in foundation/math/AbstractVector.ts:83

lengthSquared

lengthSquared(): number
Calculates the squared length of the vector. This is more efficient than length() when only relative comparisons are needed.

Returns number
The squared length of the vector

Throws
Error - Must be implemented by subclasses
Inherited from Scalar_.lengthSquared
- Defined in foundation/math/AbstractVector.ts:93

lengthTo

lengthTo(vec): number
Calculates the distance from this vector to another vector.
Parameters
- vec: IVector
  The target vector
Returns number
The distance between the vectors

Throws
Error - Must be implemented by subclasses
Inherited from Scalar_.lengthTo
- Defined in foundation/math/AbstractVector.ts:103

setValue

setValue(value): MutableScalar_<T>
Sets the scalar value.
Parameters
- value: number
  The new scalar value
Returns MutableScalar_<T>
This scalar instance for method chaining
- Defined in foundation/math/MutableScalar.ts:83

toString

toString(): string
Converts the scalar to a string representation.

Returns string
A string representation of the scalar in the format "(value)"
Overrides Scalar_.toString
- Defined in foundation/math/MutableScalar.ts:74

toStringApproximately

toStringApproximately(): string
Converts the vector to an approximate string representation. Useful for debugging when exact precision is not required.

Returns string
Approximate string representation of the vector

Throws
Error - Must be implemented by subclasses
Inherited from Scalar_.toStringApproximately
- Defined in foundation/math/AbstractVector.ts:141

v

v(i): number
Gets the component value at the specified index. Alias for the at() method for convenience.
Parameters
- i: number
  The index of the component to retrieve
Returns number
The component value at the given index
Inherited from Scalar_.v
- Defined in foundation/math/AbstractVector.ts:173

`Protected` `Static`_dummy

_dummy(type): Scalar_<FloatTypedArrayConstructor>
Protected
Creates a dummy (uninitialized) scalar instance.
Parameters
- type: FloatTypedArrayConstructor
  The typed array constructor to use
Returns Scalar_<FloatTypedArrayConstructor>
A new dummy scalar instance
Inherited from Scalar_._dummy
- Defined in foundation/math/Scalar.ts:138

`Protected` `Static`_fromCopyNumber

_fromCopyNumber(value, type): Scalar_<FloatTypedArrayConstructor>
Protected
Creates a new scalar instance from a number value.
Parameters
- value: number
  The numeric value to create the scalar from
- type: FloatTypedArrayConstructor
  The typed array constructor to use
Returns Scalar_<FloatTypedArrayConstructor>
A new scalar instance
Inherited from Scalar_._fromCopyNumber
- Defined in foundation/math/Scalar.ts:128

Class MutableScalar_<T>Internal

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

type: T

Returns MutableScalar_<T>

Properties

_v

Accessors

bytesPerComponent

Returns number

className

Returns string

glslStrAsFloat

Returns string

glslStrAsInt

Returns string

raw

Returns TypedArray

w

Returns number

wgslStrAsFloat

Returns string

wgslStrAsInt

Returns string

x

Returns number

Parameters

Returns void

y

Returns number

z

Returns number

StaticcompositionType

Returns CompositionTypeClass<"SCALAR">

Methods

at

Parameters

Returns number

copyComponents

Parameters

Returns void

dot

Parameters

Returns number

Throws

flattenAsArray

Returns number[]

Throws

getValue

Returns number

getValueInArray

Returns number[]

isDummy

Returns boolean

isEqual

Parameters

Returns boolean

isStrictEqual

Parameters

Returns boolean

isTheSourceSame

Parameters

Returns boolean

length

Returns number

Throws

lengthSquared

Returns number

Throws

lengthTo

Parameters

Class MutableScalar_<T>`Internal`

`Static`compositionType

`Protected` `Static`_dummy

`Protected` `Static`_fromCopyNumber