Class Scalar_<T>`Internal`

Abstract base class for scalar values using typed arrays. Provides common functionality for both 32-bit and 64-bit floating-point scalar implementations.

Type Parameters

T extends TypedArrayConstructor
The typed array constructor type

Hierarchy (view full)

AbstractVector
- Scalar_

Index

Constructors

Properties

Accessors

bytesPerComponent className glslStrAsFloat glslStrAsInt raw wgslStrAsFloat wgslStrAsInt x compositionType

Methods

at dot flattenAsArray getValue getValueInArray isDummy isEqual isStrictEqual isTheSourceSame length lengthSquared lengthTo toString toStringApproximately v _dummy _fromCopyNumber

Constructors

constructor

new Scalar_<T>(v, options): Scalar_<T>
Creates a new scalar instance.
Type Parameters
- T extends TypedArrayConstructor
Parameters
- v: TypedArray
  The typed array containing the scalar value
- options: {
  type: T;
  }
  Configuration object containing the array type
  - type: T
    The typed array constructor type
Returns Scalar_<T>
Overrides AbstractVector.constructor
- Defined in foundation/math/Scalar.ts:24

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 AbstractVector.bytesPerComponent
- Defined in foundation/math/Scalar.ts:154

className

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

Returns string
The constructor name of the class
Inherited from AbstractVector.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
Overrides AbstractVector.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
Overrides AbstractVector.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
- Defined in foundation/math/Scalar.ts:57

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
Overrides AbstractVector.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
Overrides AbstractVector.wgslStrAsInt
- Defined in foundation/math/Scalar.ts:117

x

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

Returns number
The scalar value
Overrides AbstractVector.x
- Defined in foundation/math/Scalar.ts:49

`Static`compositionType

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

Returns CompositionTypeClass<"SCALAR">
The scalar composition type
- Defined in foundation/math/Scalar.ts:146

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 AbstractVector.at
- Defined in foundation/math/AbstractVector.ts:122

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 AbstractVector.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 AbstractVector.flattenAsArray
- Defined in foundation/math/AbstractVector.ts:150

getValue

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

Returns number
The scalar value
- 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
- 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 AbstractVector.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
Overrides AbstractVector.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
Overrides AbstractVector.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 AbstractVector.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 AbstractVector.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 AbstractVector.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 AbstractVector.lengthTo
- Defined in foundation/math/AbstractVector.ts:103

toString

toString(): string
Converts the vector to its string representation.

Returns string
String representation of the vector

Throws
Error - Must be implemented by subclasses
Inherited from AbstractVector.toString
- Defined in foundation/math/AbstractVector.ts:131

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 AbstractVector.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 AbstractVector.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
- 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
- Defined in foundation/math/Scalar.ts:128