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

package/dist/fallback/migration.d.ts

@@ -1,9 +1,13 @@
-import type { JSONScene } from '../src/scene';
+import type { JSONScene, JSONSceneLegacy } from '../src';
 /**
  * 2.1 以下版本数据适配（mars-player@2.4.0 及以上版本支持 2.1 以下数据的适配）
  */
-export declare function version21Migration(json: JSONScene): JSONScene;
+export declare function version21Migration(json: JSONSceneLegacy): JSONSceneLegacy;
 /**
  * 2.2 以下版本数据适配（mars-player@2.5.0 及以上版本支持 2.2 以下数据的适配）
  */
-export declare function version22Migration(json: JSONScene): JSONScene;
+export declare function version22Migration(json: JSONSceneLegacy): JSONSceneLegacy;
+/**
+ * 3.0 以下版本数据适配（runtime 2.0及以上版本支持）
+ */
+export declare function version30Migration(json: JSONSceneLegacy): JSONScene;

package/dist/fallback/utils.d.ts

@@ -1,4 +1,5 @@
-import type { FixedNumberExpression, RGBAColorValue, ColorExpression, NumberExpression, GradientColor, FixedVec3Expression, vec4, vec3 } from '../src';
+import type { FixedNumberExpression, RGBAColorValue, ColorExpression, NumberExpression, GradientColor, FixedVec3Expression, vec4, vec3, vec2 } from '../src';
+import { ParticleOrigin } from '../src';
 export declare function arrAdd<T>(arr: T[], item: T): boolean | undefined;
 /**
  * @deprecated 请直接使用 Array.prototype.forEach 或 for...of
@@ -27,3 +28,9 @@ export declare function objectValueToNumber(o: Record<string, any>): object;
 export declare function deleteEmptyValue(o: Record<string, any>): object;
 export declare function quatFromXYZRotation(out: vec4 | number[], x: number, y: number, z: number): vec4;
 export declare function rotationZYXFromQuat(out: vec3 | number[], quat: vec4): vec3;
+export declare function generateGUID(): string;
+/**
+ * 提取并转换 JSON 数据中的 anchor 值
+ */
+export declare function convertAnchor(anchor?: vec2, particleOrigin?: ParticleOrigin): vec2;
+export declare const particleOriginTranslateMap: Record<number, vec2>;

package/dist/fallback.js

@@ -2,13 +2,78 @@
  * Name: @galacean/effects-specification
  * Description: Galacean Effects JSON Specification
  * Author: Ant Group CO., Ltd.
- * Version: v2.0.0-alpha.0
+ * Version: v2.0.0-alpha.2
  */
 
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+const randomUUID = typeof crypto !== 'undefined' && crypto.randomUUID && crypto.randomUUID.bind(crypto);
+var native = {
+  randomUUID
+};
+
+// Unique ID creation requires a high quality random # generator. In the browser we therefore
+// require the crypto API and do not support built-in fallback to lower quality random number
+// generators (like Math.random()).
+let getRandomValues;
+const rnds8 = new Uint8Array(16);
+function rng() {
+  // lazy load so that environments that need to polyfill have a chance to do so
+  if (!getRandomValues) {
+    // getRandomValues needs to be invoked in a context where "this" is a Crypto implementation.
+    getRandomValues = typeof crypto !== 'undefined' && crypto.getRandomValues && crypto.getRandomValues.bind(crypto);
+
+    if (!getRandomValues) {
+      throw new Error('crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported');
+    }
+  }
+
+  return getRandomValues(rnds8);
+}
+
+/**
+ * Convert array of 16 byte values to UUID string format of the form:
+ * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+ */
+
+const byteToHex = [];
+
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 0x100).toString(16).slice(1));
+}
+
+function unsafeStringify(arr, offset = 0) {
+  // Note: Be careful editing this code!  It's been tuned for performance
+  // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
+  return byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]];
+}
+
+function v4(options, buf, offset) {
+  if (native.randomUUID && !buf && !options) {
+    return native.randomUUID();
+  }
+
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)(); // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+
+  rnds[6] = rnds[6] & 0x0f | 0x40;
+  rnds[8] = rnds[8] & 0x3f | 0x80; // Copy bytes to buffer, if provided
+
+  if (buf) {
+    offset = offset || 0;
+
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+
+    return buf;
+  }
+
+  return unsafeStringify(rnds);
+}
+
 /*********************************************/
 /*               元素属性参数类型               */
 /*********************************************/
