KSLCore/ksl.modeling.agent/TravelHandle3D

TravelHandle3D

class TravelHandle3D<A : AgentLike>(source)

Mutable handle representing an in-progress interruptible 3D travel. The 3D analog of TravelHandle. Same semantics: returned by startTravel3D; consumed by awaitTravel3D; cancellable / redirectable from any coroutine with a reference to the handle.

Latency for interruption is stepSize / velocity at most (one step boundary). See §12.6 of the agent-based-modeling design doc for use cases (drone recall, mid-flight reroute on weather, etc.).

Properties

val agent: A

var destination: Point3D

Current target. May differ from the original after redirect.

distanceTraveled

var distanceTraveled: Double

Cumulative 3D distance the agent has moved through the volume since startedAt.

var endedAt: Double

End time of the travel — Double.NaN while still active.

val isActive: Boolean

True while the travel is in progress (not yet complete or canceled).

var isCanceled: Boolean

True after cancel is called.

var isComplete: Boolean

True after a successful arrival at the (possibly redirected) destination.

val result: TravelResult

TravelResult snapshot.

val space: ContinuousVolume<in A>

val startedAt: Double

val stepSize: Double

val velocity: Double

Functions

fun cancel()

Stop motion at the agent's current interpolated 3D position.

fun redirect(newDestination: Point3D)

Change the destination mid-travel.