@webspatial/platform-visionos 1.7.0 → 2.0.0

package/web-spatial/model/dynamic3d/EntityAnimationManager.swift

@@ -0,0 +1,356 @@
+import Combine
+import Foundation
+import RealityKit
+
+// MARK: - Animation Session Manager
+
+/// Manages active animation sessions for entities within a SpatialScene.
+/// Each entity can have at most one active session at a time.
+class EntityAnimationManager {
+    /// Active sessions keyed by animationId.
+    private var sessions: [String: EntityAnimationSession] = [:]
+
+    /// Active scene event subscriptions keyed by animationId.
+    private var completionSubscriptions: [String: any Cancellable] = [:]
+
+    /// Weak reference to the scene for sending events back to JS.
+    weak var scene: SpatialScene?
+
+    init(scene: SpatialScene? = nil) {
+        self.scene = scene
+    }
+
+    func getSession(_ animationId: String) -> EntityAnimationSession? {
+        return sessions[animationId]
+    }
+
+    func addSession(_ session: EntityAnimationSession) {
+        sessions[session.animationId] = session
+    }
+
+    func removeSession(_ animationId: String) {
+        completionSubscriptions.removeValue(forKey: animationId)
+        sessions.removeValue(forKey: animationId)
+    }
+
+    /// Remove all sessions for a given entity (called on entity destroy).
+    func removeSessionsForEntity(_ entityId: String) {
+        let toRemove = sessions.filter { $0.value.entityId == entityId }
+        for (id, session) in toRemove {
+            session.markCanceled()
+            session.playbackController?.stop()
+            completionSubscriptions.removeValue(forKey: id)
+            sessions.removeValue(forKey: id)
+        }
+    }
+
+    func removeAll() {
+        for (_, session) in sessions {
+            session.markCanceled()
+            session.playbackController?.stop()
+        }
+        completionSubscriptions.removeAll()
+        sessions.removeAll()
+    }
+
+    // MARK: - Play
+
+    func handlePlay(
+        command: AnimateTransformCommand,
+        entity: SpatialEntity,
+        resolve: @escaping JSBManager.ResolveHandler<Encodable>
+    ) {
+        let resolvedFromTransform =
+            command.fromTransform ?? float4x4ToArray(entity.transform.matrix)
+        let session = EntityAnimationSession(
+            animationId: command.animationId,
+            entityId: entity.spatialId,
+            toTransform: command.toTransform,
+            fromTransform: resolvedFromTransform,
+            duration: command.duration ?? 0.3,
+            timingFunction: command.timingFunction ?? "easeInOut",
+            delay: command.delay ?? 0,
+            loop: command.loop,
+            speed: command.playbackRate ?? 1.0
+        )
+        addSession(session)
+
+        // Acknowledge the play command immediately so the JS side can set up listeners
+        resolve(.success(nil))
+
+        // Start the RealityKit animation immediately; delay is handled natively
+        // by AnimationView's `delay` parameter.
+        startRealityKitAnimation(session: session, entity: entity)
+    }
+
+    // MARK: - Pause
+
+    func handlePause(
+        command: AnimateTransformCommand,
+        resolve: @escaping JSBManager.ResolveHandler<Encodable>
+    ) {
+        guard let session = getSession(command.animationId) else {
+            resolve(.failure(JsbError(code: .CommandError, message: "Animation session \(command.animationId) not found")))
+            return
+        }
+        guard !session.isTerminal else {
+            resolve(.failure(JsbError(code: .CommandError, message: "Animation session \(command.animationId) is already terminal")))
+            return
+        }
+
+        session.markPaused()
+
+        // RealityKit's playback controller handles pause correctly even during
+        // the delay phase (the animation simply won't advance until resumed).
+        session.playbackController?.pause()
+
+        resolve(.success(nil))
+    }
+
+    // MARK: - Resume
+
+    func handleResume(
+        command: AnimateTransformCommand,
+        entity: SpatialEntity,
+        resolve: @escaping JSBManager.ResolveHandler<Encodable>
+    ) {
+        guard let session = getSession(command.animationId) else {
+            resolve(.failure(JsbError(code: .CommandError, message: "Animation session \(command.animationId) not found")))
+            return
+        }
+        guard session.isPaused else {
+            resolve(.failure(JsbError(code: .CommandError, message: "Animation session \(command.animationId) is not paused")))
+            return
+        }
+
+        session.markResumed()
+
+        // Resume playback — works correctly whether paused during delay or active phase.
+        session.playbackController?.resume()
+
+        resolve(.success(nil))
+    }
+
+    // MARK: - Cancel
+
+    func handleCancel(
+        command: AnimateTransformCommand,
+        entity: SpatialEntity,
+        resolve: @escaping JSBManager.ResolveHandler<Encodable>
+    ) {
+        guard let session = getSession(command.animationId) else {
+            resolve(.failure(JsbError(code: .CommandError, message: "Animation session \(command.animationId) not found")))
+            return
+        }
+
+        guard !session.isTerminal else {
+            // Already terminal — acknowledge silently
+            resolve(.success(nil))
+            return
+        }
+
+        session.markCanceled()
+
+        // Stop the playback controller first, then remove ALL animations from
+        // the entity. RealityKit may retain a "fill" state from the stopped
+        // animation that overrides entity.transform.matrix unless the animation
+        // resource is fully detached via stopAllAnimations().
+        session.playbackController?.stop()
+        entity.stopAllAnimations()
+
+        // Cancel restores entity to the from-transform (or session start snapshot
+        // when from was omitted). This aligns with Web Animation API cancel() semantics.
+        //
+        // IMPORTANT: After stopAllAnimations(), RealityKit bind-point system may
+        // still hold an override on the entity transform for the current frame.
+        // Direct assignment (entity.transform.matrix = ...) is rejected with
+        // "Failed to set override status for bind point component member".
+        // Using move(to:relativeTo:duration:0) creates a zero-duration animation
+        // that properly takes over the bind-point ownership.
+        let restoredTransform = session.fromTransform
+        if let fromArray = restoredTransform, fromArray.count == 16 {
+            let fromMatrix = arrayToFloat4x4(fromArray)
+            let fromTransform = Transform(matrix: fromMatrix)
+            entity.move(to: fromTransform, relativeTo: entity.parent, duration: 0, timingFunction: .linear)
+        }
+
+        // Send canceled event to JS with the restored transform
+        sendCanceledEvent(session: session)
+        removeSession(command.animationId)
+
+        resolve(.success(nil))
+    }
+
+    // MARK: - RealityKit Animation
+
+    private func startRealityKitAnimation(session: EntityAnimationSession, entity: SpatialEntity) {
+        guard !session.isTerminal else { return }
+
+        // Build to-transform as float4x4
+        guard let toArray = session.toTransform, toArray.count == 16 else {
+            sendFailedEvent(session: session, command: "play", reason: "Missing or invalid toTransform")
+            session.markCanceled()
+            removeSession(session.animationId)
+            return
+        }
+
+        let toMatrix = arrayToFloat4x4(toArray)
+
+        // If fromTransform is provided, set entity transform to it before animating.
+        // Direct assignment is safe here because no animation is active on this entity
+        // at this point (any previous animation was already stopped in handleCancel).
+        // NOTE: Do NOT use move(to:duration:0) here — it creates a zero-duration animation
+        // that fires PlaybackCompleted, which would falsely trigger our completion observer.
+        if let fromArray = session.fromTransform, fromArray.count == 16 {
+            let fromMatrix = arrayToFloat4x4(fromArray)
+            entity.stopAllAnimations()
+            entity.transform.matrix = fromMatrix
+        }
+
+        // Map timing function to RealityKit animation timing
+        let timingFunction = mapTimingFunction(session.timingFunction)
+
+        // Build the animation
+        let toTransform = Transform(matrix: toMatrix)
+        let animation = FromToByAnimation<Transform>(
+            to: toTransform,
+            duration: session.duration,
+            timing: timingFunction,
+            bindTarget: .transform,
+            repeatMode: mapRepeatMode(session.loop)
+        )
+
+        // Wrap with AnimationView to apply the native delay.
+        // RealityKit handles the delay internally — no manual timer needed.
+        var animationView = AnimationView(source: animation, delay: session.delay)
+        animationView.speed = Float(session.speed)
+
+        guard let animResource = try? AnimationResource.generate(with: animationView) else {
+            sendFailedEvent(session: session, command: "play", reason: "Failed to generate animation resource")
+            session.markCanceled()
+            removeSession(session.animationId)
+            return
+        }
+
+        // Play the animation
+        let controller = entity.playAnimation(animResource, startsPaused: session.isPaused)
+        session.playbackController = controller
+
+        // Observe completion for non-looping animations using Scene event subscription
+        let isLooping = session.loop?.isEnabled ?? false
+        if !isLooping {
+            observeAnimationCompletion(session: session, entity: entity)
+        }
+    }
+
+    /// Subscribe to RealityKit's `AnimationEvents.PlaybackCompleted` on the entity
+    /// to detect natural animation completion without timer polling.
+    private func observeAnimationCompletion(session: EntityAnimationSession, entity: SpatialEntity) {
+        guard let rkScene = entity.scene else {
+            // Fallback: entity not yet in a RealityKit scene — this should not
+            // happen in normal flow since play is called after entity is added.
+            sendFailedEvent(session: session, command: "play", reason: "Entity has no RealityKit scene for event subscription")
+            session.markCanceled()
+            removeSession(session.animationId)
+            return
+        }
+
+        let subscription = rkScene.subscribe(to: AnimationEvents.PlaybackCompleted.self, on: entity) { [weak self, weak entity] _ in
+            guard let self = self, let entity = entity else { return }
+            guard !session.isTerminal else { return }
+
+            // Animation completed naturally
+            session.markCompleted()
+            self.sendCompletedEvent(session: session, entity: entity)
+            self.removeSession(session.animationId)
+        }
+
+        completionSubscriptions[session.animationId] = subscription
+    }
+
+    // MARK: - Event Emission
+
+    /// Send the `{animationId}_completed` event to JS with the entity's current transform.
+    private func sendCompletedEvent(session: EntityAnimationSession, entity: SpatialEntity) {
+        guard let scene = scene else { return }
+        let transform = float4x4ToArray(entity.transform.matrix)
+        let payload = AnimationCompletedPayload(type: "completed", transform: transform)
+        scene.sendWebMsg("\(session.animationId)_completed", payload)
+    }
+
+    /// Send the `{animationId}_canceled` event to JS with the resolved restore target.
+    private func sendCanceledEvent(session: EntityAnimationSession) {
+        guard let scene = scene else { return }
+        guard let transform = session.fromTransform, transform.count == 16 else { return }
+        let payload = AnimationCanceledPayload(type: "canceled", transform: transform)
+        scene.sendWebMsg("\(session.animationId)_canceled", payload)
+    }
+
+    /// Send the `{animationId}_failed` event to JS.
+    private func sendFailedEvent(session: EntityAnimationSession, command: String, reason: String) {
+        guard let scene = scene else { return }
+        let payload = AnimationFailedPayload(
+            type: "failed",
+            animationId: session.animationId,
+            command: command,
+            reason: reason
+        )
+        scene.sendWebMsg("\(session.animationId)_failed", payload)
+    }
+
+    // MARK: - Helpers
+
+    private func arrayToFloat4x4(_ array: [Double]) -> float4x4 {
+        // Column-major order matching DOMMatrix.toFloat64Array()
+        return float4x4(
+            SIMD4<Float>(Float(array[0]), Float(array[1]), Float(array[2]), Float(array[3])),
+            SIMD4<Float>(Float(array[4]), Float(array[5]), Float(array[6]), Float(array[7])),
+            SIMD4<Float>(Float(array[8]), Float(array[9]), Float(array[10]), Float(array[11])),
+            SIMD4<Float>(Float(array[12]), Float(array[13]), Float(array[14]), Float(array[15]))
+        )
+    }
+
+    private func float4x4ToArray(_ matrix: float4x4) -> [Double] {
+        // Column-major order
+        let c0 = matrix.columns.0
+        let c1 = matrix.columns.1
+        let c2 = matrix.columns.2
+        let c3 = matrix.columns.3
+        return [
+            Double(c0.x), Double(c0.y), Double(c0.z), Double(c0.w),
+            Double(c1.x), Double(c1.y), Double(c1.z), Double(c1.w),
+            Double(c2.x), Double(c2.y), Double(c2.z), Double(c2.w),
+            Double(c3.x), Double(c3.y), Double(c3.z), Double(c3.w),
+        ]
+    }
+
+    private func mapTimingFunction(_ name: String) -> AnimationTimingFunction {
+        switch name {
+        case "linear": return .linear
+        case "easeIn": return .easeIn
+        case "easeOut": return .easeOut
+        case "easeInOut": return .easeInOut
+        default: return .easeInOut
+        }
+    }
+
+    /// Maps the JS `loop` config to RealityKit repeat mode.
+    ///
+    /// OpenSpec contract (task 4.3 verified):
+    /// - `loop: true` -> reset loop: plays to to, instantly resets to from, repeats.
+    ///   RealityKit .repeat replays the baked animation clip from the start -- matches spec.
+    ///   When from is omitted, the implicit start is the entity transform at play() time,
+    ///   baked into the AnimationResource, so it is NOT re-snapshotted each loop.
+    /// - `loop: { reverse: true }` -> reverse loop: smoothly plays back from to to from.
+    ///   RealityKit .autoReverse does exactly this.
+    /// - No loop -> .none: plays once, fires PlaybackCompleted.
+    private func mapRepeatMode(_ loop: AnimateTransformLoopValue?) -> AnimationRepeatMode {
+        guard let loop = loop, loop.isEnabled else {
+            return .none
+        }
+        if loop.isReverse {
+            return .autoReverse
+        }
+        return .repeat
+    }
+}