@@ -271,6 +336,10 @@ var ItemType;
      * 天空盒元素
      */
     ItemType["skybox"] = "skybox";
+    /**
+     * 特效元素
+     */
+    ItemType["effect"] = "effect";
 })(ItemType || (ItemType = {}));
 /**
  * 渲染模式
@@ -383,6 +452,10 @@ var CompositionEndBehavior;
      * 销毁并保留最后一帧
      */
     CompositionEndBehavior[CompositionEndBehavior["pause_destroy"] = END_BEHAVIOR_PAUSE_AND_DESTROY] = "pause_destroy";
+    /**
+     * 冻结
+     */
+    CompositionEndBehavior[CompositionEndBehavior["freeze"] = END_BEHAVIOR_FREEZE] = "freeze";
 })(CompositionEndBehavior || (CompositionEndBehavior = {}));
 
 /*********************************************/
@@ -545,6 +618,12 @@ var ModelBoundingType;
     ModelBoundingType[ModelBoundingType["sphere"] = 3] = "sphere";
 })(ModelBoundingType || (ModelBoundingType = {}));
 
+var CameraType;
+(function (CameraType) {
+    CameraType["orthographic"] = "orthographic";
+    CameraType["perspective"] = "perspective";
+})(CameraType || (CameraType = {}));
+
 // 材质类型
 var MaterialType;
 (function (MaterialType) {
@@ -767,11 +846,22 @@ function __read(o, n) {
     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 _a;
 function arrAdd(arr, item) {
     if (!arr.includes(item)) {
         arr.push(item);
@@ -1007,6 +1097,34 @@ function rotationZYXFromQuat(out, quat) {
     }
     return out;
 }
+function generateGUID() {
+    return v4().replace(/-/g, '');
+}
+/**
+ * 提取并转换 JSON 数据中的 anchor 值
+ */
+function convertAnchor(anchor, particleOrigin) {
+    if (anchor) {
+        return [anchor[0] - 0.5, 0.5 - anchor[1]];
+    }
+    else if (particleOrigin) {
+        return particleOriginTranslateMap[particleOrigin];
+    }
+    else {
+        return [0, 0];
+    }
+}
+var particleOriginTranslateMap = (_a = {},
+    _a[ParticleOrigin.PARTICLE_ORIGIN_CENTER] = [0, 0],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_CENTER_BOTTOM] = [0, -0.5],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_CENTER_TOP] = [0, 0.5],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_LEFT_TOP] = [-0.5, 0.5],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_LEFT_CENTER] = [-0.5, 0],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_LEFT_BOTTOM] = [-0.5, -0.5],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_RIGHT_CENTER] = [0.5, 0],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_RIGHT_BOTTOM] = [0.5, -0.5],
+    _a[ParticleOrigin.PARTICLE_ORIGIN_RIGHT_TOP] = [0.5, 0.5],
+    _a);
 
 function getStandardParticleContent(particle) {
     var _a;
@@ -1418,6 +1536,309 @@ function version22Migration(json) {
     });
     return json;
 }
