Class AnimatedScalar

A scalar value that can be animated using animation samplers. This class extends Scalar and implements both IScalar and IAnimatedValue interfaces. It supports blending between two animation tracks and can be configured to loop.

Hierarchy (view full)

Scalar
- AnimatedScalar

Implements

IScalar
IAnimatedValue

Constructors

constructor

new AnimatedScalar(animationSamplers, activeAnimationTrackName): AnimatedScalar
Creates a new AnimatedScalar instance.
Parameters
- animationSamplers: AnimationSamplers
  A map of animation track names to their corresponding samplers
- activeAnimationTrackName: string
  The name of the initially active animation track
Returns AnimatedScalar
Throws
If the specified animation track is not found in the samplers
Overrides Scalar.constructor
- Defined in foundation/math/AnimatedScalar.ts:32

Properties

_v

_v: TypedArray = ...

Internal typed array storage for vector components

isLoop

isLoop: boolean = true

Whether the animation should loop when it reaches the end.

Accessors

blendingRatio

get blendingRatio(): number
Gets the current blending ratio between animation tracks.

Returns number
The current blending ratio
Implementation of IAnimatedValue.blendingRatio
- Defined in foundation/math/AnimatedScalar.ts:91
set blendingRatio(value): void
Sets the blending ratio between the first and second animation tracks.
Parameters
- value: number
  The blending ratio (0.0 = first track only, 1.0 = second track only)
Returns void
Implementation of IAnimatedValue.blendingRatio
- Defined in foundation/math/AnimatedScalar.ts:81

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
Inherited from 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 current scalar value, updating the animation if necessary.

Returns number
The current scalar value
Implementation of IScalar.x
Overrides Scalar.x
- Defined in foundation/math/AnimatedScalar.ts:99

