Introduce VRMKitRuntime (#43)

* feat: Introduce VRMKitRuntime for common implementation

* Clean code

Author: tattn

Example/Example/RealityKitViewController.swift

@@ -15,7 +15,7 @@ final class RealityKitViewController: UIViewController, UIGestureRecognizerDeleg
     private var orbitPitch: Float = -0.1
     private var orbitDistance: Float = 2
     private var orbitTarget = SIMD3<Float>(0, 0.8, 0)
-    private var currentExpression: RKExpression = .neutral
+    private var currentExpression: Expression = .neutral
 
     override func viewDidLoad() {
         super.viewDidLoad()
@@ -52,7 +52,7 @@ final class RealityKitViewController: UIViewController, UIGestureRecognizerDeleg
         segmentedControl.translatesAutoresizingMaskIntoConstraints = false
         view.addSubview(segmentedControl)
 
-        let expressionItems = RKExpression.allCases.map { $0.displayName }
+        let expressionItems = Expression.allCases.map { $0.displayName }
         let expressionSegmentedControl = UISegmentedControl(items: expressionItems)
         expressionSegmentedControl.selectedSegmentIndex = 0
         expressionSegmentedControl.addTarget(self, action: #selector(expressionSegmentChanged(_:)), for: .valueChanged)
@@ -73,7 +73,7 @@ final class RealityKitViewController: UIViewController, UIGestureRecognizerDeleg
     }
 
     @objc private func expressionSegmentChanged(_ sender: UISegmentedControl) {
-        let expression = RKExpression.allCases[sender.selectedSegmentIndex]
+        let expression = Expression.allCases[sender.selectedSegmentIndex]
         loadedEntity?.setBlendShape(value: 0.0, for: .preset(currentExpression.preset))
         currentExpression = expression
         loadedEntity?.setBlendShape(value: 1.0, for: .preset(currentExpression.preset))
@@ -249,22 +249,3 @@ final class RealityKitViewController: UIViewController, UIGestureRecognizerDeleg
         return true
     }
 }
-
-@available(iOS 18.0, *)
-private enum RKExpression: String, CaseIterable {
-    case neutral, joy, angry, sorrow, fun
-
-    var preset: BlendShapePreset {
-        switch self {
-        case .neutral: return .neutral
-        case .joy: return .joy
-        case .angry: return .angry
-        case .sorrow: return .sorrow
-        case .fun: return .fun
-        }
-    }
-
-    var displayName: String {
-        return rawValue.capitalized
-    }
-}

Package.swift

@@ -12,12 +12,16 @@ let package = Package(
     targets: [
         .target(name: "VRMKit"),
         .target(
-            name: "VRMSceneKit",
+            name: "VRMKitRuntime",
             dependencies: ["VRMKit"]
         ),
+        .target(
+            name: "VRMSceneKit",
+            dependencies: ["VRMKit", "VRMKitRuntime"]
+        ),
         .target(
             name: "VRMRealityKit",
-            dependencies: ["VRMKit"]
+            dependencies: ["VRMKit", "VRMKitRuntime"]
         ),
 
         .testTarget(

Sources/VRMKitRuntime/BlendShapeTypes.swift

@@ -0,0 +1,37 @@
+public enum BlendShapeKey: Hashable {
+    case preset(BlendShapePreset)
+    case custom(String)
+
+    public var isPreset: Bool {
+        switch self {
+        case .preset: return true
+        case .custom: return false
+        }
+    }
+}
+
+/// VRM 0.x Blend Shape Preset
+public enum BlendShapePreset: String {
+    case unknown
+    case neutral
+    case a
+    case i
+    case u
+    case e
+    case o
+    case blink
+    case joy
+    case angry
+    case sorrow
+    case fun
+    case lookUp = "lookup"
+    case lookDown = "lookdown"
+    case lookLeft = "lookleft"
+    case lookRight = "lookright"
+    case blinkL = "blink_l"
+    case blinkR = "blink_r"
+
+    package init(name: String) {
+        self = BlendShapePreset(rawValue: name.lowercased()) ?? .unknown
+    }
+}

…ces/VRMRealityKit/Extensions/GLTF+.swift Sources/VRMKitRuntime/GLTF+Runtime.swiftSources/VRMRealityKit/Extensions/GLTF+.swift renamed to Sources/VRMKitRuntime/GLTF+Runtime.swift Sources/VRMRealityKit/Extensions/GLTF+.swift renamed to Sources/VRMKitRuntime/GLTF+Runtime.swift

@@ -1,6 +1,6 @@
 import VRMKit
 
-protocol GLTFTextureInfoProtocol {
+package protocol GLTFTextureInfoProtocol {
     var index: Int { get }
     var texCoord: Int { get }
 }

Sources/VRMKitRuntime/SIMD+Runtime.swift

@@ -0,0 +1,37 @@
+import simd
+
+public extension SIMD3 where Scalar == Float {
+    var normalized: SIMD3 {
+        simd_normalize(self)
+    }
+
+    var length: Scalar {
+        simd_length(self)
+    }
+
+    var length_squared: Scalar {
+        simd_length_squared(self)
+    }
+
+    mutating func normalize() {
+        self = normalized
+    }
+}
+
+public extension simd_quatf {
+    static func * (_ left: simd_quatf, _ right: SIMD3<Float>) -> SIMD3<Float> {
+        simd_act(left, right)
+    }
+}
+
+public let quat_identity_float = simd_quatf(matrix_identity_float4x4)
+
+public func cross(_ left: SIMD3<Float>, _ right: SIMD3<Float>) -> SIMD3<Float> {
+    simd_cross(left, right)
+}
+
+public func normal(_ v0: SIMD3<Float>, _ v1: SIMD3<Float>, _ v2: SIMD3<Float>) -> SIMD3<Float> {
+    let e1 = v1 - v0
+    let e2 = v2 - v0
+    return simd_normalize(simd_cross(e1, e2))
+}

Sources/VRMKitRuntime/UnityTransform.swift

@@ -0,0 +1,18 @@
+public protocol UnityTransformCompatible {
+    associatedtype CompatibleType
+    var utx: CompatibleType { get }
+}
+
+public final class UnityTransform<Base> {
+    package let base: Base
+
+    public init(_ base: Base) {
+        self.base = base
+    }
+}
+
+public extension UnityTransformCompatible {
+    var utx: UnityTransform<Self> {
+        UnityTransform(self)
+    }
+}

Sources/VRMRealityKit/CustomType/BlendShape.swift

@@ -1,5 +1,6 @@
 #if canImport(RealityKit)
 import RealityKit
+import VRMKitRuntime
 
 struct BlendShapeClip {
     let name: String
@@ -23,40 +24,4 @@ struct MaterialValueBinding {
     let targetValue: SIMD4<Float>
     let baseValue: SIMD4<Float>
 }
-
-public enum BlendShapeKey: Hashable {
-    case preset(BlendShapePreset)
-    case custom(String)
-    var isPreset: Bool {
-        switch self {
-        case .preset: return true
-        case .custom: return false
-        }
-    }
-}
-
-public enum BlendShapePreset: String {
-    case unknown
-    case neutral
-    case a
-    case i
-    case u
-    case e
-    case o
-    case blink
-    case joy
-    case angry
-    case sorrow
-    case fun
-    case lookUp = "lookup"
-    case lookDown = "lookdown"
-    case lookLeft = "lookleft"
-    case lookRight = "lookright"
-    case blinkL = "blink_l"
-    case blinkR = "blink_r"
-
-    init(name: String) {
-        self = BlendShapePreset(rawValue: name.lowercased()) ?? .unknown
-    }
-}
 #endif

Sources/VRMRealityKit/CustomType/VRMEntity.swift

@@ -3,6 +3,7 @@ import CoreGraphics
 import Foundation
 import RealityKit
 import VRMKit
+import VRMKitRuntime
 
 @available(iOS 18.0, macOS 15.0, visionOS 2.0, *)
 struct BlendShapeNormalTangentComponent: Component {
@@ -360,4 +361,3 @@ public final class VRMEntity {
     }
 }
 #endif
-

Sources/VRMRealityKit/CustomType/VRMEntitySpringBone.swift

@@ -1,6 +1,7 @@
 #if canImport(RealityKit)
 import RealityKit
 import VRMKit
+import VRMKitRuntime
 import Foundation
 
 @available(iOS 18.0, macOS 15.0, visionOS 2.0, *)

Sources/VRMRealityKit/Extensions/Entity+UnityTransform.swift

@@ -1,24 +1,7 @@
 #if canImport(RealityKit)
 import RealityKit
 import simd
-
-public protocol UnityTransformCompatible {
-    associatedtype CompatibleType
-    var utx: CompatibleType { get }
-}
-
-public final class UnityTransform<Base> {
-    private let base: Base
-    public init(_ base: Base) {
-        self.base = base
-    }
-}
-
-public extension UnityTransformCompatible {
-    var utx: UnityTransform<Self> {
-        UnityTransform(self)
-    }
-}
+import VRMKitRuntime
 
 extension Entity: UnityTransformCompatible {}