+/**
+ * 3.0 以下版本数据适配（runtime 2.0及以上版本支持）
+ */
+function version30Migration(json) {
+    var e_1, _a;
+    var _b, _c, _d, _e;
+    var result = Object.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,
+        });
+    });
+    if (result.textures.length < result.images.length) {
+        for (var i = result.textures.length; i < result.images.length; i++) {
+            result.textures.push({
+                //@ts-expect-error
+                id: generateGUID(),
+                dataType: DataType.Texture,
+                source: i,
+                flipY: true,
+            });
+        }
+    }
+    var _loop_1 = function (composition) {
+        var e_2, _h, e_3, _j;
+        // 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;
+                itemGuidMap[item.id] = generateGUID();
+                // TODO: 编辑器测试用，上线后删除
+                //@ts-expect-error
+                item.oldId = item.id;
+                item.id = itemGuidMap[item.id];
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_l && !_l.done && (_h = _k.return)) _h.call(_k);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+        composition.items.forEach(function (item, index) {
+            if (item.parentId) {
+                if (item.parentId.includes('^')) {
+                    var parentId = (item.parentId).split('^')[0];
+                    var nodeId = (item.parentId).split('^')[1];
+                    item.parentId = itemGuidMap[parentId] + '^' + nodeId;
+                }
+                else {
+                    item.parentId = itemGuidMap[item.parentId];
+                }
+            }
+            // @ts-expect-error fix item type
+            result.items.push(item);
+            // @ts-expect-error fix item type
+            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;
+                // 原 texture 索引转为统一 guid 索引
+                if (item.content) {
+                    if (item.content.renderer) {
+                        if (item.content.renderer.texture !== undefined) {
+                            var oldTextureId = item.content.renderer.texture;
+                            //@ts-expect-error
+                            item.content.renderer.texture = { id: result.textures[oldTextureId].id };
+                        }
+                    }
+                    if (item.content.trails) {
+                        if (item.content.trails.texture !== undefined) {
+                            var oldTextureId = item.content.trails.texture;
+                            //@ts-expect-error
+                            item.content.trails.texture = { id: result.textures[oldTextureId].id };
+                        }
+                    }
+                }
+                // item 的 transform 属性由数组转为 {x:n, y:n, z:n}
+                if (item.transform) {
+                    //@ts-expect-error
+                    var position = __spreadArray([], __read((_c = item.transform.position) !== null && _c !== void 0 ? _c : [0, 0, 0]), false);
+                    //@ts-expect-error
+                    var rotation = __spreadArray([], __read((_d = item.transform.rotation) !== null && _d !== void 0 ? _d : [0, 0, 0]), false);
+                    //@ts-expect-error
+                    var scale = __spreadArray([], __read((_e = item.transform.scale) !== null && _e !== void 0 ? _e : [1, 1, 1]), false);
+                    Object.assign(item, {
+                        transform: {
+                            position: { x: position[0], y: position[1], z: position[2] },
+                            rotation: { x: rotation[0], y: rotation[1], z: rotation[2] },
+                            scale: { x: scale[0], y: scale[1], z: scale[0] },
+                        },
+                    });
+                    // sprite 的 scale 转为 size
+                    if (item.type === ItemType.sprite) {
+                        item.transform.size = { x: scale[0], y: scale[1] };
+                        item.transform.scale = { x: 1, y: 1, z: 1 };
+                    }
+                    // sprite 的 anchor 修正
+                    if (item.type === ItemType.sprite) {
+                        var content = item.content;
+                        if (!content.renderer) {
+                            content.renderer = {};
+                        }
+                        var renderer = content.renderer;
+                        var realAnchor = convertAnchor(renderer.anchor, renderer.particleOrigin);
+                        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;
+                        }
+                        //@ts-expect-error
+                        item.transform.anchor = { x: realAnchor[0] * startSize.x, y: realAnchor[1] * startSize.y };
+                    }
+                }
+                if (item.type === ItemType.particle) {
+                    var content = item.content;
+                    if (!content.renderer) {
+                        content.renderer = {};
+                    }
+                    var renderer = content.renderer;
+                    content.renderer.anchor = convertAnchor(renderer.anchor, renderer.particleOrigin);
+                }
+                // 动画数据转化 TODO: 动画数据移到 TimelineComponentData
+                item.content.tracks = [];
+                var tracks = item.content.tracks;
+                if (item.type !== ItemType.particle) {
+                    tracks.push({
+                        clips: [
+                            {
+                                dataType: 'TransformAnimationPlayableAsset',
+                                animationClip: {
+                                    sizeOverLifetime: item.content.sizeOverLifetime,
+                                    rotationOverLifetime: item.content.rotationOverLifetime,
+                                    positionOverLifetime: item.content.positionOverLifetime,
+                                },
+                            },
+                        ],
+                    });
+                }
+                if (item.type === ItemType.sprite) {
+                    tracks.push({
+                        clips: [
+                            {
+                                dataType: 'SpriteColorAnimationPlayableAsset',
+                                animationClip: {
+                                    colorOverLifetime: item.content.colorOverLifetime,
+                                    startColor: item.content.options.startColor,
+                                },
+                            },
+                        ],
+                    });
+                }
+                // gizmo 的 target id 转换为新的 item guid
+                if (item.content.options.target) {
+                    item.content.options.target = itemGuidMap[item.content.options.target];
+                }
+                // item 的 content 转为 component data 加入 JSONScene.components
+                var uuid = generateGUID();
+                if (item.type === ItemType.sprite) {
+                    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 });
+                }
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (_o && !_o.done && (_j = _m.return)) _j.call(_m);
+            }
+            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;
+            _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);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    result.version = '3.0';
+    return result;
+}
 
 var v0 = /^(\d+)\.(\d+)\.(\d+)(-(\w+)\.\d+)?$/;
 var standardVersion = /^(\d+)\.(\d+)$/;