`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
Inherited from Scalar.clone
- Defined in foundation/math/Scalar.ts:226

deleteAnimationSampler

deleteAnimationSampler(trackName): void
Deletes an animation sampler for the specified track name.
Parameters
- trackName: string
  The name of the animation track to delete
Returns void
Implementation of IAnimatedValue.deleteAnimationSampler
- Defined in foundation/math/AnimatedScalar.ts:231

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

getAllTrackNames

getAllTrackNames(): string[]
Gets an array of all available animation track names.

Returns string[]
An array containing all animation track names
Implementation of IAnimatedValue.getAllTrackNames
- Defined in foundation/math/AnimatedScalar.ts:209

getAnimationSampler

getAnimationSampler(trackName): AnimationSampler
Gets the animation sampler for the specified track name.
Parameters
- trackName: string
  The name of the animation track
Returns AnimationSampler
The animation sampler for the specified track

Throws
If the specified animation track is not found
Implementation of IAnimatedValue.getAnimationSampler
- Defined in foundation/math/AnimatedScalar.ts:219

getFirstActiveAnimationTrackName

getFirstActiveAnimationTrackName(): string
Gets the name of the first active animation track.

Returns string
The name of the first active animation track
Implementation of IAnimatedValue.getFirstActiveAnimationTrackName
- Defined in foundation/math/AnimatedScalar.ts:165

getMaxEndInputTime

getMaxEndInputTime(trackName): number
Gets the maximum end time from the input keyframes of the specified animation track.
Parameters
- trackName: string
  The name of the animation track
Returns number
The maximum end time of the animation track

Throws
If the specified animation track is not found
Implementation of IAnimatedValue.getMaxEndInputTime
- Defined in foundation/math/AnimatedScalar.ts:197

getMinStartInputTime

getMinStartInputTime(trackName): number
Gets the minimum start time from the input keyframes of the specified animation track.
Parameters
- trackName: string
  The name of the animation track
Returns number
The minimum start time of the animation track

Throws
If the specified animation track is not found
Implementation of IAnimatedValue.getMinStartInputTime
- Defined in foundation/math/AnimatedScalar.ts:183

getNumberArray

getNumberArray(): number[]
Returns the scalar value as an array of numbers.

Returns number[]
An array containing the scalar value
Implementation of IAnimatedValue.getNumberArray
- Defined in foundation/math/AnimatedScalar.ts:47

getSecondActiveAnimationTrackName

getSecondActiveAnimationTrackName(): undefined | string
Gets the name of the second active animation track.

Returns undefined | string
The name of the second active animation track, or undefined if not set
Implementation of IAnimatedValue.getSecondActiveAnimationTrackName
- Defined in foundation/math/AnimatedScalar.ts:173

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

setAnimationSampler

setAnimationSampler(animationTrackName, animationSampler): void
Sets or updates an animation sampler for the specified track name.
Parameters
- animationTrackName: string
  The name of the animation track
- animationSampler: AnimationSampler
  The animation sampler to associate with the track
Returns void
Implementation of IAnimatedValue.setAnimationSampler
- Defined in foundation/math/AnimatedScalar.ts:240

setFirstActiveAnimationTrackName

setFirstActiveAnimationTrackName(animationTrackName): void
Sets the first active animation track by name.
Parameters
- animationTrackName: string
  The name of the animation track to set as the first active track
Returns void
Implementation of IAnimatedValue.setFirstActiveAnimationTrackName
- Defined in foundation/math/AnimatedScalar.ts:135

setFloat32Array

setFloat32Array(array): void
Sets the internal Float32Array and triggers an update.
Parameters
- array: Float32Array
  The new Float32Array to set
Returns void
Implementation of IAnimatedValue.setFloat32Array
- Defined in foundation/math/AnimatedScalar.ts:55

setSecondActiveAnimationTrackName

setSecondActiveAnimationTrackName(animationTrackName): void
Sets the second active animation track by name for blending purposes.
Parameters
- animationTrackName: string
  The name of the animation track to set as the second active track
Returns void
Implementation of IAnimatedValue.setSecondActiveAnimationTrackName
- Defined in foundation/math/AnimatedScalar.ts:150

setTime

setTime(time): void
Sets a specific time for animation playback.
Parameters
- time: number
  The time value to set for animation sampling
Returns void
Implementation of IAnimatedValue.setTime
- Defined in foundation/math/AnimatedScalar.ts:64

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
Inherited from 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

update

update(): void
Updates the animated scalar value based on the current time and active animation tracks. This method interpolates between keyframes and handles blending between two tracks if configured. The update is skipped if the time hasn't changed since the last update.

Returns void
Implementation of IAnimatedValue.update
- Defined in foundation/math/AnimatedScalar.ts:109

useGlobalTime

useGlobalTime(): void
Switches to using global time from AnimationComponent instead of a specific time.

Returns void
Implementation of IAnimatedValue.useGlobalTime
- Defined in foundation/math/AnimatedScalar.ts:72

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
Inherited from Scalar.dummy
- 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
Inherited from Scalar.fromCopyNumber
- 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
Inherited from Scalar.one
- 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
Inherited from Scalar.zero
- Defined in foundation/math/Scalar.ts:186

Class AnimatedScalar

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AnimatedScalar

Throws

Properties

_v

isLoop

Accessors

blendingRatio

Returns number

Parameters

Returns void

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

deleteAnimationSampler

Parameters

Returns void

dot

Parameters

Returns number

Throws

flattenAsArray

Returns number[]

Throws

getAllTrackNames

Returns string[]

getAnimationSampler

Parameters

Returns AnimationSampler

Throws

getFirstActiveAnimationTrackName

Returns string

getMaxEndInputTime

Parameters

Returns number

Throws

getMinStartInputTime

Parameters

Returns number

Throws

getNumberArray

Returns number[]

getSecondActiveAnimationTrackName

Returns undefined | string

getValue

Returns number

getValueInArray

Returns number[]

isDummy

`Static`compositionType

`Protected` `Static`_dummy

`Protected` `Static`_fromCopyNumber

`Static`dummy

`Static`fromCopyNumber

`Static`one

`Static`zero