@webspatial/platform-visionos 1.2.0 → 1.3.0

package/web-spatial/model/SpatialScene.swift

@@ -38,7 +38,9 @@ let defaultSceneConfig = SceneOptions(
 class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSender {
     var parent: (any ScrollAbleSpatialElementContainer)?
 
-    // Enum
+    var attachmentManager = AttachmentManager()
+
+    /// Enum
     enum WindowStyle: String, Codable, CaseIterable {
         case window
         case volume
@@ -66,15 +68,15 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
     }
 
     enum SceneStateKind: String {
-        // default value
+        /// default value
         case idle
-        // when SpatialScene is loading
+        /// when SpatialScene is loading
         case pending
-        // when SpatialScen will visible after some time
+        /// when SpatialScen will visible after some time
         case willVisible
-        // when SpatialScen load Succesfully
+        /// when SpatialScen load Succesfully
         case visible
-        // when SpatialScen Failed to load
+        /// when SpatialScen Failed to load
         case fail
     }
 
@@ -101,7 +103,7 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
         moveToState(state, sceneOptions)
     }
 
-    // used to send message to spatial root webview
+    /// used to send message to spatial root webview
     func sendWebMsg(_ id: String, _ msg: Encodable) {
         spatialWebViewModel.sendWebEvent(id, msg)
     }
@@ -299,6 +301,8 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
         spatialWebViewModel.addJSBListener(ConvertFromEntityToScene.self, onConvertFromEntityToScene)
         spatialWebViewModel.addJSBListener(ConvertFromSceneToEntity.self, onConvertFromSceneToEntity)
 
+        spatialWebViewModel.addJSBListener(UpdateAttachmentEntityCommand.self, onUpdateAttachmentEntity)
+
         spatialWebViewModel.addOpenWindowListener(protocal: "webspatial", onOpenWindowHandler)
 
         spatialWebViewModel
@@ -380,6 +384,8 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
         let host = url.host ?? ""
         if host == "createSpatialScene" {
             return handleWindowOpenCustom(url)
+        } else if host == "createAttachment" {
+            return handleCreateAttachment(url)
         } else {
             let spatialized2DElement: Spatialized2DElement = createSpatializedElement(
                 .Spatialized2DElement
@@ -388,15 +394,66 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
         }
     }
 
+    private func handleCreateAttachment(_ url: URL) -> WebViewElementInfo? {
+        guard let components = URLComponents(string: url.absoluteString),
+              let queryItems = components.queryItems
+        else {
+            print("❌ fail to parse attachment URL")
+            return nil
+        }
+
+        guard let parentEntityId = queryItems.first(where: { $0.name == "parentEntityId" })?.value else {
+            print("❌ missing parentEntityId for attachment")
+            return nil
+        }
+
+        // Parse position (JSON array like [0,0.1,0])
+        var position = SIMD3<Float>(0, 0, 0)
+        if let positionStr = queryItems.first(where: { $0.name == "position" })?.value?.removingPercentEncoding,
+           let positionData = positionStr.data(using: .utf8),
+           let positionArray = try? JSONDecoder().decode([Float].self, from: positionData),
+           positionArray.count >= 3
+        {
+            position = SIMD3<Float>(positionArray[0], positionArray[1], positionArray[2])
+        }
+
+        // Parse size (JSON object like {"width":100,"height":100})
+        var size = CGSize(width: 100, height: 100)
+        if let sizeStr = queryItems.first(where: { $0.name == "size" })?.value?.removingPercentEncoding,
+           let sizeData = sizeStr.data(using: .utf8),
+           let sizeObj = try? JSONDecoder().decode(AttachmentSize.self, from: sizeData)
+        {
+            size = CGSize(width: sizeObj.width, height: sizeObj.height)
+        }
+
+        let info = attachmentManager.create(
+            id: UUID().uuidString,
+            parentEntityId: parentEntityId,
+            position: position,
+            size: size
+        )
+
+        return WebViewElementInfo(id: info.id, element: info.webViewModel)
+    }
+
     private func onPageStartLoad() {
         // destroy all SpatialObject asset
         let spatialObjectArray = spatialObjects.map { $0.value }
         for spatialObject in spatialObjectArray {
             spatialObject.destroy()
         }
+        // destroy all attachments
+        attachmentManager.destroyAll()
         backgroundMaterial = .None
     }
 
+    /// Some SPA navigations (history back/forward) do not trigger a full WKNavigation
+    /// lifecycle. SpatialNavView calls this before navigation actions to ensure
+    /// previously-created spatial objects are cleaned up.
+    func resetForNavigation() {
+        onPageStartLoad()
+    }
+
     private func onGetSpatialSceneState(
         command: GetSpatialSceneStateCommand,
         resolve: @escaping JSBManager.ResolveHandler<Encodable>
@@ -424,6 +481,12 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
     }
 
     private func onDestroySpatialObjectCommand(command: DestroyCommand, resolve: @escaping JSBManager.ResolveHandler<Encodable>) {
+        // Check if it's an attachment first
+        if attachmentManager.get(id: command.id) != nil {
+            attachmentManager.remove(id: command.id)
+            resolve(.success(nil))
+            return
+        }
         if let spatialObject: SpatialObject = findSpatialObject(command.id) {
             spatialObject.destroy()
             resolve(.success(nil))
@@ -698,21 +761,21 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
      * Begin Implement SpatializedElementContainer Protocol
      */
 
-    // SpatialScene can hold a collection of SpatializedElement children
+    /// SpatialScene can hold a collection of SpatializedElement children
     private var children = [String: SpatializedElement]()
 
-    // Called by SpatializedElement.setParent
+    /// Called by SpatializedElement.setParent
     func addChild(_ spatializedElement: SpatializedElement) {
         children[spatializedElement.id] = spatializedElement
     }
 
-    // Called by SpatializedElement.setParent
+    /// Called by SpatializedElement.setParent
     func removeChild(_ spatializedElement: SpatializedElement) {
         children.removeValue(forKey: spatializedElement.id)
     }
 
     func getChildrenOfType(_ type: SpatializedElementType) -> [String: SpatializedElement] {
-        let typedChildren = children.filter {
+        return children.filter {
             switch type {
             case .Spatialized2DElement:
                 return $0.value is Spatialized2DElement
@@ -722,7 +785,6 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
                 return $0.value is SpatializedDynamic3DElement
             }
         }
-        return typedChildren
     }
 
     func getChildren() -> [String: SpatializedElement] {
@@ -733,7 +795,7 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
      * End Implement SpatializedElementContainer Protocol
      */
 
-    /*
+    /**
      * Begin Implement SpatialScrollAble Protocol
      */
     let scrollPageEnabled: Bool = true
@@ -789,7 +851,7 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
      * Begin SpatialObjects management
      */
 
-    // Resources that will be destroyed when this webpage is destoryed or if it is navigated away from
+    /// Resources that will be destroyed when this webpage is destoryed or if it is navigated away from
     private var spatialObjects = [String: any SpatialObjectProtocol]()
 
     func createSpatializedElement<T: SpatializedElement>(_ type: SpatializedElementType) -> T {
@@ -1006,6 +1068,26 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
         resolve(.success(ConvertReply(id: command.entityId, position: point)))
     }
 
+    private func onUpdateAttachmentEntity(command: UpdateAttachmentEntityCommand, resolve: @escaping JSBManager.ResolveHandler<Encodable>) {
+        guard attachmentManager.get(id: command.id) != nil else {
+            resolve(.failure(JsbError(code: .InvalidSpatialObject, message: "Attachment \(command.id) not found")))
+            return
+        }
+
+        var newPosition: SIMD3<Float>? = nil
+        if let posArray = command.position, posArray.count >= 3 {
+            newPosition = SIMD3<Float>(posArray[0], posArray[1], posArray[2])
+        }
+
+        var newSize: CGSize? = nil
+        if let sizeObj = command.size {
+            newSize = CGSize(width: sizeObj.width, height: sizeObj.height)
+        }
+
+        attachmentManager.update(id: command.id, position: newPosition, size: newSize)
+        resolve(.success(baseReplyData))
+    }
+
     private func addSpatialObject(_ object: any SpatialObjectProtocol) {
         var spatialObject = object
         spatialObjects[spatialObject.spatialId] = spatialObject
@@ -1042,6 +1124,7 @@ class SpatialScene: SpatialObject, ScrollAbleSpatialElementContainer, WebMsgSend
         for spatialObject in spatialObjectArray {
             spatialObject.destroy()
         }
+        attachmentManager.destroyAll()
         spatialWebViewModel.destroy()
     }
 

package/web-spatial/model/Spatialized2DElement.swift

@@ -57,15 +57,15 @@ class Spatialized2DElement: SpatializedElement, ScrollAbleSpatialElementContaine
         defaultAlignment = .center
     }
 
-    // Spatialized2DElement can hold a collection of SpatializedElement children
+    /// Spatialized2DElement can hold a collection of SpatializedElement children
     private var children = [String: SpatializedElement]()
 
-    // Called by SpatializedElement.setParent
+    /// Called by SpatializedElement.setParent
     func addChild(_ spatializedElement: SpatializedElement) {
         children[spatializedElement.id] = spatializedElement
     }
 
-    // Called by SpatializedElement.setParent
+    /// Called by SpatializedElement.setParent
     func removeChild(_ spatializedElement: SpatializedElement) {
         children.removeValue(forKey: spatializedElement.id)
     }
@@ -75,7 +75,7 @@ class Spatialized2DElement: SpatializedElement, ScrollAbleSpatialElementContaine
     }
 
     func getChildrenOfType(_ type: SpatializedElementType) -> [String: SpatializedElement] {
-        let typedChildren = children.filter {
+        return children.filter {
             switch type {
             case .Spatialized2DElement:
                 return $0.value is Spatialized2DElement
@@ -85,7 +85,6 @@ class Spatialized2DElement: SpatializedElement, ScrollAbleSpatialElementContaine
                 return $0.value is SpatializedDynamic3DElement
             }
         }
-        return typedChildren
     }
 
     func loadHtml(_ html: String) {

package/web-spatial/model/SpatializedStatic3DElement.swift

@@ -4,7 +4,7 @@ import SwiftUI
 @Observable
 class SpatializedStatic3DElement: SpatializedElement {
     var modelURL: String = ""
-    var modelTransform: AffineTransform3D = AffineTransform3D.identity
+    var modelTransform: AffineTransform3D = .identity
 
     enum CodingKeys: String, CodingKey {
         case modelURL, type

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

@@ -1,40 +1,40 @@
-import SwiftUI
 import RealityKit
+import SwiftUI
 
 @Observable
 class SpatialComponent: SpatialObject {
     let type: SpatialComponentType
-    
-    
-    internal var _resource:Component? = nil
-    var resource:Component? {
+
+    var _resource: Component?
+    var resource: Component? {
         _resource
     }
-    
-    internal var _entity:SpatialEntity? = nil
-    var entity:SpatialEntity? {
+
+    var _entity: SpatialEntity?
+    var entity: SpatialEntity? {
         _entity
     }
-    
-    init(_ _type:SpatialComponentType){
+
+    init(_ _type: SpatialComponentType) {
         type = _type
         super.init()
     }
-    
-    func addToEntity(entity:SpatialEntity){
+
+    func addToEntity(entity: SpatialEntity) {
         if _entity != nil {
             print("This component has already been added to another entity")
             return
         }
-        if let component = resource{
+        if let component = resource {
             _entity = entity
             entity.components.set(component)
         }
     }
-    
-    func removeFromEntity(entity:SpatialEntity){
+
+    func removeFromEntity(entity: SpatialEntity) {
         if let component = resource,
-           self.entity == entity{
+           self.entity == entity
+        {
             entity.components.remove(Swift.type(of: component))
             _entity = nil
         }
@@ -43,30 +43,30 @@ class SpatialComponent: SpatialObject {
 
 @Observable
 class SpatialModelComponent: SpatialComponent {
-    init(mesh:Geometry, mats:[SpatialMaterial]){
+    init(mesh: Geometry, mats: [SpatialMaterial]) {
         super.init(.ModelComponent)
-        var materials:[any RealityKit.Material] = []
-        mats.forEach{ item in
+        var materials: [any RealityKit.Material] = []
+        for item in mats {
             materials.append(item.resource!)
         }
         _resource = ModelComponent(mesh: mesh.resource!, materials: materials)
     }
-    
-    override func addToEntity(entity:SpatialEntity){
+
+    override func addToEntity(entity: SpatialEntity) {
         super.addToEntity(entity: entity)
         entity.generateCollisionShapes(recursive: true)
     }
-    
-    override func removeFromEntity(entity:SpatialEntity){
+
+    override func removeFromEntity(entity: SpatialEntity) {
         super.removeFromEntity(entity: entity)
         entity.generateCollisionShapes(recursive: true)
     }
-    
-    override internal func onDestroy() {
+
+    override func onDestroy() {
         _resource = nil
     }
 }
 
-enum SpatialComponentType:String {
-    case ModelComponent = "ModelComponent"
+enum SpatialComponentType: String {
+    case ModelComponent
 }

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

@@ -159,7 +159,7 @@ class SpatialEntity: Entity, SpatialObjectProtocol {
         transform.rotation = simd_quatf(ix: Float(rotation.imag.x), iy: Float(rotation.imag.y), iz: Float(rotation.imag.z), r: Float(rotation.real))
     }
 
-    // Encodable
+    /// Encodable
     enum CodingKeys: String, CodingKey {
         case id, name, isDestroyed, children, components
     }
@@ -173,7 +173,7 @@ class SpatialEntity: Entity, SpatialObjectProtocol {
         try container.encode(spatialComponents, forKey: .components)
     }
 
-    // Equatable
+    /// Equatable
     static func == (lhs: SpatialEntity, rhs: SpatialEntity) -> Bool {
         return lhs.spatialId == rhs.spatialId
     }

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

@@ -1,39 +1,39 @@
-import SwiftUI
 import RealityKit
+import SwiftUI
 
 @Observable
 class SpatialMaterial: SpatialObject {
     let type: SpatialMaterialType
-    
-    internal var _resource:RealityKit.Material? = nil
-    var resource:RealityKit.Material? {
+
+    var _resource: RealityKit.Material?
+    var resource: RealityKit.Material? {
         _resource
     }
-    
-    init(_ _type:SpatialMaterialType){
+
+    init(_ _type: SpatialMaterialType) {
         type = _type
         super.init()
     }
-    
+
     override func onDestroy() {
         _resource = nil
     }
 }
 
 @Observable
-class SpatialUnlitMaterial: SpatialMaterial{
-    let color:UIColor
-    
-    init(_ color:String, _ texture:TextureResource? = nil, _ transparent:Bool = true, _ opacity:Float = 1){
-        self.color = UIColor.init(Color(hex: color))
+class SpatialUnlitMaterial: SpatialMaterial {
+    let color: UIColor
+
+    init(_ color: String, _ texture: TextureResource? = nil, _ transparent: Bool = true, _ opacity: Float = 1) {
+        self.color = UIColor(Color(hex: color))
         super.init(.UnlitMaterial)
         var mat = UnlitMaterial()
-        mat.color = .init(tint:UIColor(Color.init(hex: color)), texture: texture != nil ? .init(texture!) : nil)
+        mat.color = .init(tint: UIColor(Color(hex: color)), texture: texture != nil ? .init(texture!) : nil)
         mat.blending = transparent ? .transparent(opacity: .init(scale: opacity)) : .opaque
         _resource = mat
     }
 }
 
-enum SpatialMaterialType: String{
-    case UnlitMaterial = "UnlitMaterial"
+enum SpatialMaterialType: String {
+    case UnlitMaterial
 }

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

@@ -1,32 +1,32 @@
-import SwiftUI
 import RealityKit
+import SwiftUI
 
 @Observable
-class SpatialModelEntity: SpatialEntity{
-    private var modelEntity:Entity? = nil
-    required init(_ modelResource:SpatialModelResource, _ _name:String = ""){
+class SpatialModelEntity: SpatialEntity {
+    private var modelEntity: Entity?
+    required init(_ modelResource: SpatialModelResource, _ _name: String = "") {
         super.init(_name)
         modelEntity = modelResource.resource
         addChild(modelEntity!)
         generateCollisionShapes(recursive: true)
     }
-    
+
     required init() {
         super.init()
     }
-    
-    override internal func onDestroy(){
+
+    override func onDestroy() {
         super.onDestroy()
-        if let modelEntity = self.modelEntity{
+        if let modelEntity = modelEntity {
             removeChild(modelEntity)
         }
         modelEntity = nil
     }
-    
+
     enum CodingKeys: String, CodingKey {
         case id, name, isDestroyed, children, components, model
     }
-    
+
     override func encode(to encoder: any Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         try container.encode(spatialId, forKey: .id)

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

@@ -3,7 +3,7 @@ import SwiftUI
 
 @Observable
 class SpatialModelResource: SpatialObject {
-    var _resource: Entity? = nil
+    var _resource: Entity?
     var resource: Entity? {
         _resource
     }

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

@@ -1,18 +1,18 @@
-import SwiftUI
 import RealityKit
+import SwiftUI
 
 @Observable
-class SpatialTextureResource:SpatialObject {
-    internal var _resource:TextureResource? = nil
-    var resource:TextureResource? {
+class SpatialTextureResource: SpatialObject {
+    var _resource: TextureResource?
+    var resource: TextureResource? {
         _resource
     }
-    
-    override init(_ url:String){
+
+    override init(_ url: String) {
         super.init()
     }
-    
-    override internal func onDestroy() {
+
+    override func onDestroy() {
         _resource = nil
     }
 }