OverlaySpec

@Serializable
data class OverlaySpec(val velocities: Boolean = false, val forces: Boolean = false, val flowField: Boolean = false, val plannedPaths: Boolean = false, val markerPulses: Boolean = false, val vectorSampleInterval: Double? = null, val agentSubset: List<String> = emptyList())(source)

Opt-in "agent debugging / teaching" overlays (G10–G12): they record internal computation that drives agent behavior — velocity/force vectors, the flow-field gradient, and planned routes — rather than the observable state the base animation already shows. All flags default off, so a normal run pays zero cost. These are the capture gates (whether the trace contains the data); the viewer has its own display toggles (whether it draws the data), so a captured overlay can be shown/hidden without re-running.

Volume note: the per-step overlays (velocity/force) are the only heavy ones; vectorSampleInterval and agentSubset keep them bounded. The flow field is a one-time per-replication snapshot; paths are occasional.

Constructors

Link copied to clipboard
constructor(velocities: Boolean = false, forces: Boolean = false, flowField: Boolean = false, plannedPaths: Boolean = false, markerPulses: Boolean = false, vectorSampleInterval: Double? = null, agentSubset: List<String> = emptyList())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

If non-empty, capture vector overlays only for these agents (to slash volume while teaching).

Link copied to clipboard

Whether any overlay is enabled (a fast guard so an all-off spec wires nothing).

Link copied to clipboard

Record the flow-field distance gradient as a one-time snapshot per replication (G11).

Link copied to clipboard

Record per-agent net steering force vectors (G10).

Link copied to clipboard

Record transient location highlights the model reports via reportMarkerPulse (G-animated).

Link copied to clipboard

Record routes the model reports via reportPlannedPath (G12).

Link copied to clipboard

Sample interval (model time) for the per-step vector overlays; null ⇒ 5 samples / simulated second.

Link copied to clipboard

Record per-agent velocity vectors (G10).