Interface

TimelineKeyframePropertyDefinition

Definition for one scalar keyframe property registered with the engine.

Signature

Type Definition
Interface TimelineKeyframePropertyDefinition

Type parameters

NameConstraintDefaultDescription
PropertyIdstringstring

Properties

NameSignatureDescription
clampValue(value: number): numberClamps one raw value into the valid property range.
defaultValuedefaultValue: numberDefault value used when a clip has no keyframes for the property.
denormalizeValue(normalized: number): numberMaps one normalized 0..1 lane coordinate into a property value.
formatValue?(value: number): stringOptional app-facing formatter for inspectors and labels.
getBaseValue?(clip: Clip): numberOptional source of a clip-specific base value when no keyframes exist.
idid: PropertyIdStable property id stored on keyframes.
label?label?: stringOptional label for app/editor chrome.
maxmax: numberMaximum scalar value represented by the property.
minmin: numberMinimum scalar value represented by the property.
normalizeValue(value: number): numberMaps one property value into a normalized 0..1 lane coordinate.