@galacean/effects-plugin-spine 2.0.0-alpha.16 → 2.0.0-alpha.17

package/README.md

@@ -12,10 +12,11 @@ import '@galacean/effects-plugin-spine';
 ### Get Spine Resource List
 
 ``` ts
-import type { SpineResource } from '@galacean/effects-plugin-spine';
+import type { SpineDataCache } from '@galacean/effects-plugin-spine';
 
 const comp = await player.play(scene);
-const spineData: SpineResource[] = comp.loaderData.spineDatas;
+const item = comp.getItemByName('itemName');
+const spineData: SpineDataCache = item.spineDataCache;
 ```
 
 ### Get Animation List / Skin List
@@ -24,17 +25,18 @@ const spineData: SpineResource[] = comp.loaderData.spineDatas;
 
 ``` ts
 const comp = await new Player().loadScene(scene);
-const item = comp.getItemByName(name)
+const item = comp.getItemByName('itemName');
 const { skeletonData } = item.spineDataCache;
 const animationList = getAnimationList(skeletonData);
 const skinList = getSkinList(skeletonData);
 ```
 
-2. Get from the `spineDatas` array
+2. After starting, you can access it in the `spineDataCache`.
 
 ``` ts
 const comp = await new Player().loadScene(scene);
-const { skinList, animationList } = comp.loaderData.spineDatas[index];
+const item = comp.getItemByName('itemName')
+const { skinList, animationList } = item.spineDataCache;
 ```
 
 ### Get Duration of a Specific Animation

package/dist/alipay.js

@@ -26,12 +26,6 @@ function _inherits(subClass, superClass) {
     if (superClass) _set_prototype_of(subClass, superClass);
 }
 
