Class MutableScalar

_v

bytesPerComponent

• get bytesPerComponent(): number

• Gets the number of bytes per component in the underlying typed array.

  Returns number

  The number of bytes per element

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

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

raw

• get raw(): TypedArray

• Gets the raw typed array containing the scalar value.

  Returns TypedArray

  The underlying typed array

w

• get w(): number

• Gets the w component (always 1 for scalars).

  Returns number

  Always returns 1

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

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

x

• get x(): number

• Gets the x component (scalar value).

  Returns number

  The scalar value
• set x(x): void

• Sets the x component (scalar value).

  Parameters

  • x: number

    The new scalar value

  Returns void

y

• get y(): number

• Gets the y component (always 0 for scalars).

  Returns number

  Always returns 0

z

• get z(): number

• Gets the z component (always 0 for scalars).

  Returns number

  Always returns 0

StaticcompositionType

• get compositionType(): CompositionTypeClass<"SCALAR">

• Gets the composition type for this scalar.

  Returns CompositionTypeClass<"SCALAR">

  The scalar composition type

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

copyComponents

• copyComponents(vec): void

• Copies the components from another scalar to this scalar.

  Parameters

  • vec: Scalar_<Float32ArrayConstructor>

    The source scalar to copy from

  Returns void

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

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

getValue

• getValue(): number

• Gets the scalar value as a number.

  Returns number

  The scalar value

getValueInArray

• getValueInArray(): number[]

• Gets the scalar value wrapped in an array.

  Returns number[]

  An array containing the scalar value

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

isEqual

• isEqual(scalar, delta?): boolean

• Performs approximate equality comparison with another scalar within a tolerance.

  Parameters

  • scalar: Scalar_<Float32ArrayConstructor>

    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

isStrictEqual

• isStrictEqual(scalar): boolean

• Performs strict equality comparison with another scalar. Uses exact floating-point comparison without tolerance.

  Parameters

  • scalar: Scalar_<Float32ArrayConstructor>

    The scalar to compare with

  Returns boolean

  True if the scalars are exactly equal, false otherwise

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

length

• length(): number

• Calculates the length (magnitude) of the vector.

  Returns number

  The length of the vector

  Throws

  Error - Must be implemented by subclasses

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

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

setValue

• setValue(value): MutableScalar

• Sets the scalar value.

  Parameters

  • value: number

    The new scalar value

  Returns MutableScalar

  This scalar instance for method chaining

toString

• toString(): string

• Converts the scalar to a string representation.

  Returns string

  A string representation of the scalar in the format "(value)"

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

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