@galacean/effects-specification 2.0.0-alpha.2 → 2.0.0-alpha.4

package/dist/fallback/index.d.ts

@@ -1,7 +1,7 @@
-import type { BaseItem, Composition, CompressedImage, Image, JSONScene, ParticleItem, RenderLevel, SpriteItem, TemplateImage, VideoImage, FilterItem } from '../src';
+import type { BaseItem, Composition, CompressedImage, Image, JSONScene, ParticleItem, RenderLevel, SpriteItem, TemplateImage, FilterItem } from '../src';
 export * from './utils';
 export declare function getStandardJSON(json: any): JSONScene;
-export declare function getStandardImage(image: any, index: number, imageTags: RenderLevel[]): TemplateImage | Image | CompressedImage | VideoImage;
+export declare function getStandardImage(image: any, index: number, imageTags: RenderLevel[]): TemplateImage | Image | CompressedImage;
 export declare function getStandardComposition(composition: any, opt?: {
     plugins?: string[];
     requires?: string[];

package/dist/fallback.js

@@ -2,13 +2,83 @@
  * Name: @galacean/effects-specification
  * Description: Galacean Effects JSON Specification
  * Author: Ant Group CO., Ltd.
- * Version: v2.0.0-alpha.2
+ * Version: v2.0.0-alpha.4
  */
 
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
+function __values(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+}
+
+function __read(o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+}
+
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
 const randomUUID = typeof crypto !== 'undefined' && crypto.randomUUID && crypto.randomUUID.bind(crypto);
 var native = {
   randomUUID
@@ -458,6 +528,16 @@ var CompositionEndBehavior;
     CompositionEndBehavior[CompositionEndBehavior["freeze"] = END_BEHAVIOR_FREEZE] = "freeze";
 })(CompositionEndBehavior || (CompositionEndBehavior = {}));
 
+/**
+ * 动态换图类型
+ * @since 1.3.0
+ */
+var BackgroundType;
+(function (BackgroundType) {
+    BackgroundType["video"] = "video";
+    BackgroundType["image"] = "image";
+})(BackgroundType || (BackgroundType = {}));
+
 /*********************************************/
 /*               基本数值属性参数              */
 /*********************************************/
@@ -790,76 +870,37 @@ var DataType;
     DataType["ModelPluginComponent"] = "ModelPluginComponent";
     DataType["TreeComponent"] = "TreeComponent";
 })(DataType || (DataType = {}));
