Class Scalar

Immutable scalar class using 32-bit floating-point precision. Represents a single floating-point value with various utility methods for mathematical operations and format conversions.

Hierarchy (view full)

Scalar_<Float32ArrayConstructor>
- Scalar
  - AnimatedScalar

Implements

IScalar

Index

Constructors

constructor

new Scalar(x): Scalar
Creates a new 32-bit float scalar instance.
Parameters
- x: TypedArray
  The typed array containing the scalar value
Returns Scalar
Overrides Scalar_.constructor
- Defined in foundation/math/Scalar.ts:169

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
Implementation of IScalar.bytesPerComponent
Inherited from Scalar_.bytesPerComponent
- Defined in foundation/math/Scalar.ts:154

className

get className(): string
Gets the class name for debugging and reflection purposes.

Returns string
The string "Scalar"
Implementation of IScalar.className
Overrides Scalar_.className
- Defined in foundation/math/Scalar.ts:210

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
Implementation of IScalar.glslStrAsFloat
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
Implementation of IScalar.glslStrAsInt
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

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
Implementation of IScalar.wgslStrAsFloat
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
Implementation of IScalar.wgslStrAsInt
Inherited from Scalar_.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
Implementation of IScalar.x
Inherited from Scalar_.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
Inherited from Scalar_.compositionType
- 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
Implementation of IScalar.at
Inherited from Scalar_.at
- Defined in foundation/math/AbstractVector.ts:122

clone

clone(): Scalar
Creates a deep copy of this scalar.

Returns Scalar
A new Scalar instance with the same value
- Defined in foundation/math/Scalar.ts:226

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
Implementation of IScalar.dot
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
Implementation of IScalar.flattenAsArray
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
Implementation of IScalar.isDummy
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_<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
Implementation of IScalar.isEqual
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_<Float32ArrayConstructor>
  The scalar to compare with
Returns boolean
True if the scalars are exactly equal, false otherwise
Implementation of IScalar.isStrictEqual
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
Implementation of IScalar.isTheSourceSame
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
Implementation of IScalar.length
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
Implementation of IScalar.lengthSquared
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
Implementation of IScalar.lengthTo
Inherited from Scalar_.lengthTo
- Defined in foundation/math/AbstractVector.ts:103

toString

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

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

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
Implementation of IScalar.toStringApproximately
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
Implementation of IScalar.v
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

`Static`dummy

dummy(): Scalar
Creates a dummy (uninitialized) scalar instance.

Returns Scalar
A new dummy Scalar instance
- Defined in foundation/math/Scalar.ts:202

`Static`fromCopyNumber

fromCopyNumber(value): Scalar
Creates a new scalar from a numeric value.
Parameters
- value: number
  The numeric value to create the scalar from
Returns Scalar
A new Scalar instance
- Defined in foundation/math/Scalar.ts:178

`Static`one

one(): Scalar
Creates a scalar with value one.

Returns Scalar
A new Scalar instance with value 1
- Defined in foundation/math/Scalar.ts:194

`Static`zero

zero(): Scalar
Creates a scalar with value zero.

Returns Scalar
A new Scalar instance with value 0
- Defined in foundation/math/Scalar.ts:186

Class Scalar

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Scalar

Properties

_v

Accessors

bytesPerComponent

Returns number

className

Returns string

glslStrAsFloat

Returns string

glslStrAsInt

Returns string

raw

Returns TypedArray

wgslStrAsFloat

Returns string

wgslStrAsInt

Returns string

x

Returns number

StaticcompositionType

Returns CompositionTypeClass<"SCALAR">

Methods

at

Parameters

Returns number

clone

Returns Scalar

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

Returns number

Throws

toString

Returns string

toStringApproximately

Returns string

Throws

v

Parameters

Returns number

Protected Static_dummy

`Static`compositionType

`Protected` `Static`_dummy

`Protected` `Static`_fromCopyNumber

`Static`dummy

`Static`fromCopyNumber

`Static`one

`Static`zero