package/web-spatial/model/dynamic3d/EntityAnimationSession.swift

@@ -0,0 +1,162 @@
+import Foundation
+import RealityKit
+
+// MARK: - JSB Command
+
+/// Command received from the JS SDK via the bridge.
+/// Matches the `commandType = "AnimateTransform"` defined in core-sdk JSBCommand.ts.
+struct AnimateTransformCommand: CommandDataProtocol {
+    static let commandType: String = "AnimateTransform"
+
+    let animationId: String
+    let type: String // "play" | "pause" | "resume" | "cancel"
+
+    // Fields present only when type == "play"
+    let entityId: String?
+    let toTransform: [Double]?
+    let fromTransform: [Double]?
+    let duration: Double?
+    let timingFunction: String?
+    let delay: Double?
+    let loop: AnimateTransformLoopValue?
+    let playbackRate: Double?
+}
+
+/// Handles the polymorphic `loop` field which can be `true`, `false`, or `{ reverse: true }`.
+enum AnimateTransformLoopValue: Decodable {
+    case boolean(Bool)
+    case object(AnimateTransformLoopObject)
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.singleValueContainer()
+        if let boolVal = try? container.decode(Bool.self) {
+            self = .boolean(boolVal)
+        } else if let objVal = try? container.decode(AnimateTransformLoopObject.self) {
+            self = .object(objVal)
+        } else {
+            self = .boolean(false)
+        }
+    }
+
+    var isEnabled: Bool {
+        switch self {
+        case let .boolean(v): return v
+        case .object: return true
+        }
+    }
+
+    var isReverse: Bool {
+        switch self {
+        case .boolean: return false
+        case let .object(obj): return obj.reverse ?? false
+        }
+    }
+}
+
+struct AnimateTransformLoopObject: Decodable {
+    let reverse: Bool?
+}
+
+// MARK: - Native Animation Session
+
+/// Represents a single animation session on the native side.
+/// Tracks state so pause/resume/stop commands can be fulfilled.
+class EntityAnimationSession {
+    let animationId: String
+    let entityId: String
+
+    /// The RealityKit animation playback controller.
+    var playbackController: AnimationPlaybackController?
+
+    /// Whether the session has been canceled (terminal state).
+    private(set) var isCanceled: Bool = false
+
+    /// Whether the session has completed naturally (terminal state).
+    private(set) var isCompleted: Bool = false
+
+    /// Whether the session is paused.
+    private(set) var isPaused: Bool = false
+
+    /// The to-transform matrix (column-major, 16 doubles).
+    let toTransform: [Double]?
+
+    /// The from-transform matrix (column-major, 16 doubles).
+    let fromTransform: [Double]?
+
+    /// Duration in seconds.
+    let duration: TimeInterval
+
+    /// Delay in seconds before playback starts.
+    let delay: TimeInterval
+
+    /// Timing function name.
+    let timingFunction: String
+
+    /// Loop configuration.
+    let loop: AnimateTransformLoopValue?
+
+    /// Playback speed multiplier. Default: 1.0. Maps to AnimationView.speed.
+    let speed: Double
+
+    init(
+        animationId: String,
+        entityId: String,
+        toTransform: [Double]?,
+        fromTransform: [Double]?,
+        duration: Double,
+        timingFunction: String,
+        delay: Double,
+        loop: AnimateTransformLoopValue?,
+        speed: Double = 1.0
+    ) {
+        self.animationId = animationId
+        self.entityId = entityId
+        self.toTransform = toTransform
+        self.fromTransform = fromTransform
+        self.duration = duration
+        self.delay = delay
+        self.timingFunction = timingFunction
+        self.loop = loop
+        self.speed = speed
+    }
+
+    /// Whether this session has reached a terminal state.
+    var isTerminal: Bool {
+        return isCanceled || isCompleted
+    }
+
+    func markCompleted() {
+        isCompleted = true
+    }
+
+    func markCanceled() {
+        isCanceled = true
+    }
+
+    func markPaused() {
+        isPaused = true
+    }
+
+    func markResumed() {
+        isPaused = false
+    }
+}
+
+// MARK: - Event Payloads
+
+struct AnimationCompletedPayload: Encodable {
+    let type: String
+    let transform: [Double]
+}
+
+struct AnimationCanceledPayload: Encodable {
+    let type: String
+    let transform: [Double]
+}
+
+struct AnimationFailedPayload: Encodable {
+    let type: String
+    let animationId: String
+    let command: String
+    let reason: String
+}

package/web-spatial/model/element-motion/SpatializedElementAnimationCommand.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+struct CreateSpatializedElementAnimationCommand: CommandDataProtocol {
+    static let commandType: String = "CreateSpatializedElementAnimation"
+
+    let elementId: String
+    let timeline: SpatializedMotionTimelinePayload
+}
+
+struct ControlSpatializedElementAnimationCommand: CommandDataProtocol {
+    static let commandType: String = "ControlSpatializedElementAnimation"
+
+    let animationId: String
+    let type: String
+}