@@ -1427,16 +1848,16 @@ function getStandardJSON(json) {
     if (!json || typeof json !== 'object') {
         throw Error('expect a json object');
     }
-    // 修正老版本数据中，meshItem以及lightItem结束行为错误问题
+    // 修正老版本数据中，meshItem 以及 lightItem 结束行为错误问题
     version22Migration(json);
     if (v0.test(json.version)) {
         reverseParticle = ((_a = (/^(\d+)/).exec(json.version)) === null || _a === void 0 ? void 0 : _a[0]) === '0';
-        return version21Migration(getStandardJSONFromV0(json));
+        return version30Migration(version21Migration(getStandardJSONFromV0(json)));
     }
     var mainVersion = (_b = standardVersion.exec(json.version)) === null || _b === void 0 ? void 0 : _b[1];
     if (mainVersion) {
-        if (Number(mainVersion) < 2) {
-            return version21Migration(json);
+        if (Number(mainVersion) < 3) {
+            return version30Migration(version21Migration(json));
         }
         return json;
     }
@@ -1708,6 +2129,7 @@ function getStandardItem(item, opt) {
 
 exports.arrAdd = arrAdd;
 exports.colorToArr = colorToArr;
+exports.convertAnchor = convertAnchor;
 exports.deleteEmptyValue = deleteEmptyValue;
 exports.ensureColorExpression = ensureColorExpression;
 exports.ensureFixedNumber = ensureFixedNumber;
@@ -1718,6 +2140,7 @@ exports.ensureNumberExpression = ensureNumberExpression;
 exports.ensureRGBAValue = ensureRGBAValue;
 exports.ensureValueGetter = ensureValueGetter;
 exports.forEach = forEach;
+exports.generateGUID = generateGUID;
 exports.getGradientColor = getGradientColor;
 exports.getStandardComposition = getStandardComposition;
 exports.getStandardImage = getStandardImage;
@@ -1726,6 +2149,7 @@ exports.getStandardJSON = getStandardJSON;
 exports.normalizeColor = normalizeColor;
 exports.objectValueToNumber = objectValueToNumber;
 exports.parsePercent = parsePercent;
+exports.particleOriginTranslateMap = particleOriginTranslateMap;
 exports.quatFromXYZRotation = quatFromXYZRotation;
 exports.rotationZYXFromQuat = rotationZYXFromQuat;
 //# sourceMappingURL=fallback.js.map