-
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-var __assign = function() {
-    __assign = Object.assign || function __assign(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-
-function __values(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-}
-
-function __read(o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-}
-
-function __spreadArray(to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
+var GeometryType;
+(function (GeometryType) {
+    /**
+     * Draw single points.
+     */
+    GeometryType[GeometryType["POINTS"] = 0] = "POINTS";
+    /**
+     * Draw lines. Each vertex connects to the one after it.
+     */
+    GeometryType[GeometryType["LINES"] = 1] = "LINES";
+    /**
+     * Draw lines. Each set of two vertices is treated as a separate line segment.
+     */
+    GeometryType[GeometryType["LINE_LOOP"] = 2] = "LINE_LOOP";
+    /**
+     * Draw a connected group of line segments from the first vertex to the last.
+     */
+    GeometryType[GeometryType["LINE_STRIP"] = 3] = "LINE_STRIP";
+    /**
+     * Draw triangles. Each set of three vertices creates a separate triangle.
+     */
+    GeometryType[GeometryType["TRIANGLES"] = 4] = "TRIANGLES";
+    /**
+     * Draw a connected strip of triangles.
+     */
+    GeometryType[GeometryType["TRIANGLE_STRIP"] = 5] = "TRIANGLE_STRIP";
+    /**
+     * Draw a connected group of triangles. Each vertex connects to the previous and the first vertex in the fan.
+     */
+    GeometryType[GeometryType["TRIANGLE_FAN"] = 6] = "TRIANGLE_FAN";
+})(GeometryType || (GeometryType = {}));
 
 var _a;
 function arrAdd(arr, item) {
@@ -1541,21 +1582,14 @@ function version22Migration(json) {
  */
 function version30Migration(json) {
     var e_1, _a;
-    var _b, _c, _d, _e;
-    var result = Object.assign({}, json, {
-        items: [],
-        components: [],
-        materials: [],
-        shaders: [],
-        geometries: [],
-    });
+    var _b, _c, _d, _e, _f, _g, _h, _j;
+    var result = __assign(__assign({}, json), { items: [], components: [], materials: [], shaders: [], geometries: [] });
     // 兼容老版本数据中不存在textures的情况
     (_b = result.textures) !== null && _b !== void 0 ? _b : (result.textures = []);
     result.textures.forEach(function (textureOptions) {
-        Object.assign(textureOptions, {
-            id: generateGUID(),
-            dataType: DataType.Texture,
-        });
+        textureOptions = __assign(__assign({}, textureOptions), { 
+            // @ts-expect-error
+            id: generateGUID(), dataType: DataType.Texture });
     });
     if (result.textures.length < result.images.length) {
         for (var i = result.textures.length; i < result.images.length; i++) {
@@ -1569,15 +1603,15 @@ function version30Migration(json) {
         }
     }
     var _loop_1 = function (composition) {
-        var e_2, _h, e_3, _j;
+        var e_2, _m, e_3, _o;
         // composition 的 endbehaviour 兼容
         if (composition.endBehavior === END_BEHAVIOR_PAUSE_AND_DESTROY || composition.endBehavior === END_BEHAVIOR_PAUSE) {
             composition.endBehavior = END_BEHAVIOR_FREEZE;
         }
         var itemGuidMap = {};
         try {
-            for (var _k = (e_2 = void 0, __values(composition.items)), _l = _k.next(); !_l.done; _l = _k.next()) {
-                var item = _l.value;
+            for (var _p = (e_2 = void 0, __values(composition.items)), _q = _p.next(); !_q.done; _q = _p.next()) {
+                var item = _q.value;
                 itemGuidMap[item.id] = generateGUID();
                 // TODO: 编辑器测试用，上线后删除
                 //@ts-expect-error
@@ -1588,7 +1622,7 @@ function version30Migration(json) {
         catch (e_2_1) { e_2 = { error: e_2_1 }; }
         finally {
             try {
-                if (_l && !_l.done && (_h = _k.return)) _h.call(_k);
+                if (_q && !_q.done && (_m = _p.return)) _m.call(_p);
             }
             finally { if (e_2) throw e_2.error; }
         }
@@ -1609,8 +1643,8 @@ function version30Migration(json) {
             composition.items[index] = { id: item.id };
         });
         try {
-            for (var _m = (e_3 = void 0, __values(result.items)), _o = _m.next(); !_o.done; _o = _m.next()) {
-                var item = _o.value;
+            for (var _r = (e_3 = void 0, __values(result.items)), _s = _r.next(); !_s.done; _s = _r.next()) {
+                var item = _s.value;
                 // 原 texture 索引转为统一 guid 索引
                 if (item.content) {
                     if (item.content.renderer) {
@@ -1639,7 +1673,7 @@ function version30Migration(json) {
                     Object.assign(item, {
                         transform: {
                             position: { x: position[0], y: position[1], z: position[2] },
-                            rotation: { x: rotation[0], y: rotation[1], z: rotation[2] },
+                            eulerHint: { x: rotation[0], y: rotation[1], z: rotation[2] },
                             scale: { x: scale[0], y: scale[1], z: scale[0] },
                         },
                     });
@@ -1659,13 +1693,10 @@ function version30Migration(json) {
                         var startSize = item.transform.size;
                         // 兼容旧JSON（anchor和particleOrigin可能同时存在）
                         if (!renderer.anchor && renderer.particleOrigin !== undefined) {
-                            //@ts-expect-error
-                            item.transform.position.x += -realAnchor[0] * startSize.x;
-                            //@ts-expect-error
-                            item.transform.position.y += -realAnchor[1] * startSize.y;
+                            item.transform.position.x += -realAnchor[0] * ((_f = startSize === null || startSize === void 0 ? void 0 : startSize.x) !== null && _f !== void 0 ? _f : 1);
+                            item.transform.position.y += -realAnchor[1] * ((_g = startSize === null || startSize === void 0 ? void 0 : startSize.y) !== null && _g !== void 0 ? _g : 1);
                         }
-                        //@ts-expect-error
-                        item.transform.anchor = { x: realAnchor[0] * startSize.x, y: realAnchor[1] * startSize.y };
+                        item.transform.anchor = { x: realAnchor[0] * ((_h = startSize === null || startSize === void 0 ? void 0 : startSize.x) !== null && _h !== void 0 ? _h : 1), y: realAnchor[1] * ((_j = startSize === null || startSize === void 0 ? void 0 : startSize.y) !== null && _j !== void 0 ? _j : 1) };
                     }
                 }
                 if (item.type === ItemType.particle) {
@@ -1712,127 +1743,76 @@ function version30Migration(json) {
                 }
                 // item 的 content 转为 component data 加入 JSONScene.components
                 var uuid = generateGUID();
-                if (item.type === ItemType.sprite) {
+                if (item.type === ItemType.sprite ||
+                    item.type === ItemType.particle ||
+                    item.type === ItemType.mesh ||
+                    item.type === ItemType.skybox ||
+                    item.type === ItemType.light ||
+                    item.type === 'camera' ||
+                    item.type === ItemType.tree ||
+                    item.type === ItemType.interact ||
+                    item.type === ItemType.camera ||
+                    item.type === ItemType.text) {
                     item.components = [];
                     result.components.push(item.content);
                     item.content.id = uuid;
-                    item.content.dataType = DataType.SpriteComponent;
                     item.content.item = { id: item.id };
                     item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.particle) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.ParticleSystem;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
                     item.components.push({ id: item.content.id });
                 }
-                else if (item.type === ItemType.mesh) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.MeshComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.skybox) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.SkyboxComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.light) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.LightComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === 'camera') {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.CameraComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.tree) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.TreeComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.interact) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.InteractComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.camera) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.CameraController;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
-                }
-                else if (item.type === ItemType.text) {
-                    item.components = [];
-                    result.components.push(item.content);
-                    item.content.id = uuid;
-                    item.content.dataType = DataType.TextComponent;
-                    item.content.item = { id: item.id };
-                    item.dataType = DataType.VFXItemData;
-                    //@ts-expect-error
-                    item.components.push({ id: item.content.id });
+                switch (item.type) {
+                    case ItemType.sprite:
+                        item.content.dataType = DataType.SpriteComponent;
+                        break;
+                    case ItemType.particle:
+                        item.content.dataType = DataType.ParticleSystem;
+                        break;
+                    case ItemType.mesh:
+                        item.content.dataType = DataType.MeshComponent;
+                        break;
+                    case ItemType.skybox:
+                        item.content.dataType = DataType.SkyboxComponent;
+                        break;
+                    case ItemType.light:
+                        item.content.dataType = DataType.LightComponent;
+                        break;
+                    case 'camera':
+                        item.content.dataType = DataType.CameraComponent;
+                        break;
+                    case ItemType.tree:
+                        item.content.dataType = DataType.TreeComponent;
+                        break;
+                    case ItemType.interact:
+                        item.content.dataType = DataType.InteractComponent;
+                        break;
+                    case ItemType.camera:
+                        item.content.dataType = DataType.CameraController;
+                        break;
+                    case ItemType.text:
+                        item.content.dataType = DataType.TextComponent;
+                        break;
                 }
             }
         }
         catch (e_3_1) { e_3 = { error: e_3_1 }; }
         finally {
             try {
-                if (_o && !_o.done && (_j = _m.return)) _j.call(_m);
+                if (_s && !_s.done && (_o = _r.return)) _o.call(_r);
             }
             finally { if (e_3) throw e_3.error; }
         }
     };
     try {
         // 更正Composition.endBehavior
-        for (var _f = __values(json.compositions), _g = _f.next(); !_g.done; _g = _f.next()) {
-            var composition = _g.value;
+        for (var _k = __values(json.compositions), _l = _k.next(); !_l.done; _l = _k.next()) {
+            var composition = _l.value;
             _loop_1(composition);
         }
     }
     catch (e_1_1) { e_1 = { error: e_1_1 }; }
     finally {
         try {
-            if (_g && !_g.done && (_a = _f.return)) _a.call(_f);
+            if (_l && !_l.done && (_a = _k.return)) _a.call(_k);
         }
         finally { if (e_1) throw e_1.error; }
     }
@@ -1932,11 +1912,9 @@ function getStandardImage(image, index, imageTags) {
     else if (image.url) {
         return {
             url: image.url,
-            type: image.type,
             webp: image.webp,
             renderLevel: renderLevel,
             oriY: oriY,
-            loop: image.loop,
         };
     }
     else if (image && image.sourceType) {
@@ -1949,7 +1927,7 @@ function getStandardComposition(composition, opt) {
     if (opt === void 0) { opt = {}; }
     var ret = {
         id: composition.id + '',
-        camera: Object.assign({ clipMode: CAMERA_CLIP_MODE_NORMAL }, composition.camera),
+        camera: __assign({ clipMode: CAMERA_CLIP_MODE_NORMAL }, composition.camera),
         duration: composition.duration,
         endBehavior: composition.endBehavior,
         items: composition.items.map(function (item) { return getStandardItem(item, opt); }),