AnimationTraceHeader

@Serializable
data class AnimationTraceHeader(val formatVersion: Int = AnimationEvent.FORMAT_VERSION, val baseTimeUnit: String? = null, val kslVersion: String? = null, val description: String? = null)(source)

The first record of every animation trace (.atf) file. It identifies the format generation and records run-level context the renderer needs before it begins interpreting AnimationEvent records.

The header is written as the first line of the file by the trace writer (Phase 0.5) and is distinguishable from event lines because it has no "event" discriminator field. A reader consumes line 1 as the header, checks formatVersion against the version it understands, then reads the remaining lines as events.

Constructors

Link copied to clipboard
constructor(formatVersion: Int = AnimationEvent.FORMAT_VERSION, baseTimeUnit: String? = null, kslVersion: String? = null, description: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

the model's base time unit (e.g. "MINUTE"), so the renderer can label times; null if unknown at write time

Link copied to clipboard

an optional free-text label for the trace (e.g. the model name)

Link copied to clipboard

the .atf format generation; see AnimationEvent.FORMAT_VERSION

Link copied to clipboard

the KSL version that produced the trace, for diagnostics; may be null

Functions

Link copied to clipboard

Serializes this header to a single-line JSON string (the first .atf record).