-function _instanceof1(left, right) {
-    if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
-        return !!right[Symbol.hasInstance](left);
-    } else return _instanceof1(left, right);
-}
-
 function _array_like_to_array(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
@@ -67,6 +61,12 @@ function _create_for_of_iterator_helper_loose(o, allowArrayLike) {
     throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
 
+function _instanceof1(left, right) {
+    if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
+        return !!right[Symbol.hasInstance](left);
+    } else return _instanceof1(left, right);
+}
+
 function _assert_this_initialized(self) {
     if (self === void 0) throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
     return self;
@@ -10616,9 +10616,10 @@ function setBlending(material, mode, pma) {
 /**
  * 从二进制数据中解析 atlas 数据
  * @param buffer - atlas 文件对应的二进制数据
+ * @param start - buffer 中的起始索引
+ * @param length - buffer 的长度
  */ function getAtlasFromBuffer(buffer) {
-    var atlasText = decodeText(new Uint8Array(buffer));
-    return new TextureAtlas(atlasText);
+    return new TextureAtlas(decodeText(buffer));
 }
 /**
  * 从二进制数据中解析用于创建 skeletonData 的数据
@@ -10634,80 +10635,29 @@ function setBlending(material, mode, pma) {
     }
     return skeletonFile;
 }
-
-/**
- *
- */ var SpineLoader = /*#__PURE__*/ function(AbstractPlugin) {
-    _inherits(SpineLoader, AbstractPlugin);
-    function SpineLoader() {
-        return AbstractPlugin.apply(this, arguments);
-    }
-    var _proto = SpineLoader.prototype;
-    _proto.onCompositionConstructed = function onCompositionConstructed(composition, scene) {
-        if (!scene.jsonScene.spines) {
-            return;
-        }
-        composition.loaderData.spineDatas = scene.jsonScene.spines.map(function(resource, index) {
-            return readSpineData(resource, scene.bins, composition.textures, composition);
-        });
-    };
-    _proto.onCompositionDestroyed = function onCompositionDestroyed(composition) {
-        if (composition.loaderData.spineDatas) {
-            delete composition.loaderData.spineDatas;
-        }
-    };
-    return SpineLoader;
-}(effects.AbstractPlugin);
-function readSpineData(resource, bins, textures, composition) {
-    var atlasPointer = resource.atlas, skeletonPointer = resource.skeleton, images = resource.images, skeletonType = resource.skeletonType;
-    var _atlasPointer_ = atlasPointer[1], index = _atlasPointer_[0], tmp = _atlasPointer_[1], start = tmp === void 0 ? 0 : tmp, bufferLength = _atlasPointer_[2];
-    var atlasBuffer = bins[index];
-    var atlasText = bufferLength ? decodeText(new Uint8Array(atlasBuffer, start, bufferLength)) : decodeText(new Uint8Array(atlasBuffer, start));
-    var atlas = new TextureAtlas(atlasText);
+function readAtlasData(atlasBuffer, textures) {
+    var atlas = getAtlasFromBuffer(atlasBuffer);
     var pageCount = atlas.pages.length;
-    var engine = composition.getEngine();
-    if (images.length !== pageCount) {
-        throw new Error("atlas.page's length not equal spine.textures' length");
-    }
     for(var i = 0; i < pageCount; i++){
         var page = atlas.pages[i];
-        // 直接获取Texture
-        var tex = images[i];
-        // @ts-expect-error
-        if (images[i].id) {
-            var textureId = images[i].id;
-            tex = engine.assetLoader.loadGUID(textureId);
-        } else if (typeof images[i] === "number") {
-            // TODO 老JSON的兼容逻辑
-            tex = textures[images[i]];
-        }
-        if (!tex) {
+        var texture = textures[i];
+        if (!texture) {
             throw new Error("Can not find page " + page.name + "'s texture, check the texture name");
         }
-        page.texture = tex;
+        page.texture = texture;
     }
-    var _skeletonPointer_ = skeletonPointer[1], skelIndex = _skeletonPointer_[0], tmp1 = _skeletonPointer_[1], skelStart = tmp1 === void 0 ? 0 : tmp1, skelBufferLength = _skeletonPointer_[2];
-    var skeletonBuffer = skelBufferLength ? bins[skelIndex].slice(skelStart, skelStart + skelBufferLength) : bins[skelIndex].slice(skelStart);
-    var skeletonFile = getSkeletonFromBuffer(skeletonBuffer, skeletonType);
-    var skeletonData = createSkeletonData(atlas, skeletonFile, skeletonType); //VFXItem用此skeletonData新建skeleton实例会造成纹理丢失
-    var skinList = getSkinList(skeletonData);
-    var animationList = getAnimationList(skeletonData);
-    return {
-        atlas: atlas,
-        skeletonFile: skeletonFile,
-        skeletonData: skeletonData,
-        images: images,
-        skeletonType: skeletonType,
-        skeletonInstance: new Skeleton(skeletonData),
-        skinList: skinList,
-        animationList: animationList,
-        // @ts-expect-error
-        texturesOptions: images.map(function(texturePointer) {
-            return textures[texturePointer];
-        }),
-        // @ts-expect-error
-        id: resource.id
+    return atlas;
+}
+
+function _extends() {
+    _extends = Object.assign || function assign(target) {
+        for(var i = 1; i < arguments.length; i++){
+            var source = arguments[i];
+            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
+        }
+        return target;
     };
+    return _extends.apply(this, arguments);
 }
 
 function __decorate(decorators, target, key, desc) {
@@ -11061,8 +11011,8 @@ var SlotGroup = /*#__PURE__*/ function() {
         }
         clipper.clipEnd();
         this.wm = this.transform.getWorldMatrix();
-        this.meshGroups.map(function(sp) {
-            return sp.endUpdate(_this.wm);
+        this.meshGroups.map(function(sp, index) {
+            sp.endUpdate(_this.wm);
         });
     };
     /**
@@ -11083,7 +11033,7 @@ var SlotGroup = /*#__PURE__*/ function() {
         var res = -1;
         for(var i = startIndex; i < this.meshGroups.length; i++){
             var mesh = this.meshGroups[i];
-            if (mesh && mesh.blending === blendMode && mesh.texture.name === texture.name && vertexNum + mesh.indicesNum < SlotGroup.MAX_VERTICES) {
+            if (mesh && mesh.blending === blendMode && mesh.texture === texture && vertexNum + mesh.indicesNum < SlotGroup.MAX_VERTICES) {
                 res = i;
                 break;
             }
@@ -11112,9 +11062,9 @@ var SlotGroup = /*#__PURE__*/ function() {
 var Vector2 = effects.math.Vector2, Vector3 = effects.math.Vector3;
 exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
     _inherits(SpineComponent, RendererComponent);
-    function SpineComponent(engine, options) {
+    function SpineComponent() {
         var _this;
-        _this = RendererComponent.call(this, engine) || this;
+        _this = RendererComponent.apply(this, arguments) || this;
         /**
    * aabb 包围盒与 skeleton 原点的距离
    */ _this.offset = new Vector2();
@@ -11124,24 +11074,31 @@ exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
         return _this;
     }
     var _proto = SpineComponent.prototype;
-    _proto.fromData = function fromData(options) {
-        RendererComponent.prototype.fromData.call(this, options);
-        this.options = options;
+    _proto.fromData = function fromData(data) {
+        RendererComponent.prototype.fromData.call(this, data);
+        var _this_resource = this.resource, textures = _this_resource.images, skeletonType = _this_resource.skeletonType, atlasOptions = _this_resource.atlas, skeletonOptions = _this_resource.skeleton;
+        var _atlasOptions_source = atlasOptions.source, start = _atlasOptions_source[0], bufferLength = _atlasOptions_source[1];
+        var atlasBuffer = bufferLength ? new Uint8Array(atlasOptions.bins.buffer, start, bufferLength) : new Uint8Array(atlasOptions.bins.buffer, start);
+        var atlas = readAtlasData(atlasBuffer, textures);
+        var skBuffer = skeletonOptions.bins.buffer;
+        var _skeletonOptions_source = skeletonOptions.source, skelStart = _skeletonOptions_source[0], skelBufferLength = _skeletonOptions_source[1];
+        var skeletonBuffer = skelBufferLength ? skBuffer.slice(skelStart, skelStart + skelBufferLength) : skBuffer.slice(skelStart);
+        var skeletonFile = getSkeletonFromBuffer(skeletonBuffer, skeletonType);
+        var skeletonData = createSkeletonData(atlas, skeletonFile, skeletonType);
+        this.spineDataCache = {
+            atlas: atlas,
+            skeletonData: skeletonData
+        };
+        this.options = data.options;
         this.item.getHitTestParams = this.getHitTestParams.bind(this);
     };
     _proto.start = function start() {
-        var _this_item_composition;
         RendererComponent.prototype.start.call(this);
-        var content = this.options;
-        if (!content) {
-            console.error("options used to create SpineComponent is undefined");
-            return;
-        }
-        this.initContent(content.options, (_this_item_composition = this.item.composition) == null ? void 0 : _this_item_composition.loaderData.spineDatas);
+        this.initContent(this.spineDataCache.atlas, this.spineDataCache.skeletonData, this.options);
         // @ts-expect-error
-        this.startSize = content.options.startSize;
+        this.startSize = this.options.startSize;
         // @ts-expect-error
-        this.renderer = content.renderer;
+        this.renderer = this.options.renderer;
         if (!this.state) {
             return;
         }
@@ -11150,7 +11107,6 @@ exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
         this.resize();
     };
     _proto.update = function update(dt) {
-        var _this_content;
         if (!(this.state && this.skeleton)) {
             return;
         }
@@ -11158,7 +11114,9 @@ exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
         this.state.apply(this.skeleton);
         this.skeleton.update(dt / 1000);
         this.skeleton.updateWorldTransform(exports.Physics.update);
-        (_this_content = this.content) == null ? void 0 : _this_content.update();
+        if (this.content) {
+            this.content.update();
+        }
     };
     _proto.render = function render(renderer) {
         var _this_content;
@@ -11170,24 +11128,18 @@ exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
             this.state.clearTracks();
         }
     };
-    _proto.initContent = function initContent(spineOptions, spineDatas) {
-        var index = spineOptions.spine;
-        if (isNaN(index)) {
-            return;
-        }
-        var _spineDatas_index = spineDatas[index], atlas = _spineDatas_index.atlas, skeletonData = _spineDatas_index.skeletonData, skeletonInstance = _spineDatas_index.skeletonInstance, skinList = _spineDatas_index.skinList, animationList = _spineDatas_index.animationList;
+    _proto.initContent = function initContent(atlas, skeletonData, spineOptions) {
         var activeAnimation = typeof spineOptions.activeAnimation === "string" ? [
             spineOptions.activeAnimation
         ] : spineOptions.activeAnimation;
-        this.skeleton = skeletonInstance;
+        this.skeleton = new Skeleton(skeletonData);
         this.skeletonData = skeletonData;
         this.animationStateData = new AnimationStateData(this.skeletonData);
         this.animationStateData.defaultMix = spineOptions.mixDuration || 0;
-        this.spineDataCache = spineDatas[index];
-        this.skinList = skinList.slice();
-        this.animationList = animationList.slice();
+        this.skinList = getSkinList(skeletonData);
+        this.animationList = getAnimationList(skeletonData);
         this.resizeRule = spineOptions.resizeRule;
-        this.setSkin(spineOptions.activeSkin || (skinList.length ? skinList[0] : "default"));
+        this.setSkin(spineOptions.activeSkin || (this.skinList.length ? this.skinList[0] : "default"));
         this.state = new AnimationState(this.animationStateData);
         if (activeAnimation.length === 1) {
             // 兼容旧JSON，根据时长计算速度
@@ -11200,6 +11152,11 @@ exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
         } else {
             this.setAnimationList(activeAnimation, spineOptions.speed);
         }
+        this.spineDataCache = _extends({}, this.spineDataCache, {
+            skeletonInstance: this.skeleton,
+            skinList: this.skinList,
+            animationList: this.animationList
+        });
         this.pma = atlas.pages[0].pma;
         this._priority = this.item.renderOrder;
         this.content = new SlotGroup(this.skeleton.drawOrder, {
@@ -11432,12 +11389,21 @@ exports.SpineComponent = /*#__PURE__*/ function(RendererComponent) {
     };
     return SpineComponent;
 }(effects.RendererComponent);
+__decorate([
+    effects.serialize()
+], exports.SpineComponent.prototype, "resource", void 0);
 exports.SpineComponent = __decorate([
     effects.effectsClass("SpineComponent")
 ], exports.SpineComponent);
 
-effects.registerPlugin("spine", SpineLoader, effects.VFXItem);
-var version = "2.0.0-alpha.16";
+effects.registerPlugin("spine", /*#__PURE__*/ function(AbstractPlugin) {
+    _inherits(SpineLoader, AbstractPlugin);
+    function SpineLoader() {
+        return AbstractPlugin.apply(this, arguments);
+    }
+    return SpineLoader;
+}(effects.AbstractPlugin), effects.VFXItem);
+var version = "2.0.0-alpha.17";
 effects.logger.info("plugin spine version: " + version);
 if (version !== effects.version) {
     console.error("注意：请统一 Spine 插件与 Player 版本，不统一的版本混用会有不可预知的后果！", "\nAttention: Please ensure the Spine plugin is synchronized with the Player version. Mixing and matching incompatible versions may result in unpredictable consequences!");
@@ -11528,7 +11494,6 @@ exports.Skin = Skin;
 exports.SkinEntry = SkinEntry;
 exports.Slot = Slot;
 exports.SlotData = SlotData;
-exports.SpineLoader = SpineLoader;
 exports.StringSet = StringSet;
 exports.Texture = Texture;
 exports.TextureAtlas = TextureAtlas;