@galacean/effects-core 2.0.2 → 2.0.4

package/README.md

@@ -153,4 +153,4 @@ Uniforms involved and their types:
 30. uWaveParams: vec4
 ```
 
-## [API Documentation](https://galacean.antgroup.com/effects/#/api/modules_galacean_effects_core)
+## [API Documentation](https://galacean.antgroup.com/effects/api/effects-core)

package/dist/asset-loader.d.ts

@@ -4,7 +4,6 @@ import type { Engine } from './engine';
 import type { VFXItemProps } from './vfx-item';
 /**
  * @since 2.0.0
- * @internal
  */
 export declare class AssetLoader {
     private engine;

package/dist/asset-manager.d.ts

@@ -38,10 +38,6 @@ export declare class AssetManager implements Disposable {
      */
     constructor(options?: SceneLoadOptions, downloader?: Downloader);
     updateOptions(options?: SceneLoadOptions): void;
-    /**
-     * 根据用户传入的参数修改场景数据
-     */
-    private updateSceneData;
     /**
      * 场景创建，通过 json 创建出场景对象，并进行提前编译等工作
      * @param url - json 的 URL 链接或者 json 对象

package/dist/comp-vfx-item.d.ts

@@ -15,7 +15,6 @@ export interface SceneBindingData {
 }
 /**
  * @since 2.0.0
- * @internal
  */
 export declare class CompositionComponent extends Behaviour {
     time: number;
@@ -33,6 +32,8 @@ export declare class CompositionComponent extends Behaviour {
     getReusable(): boolean;
     update(dt: number): void;
     createContent(): void;
+    showItems(): void;
+    hideItems(): void;
     onDestroy(): void;
     hitTest(ray: Ray, x: number, y: number, regions: Region[], force?: boolean, options?: CompositionHitTestOptions): Region[];
     fromData(data: unknown): void;

package/dist/components/component.d.ts

@@ -2,7 +2,6 @@ import { EffectsObject } from '../effects-object';
 import type { VFXItem } from '../vfx-item';
 /**
  * @since 2.0.0
- * @internal
  */
 export declare abstract class Component extends EffectsObject {
     name: string;
@@ -21,7 +20,6 @@ export declare abstract class Component extends EffectsObject {
 }
 /**
  * @since 2.0.0
- * @internal
  */
 export declare abstract class Behaviour extends Component {
     isAwakeCalled: boolean;

package/dist/components/effect-component.d.ts

@@ -8,7 +8,6 @@ import { DestroyOptions } from '../utils';
 import { RendererComponent } from './renderer-component';
 /**
  * @since 2.0.0
- * @internal
  */
 export declare class EffectComponent extends RendererComponent {
     /**

package/dist/composition.d.ts

@@ -278,7 +278,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 前进合成到指定时间
      * @param time - 相对0时刻的时间
-     * @param skipRender - 是否跳过渲染
      */
     private forwardTime;
     /**
@@ -290,7 +289,6 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
     /**
      * 合成更新，针对所有 item 的更新
      * @param deltaTime - 更新的时间步长
-     * @param skipRender - 是否需要渲染
      */
     update(deltaTime: number): void;
     private toLocalTime;
@@ -362,31 +360,11 @@ export declare class Composition extends EventEmitter<CompositionEvent<Compositi
      * @param type - 交互类型
      */
     removeInteractiveItem(item: VFXItem, type: spec.InteractType): void;
-    /**
-     * 销毁插件 Item 中保存的纹理数组
-     * @internal
-     * @param textures - 需要销毁的数组
-     */
-    destroyTextures(textures: (Texture | null | undefined)[]): void;
-    /**
-     * 销毁 Item
-     * @internal
-     * @param item - 需要销毁的 item
-     */
-    destroyItem(item: VFXItem): void;
     lost(e: Event): void;
     /**
      * 合成对象销毁
      */
     dispose(): void;
-    /**
-     * 编辑器使用的 transform 修改方法
-     * @internal
-     * @param scale - 缩放比例
-     * @param dx - x偏移量
-     * @param dy - y偏移量
-     */
-    setEditorTransform(scale: number, dx: number, dy: number): void;
     /**
      * 合成整体在水平方向移动 x 像素，垂直方向移动 y 像素
      */

package/dist/effects-object.d.ts

@@ -2,7 +2,6 @@ import type * as spec from '@galacean/effects-specification';
 import type { Engine } from './engine';
 /**
  * @since 2.0.0
- * @internal
  */
 export declare abstract class EffectsObject {
     engine: Engine;

package/dist/effects-package.d.ts

@@ -5,7 +5,6 @@ interface FileSummary {
 }
 /**
  * @since 2.0.0
- * @internal
  */
 export declare class EffectsPackage {
     fileSummary: FileSummary;

package/dist/index.js

@@ -3,7 +3,7 @@
  * Description: Galacean Effects runtime core for the web
  * Author: Ant Group CO., Ltd.
  * Contributors: 燃然,飂兮,十弦,云垣,茂安,意绮
- * Version: v2.0.2
+ * Version: v2.0.4
  */
 
 'use strict';
@@ -4569,7 +4569,6 @@ function getDirectStore(target) {
 
 /**
  * @since 2.0.0
- * @internal
  */ var EffectsObject = /*#__PURE__*/ function() {
     function EffectsObject(engine) {
         this.engine = engine;
@@ -4605,7 +4604,6 @@ function getDirectStore(target) {
 
 /**
  * @since 2.0.0
- * @internal
  */ var Component = /*#__PURE__*/ function(EffectsObject) {
     _inherits(Component, EffectsObject);
     function Component() {
@@ -4640,7 +4638,6 @@ function getDirectStore(target) {
 }(EffectsObject);
 /**
  * @since 2.0.0
- * @internal
  */ var Behaviour = /*#__PURE__*/ function(Component) {
     _inherits(Behaviour, Component);
     function Behaviour() {
@@ -8089,7 +8086,7 @@ function _loadVideo() {
                         }, true);
                     }
                     video.addEventListener("error", function(e) {
-                        reject(e);
+                        reject("Load video fail.");
                     });
                 })
             ];
@@ -13563,7 +13560,6 @@ function _assert_this_initialized(self) {
 /**
  * 动画图，负责更新所有的动画节点
  * @since 2.0.0
- * @internal
  */ var PlayableGraph = /*#__PURE__*/ function() {
     function PlayableGraph() {
         this.playableOutputs = [];
@@ -13623,7 +13619,6 @@ function _assert_this_initialized(self) {
 /**
  * 动画图可播放节点对象
  * @since 2.0.0
- * @internal
  */ var Playable = /*#__PURE__*/ function() {
     function Playable(graph, inputCount) {
         if (inputCount === void 0) inputCount = 0;
@@ -13821,7 +13816,6 @@ function _assert_this_initialized(self) {
 /**
  * 动画图输出节点对象，将动画数据采样到绑定的元素属性上
  * @since 2.0.0
- * @internal
  */ var PlayableOutput = /*#__PURE__*/ function() {
     function PlayableOutput() {
         this.sourceOutputPort = 0;
@@ -13904,13 +13898,17 @@ var SpriteColorPlayable = /*#__PURE__*/ function(Playable) {
         if (!_instanceof1(boundObject, exports.VFXItem)) {
             return;
         }
+        if (!this.spriteComponent) {
+            this.spriteComponent = boundObject.getComponent(exports.SpriteComponent);
+        }
         if (!this.spriteMaterial) {
-            this.spriteMaterial = boundObject.getComponent(exports.SpriteComponent).material;
+            this.spriteMaterial = this.spriteComponent.material;
             var startColor = this.spriteMaterial.getVector4("_Color");
             if (startColor) {
                 this.startColor = startColor.toArray();
             }
         }
+        this.spriteComponent.setAnimationTime(this.time);
         var colorInc = vecFill(tempColor, 1);
         var colorChanged;
         var life = this.time / boundObject.duration;
@@ -13970,7 +13968,6 @@ exports.SpriteComponent = /*#__PURE__*/ function(RendererComponent) {
         _this = RendererComponent.call(this, engine) || this;
         _this.cachePrefix = "-";
         _this.frameAnimationLoop = false;
-        _this.frameAnimationTime = 0;
         _this.color = [
             1,
             1,
@@ -13978,6 +13975,8 @@ exports.SpriteComponent = /*#__PURE__*/ function(RendererComponent) {
             1
         ];
         _this.visible = true;
+        _this.isManualTimeSet = false;
+        _this.frameAnimationTime = 0;
         _this.getHitTestParams = function(force) {
             var ui = _this.interaction;
             if (force || ui) {
@@ -14060,6 +14059,12 @@ exports.SpriteComponent = /*#__PURE__*/ function(RendererComponent) {
         this.renderer.texture = texture;
         this.material.setTexture("uSampler0", texture);
     };
+    /**
+   * @internal
+   */ _proto.setAnimationTime = function setAnimationTime(time) {
+        this.frameAnimationTime = time;
+        this.isManualTimeSet = true;
+    };
     _proto.render = function render(renderer) {
         if (!this.getVisible()) {
             return;
@@ -14074,12 +14079,12 @@ exports.SpriteComponent = /*#__PURE__*/ function(RendererComponent) {
     };
     _proto.start = function start() {
         this.item.getHitTestParams = this.getHitTestParams;
-        if (this.item.endBehavior === EndBehavior.restart) {
-            this.frameAnimationLoop = true;
-        }
     };
     _proto.update = function update(dt) {
-        this.frameAnimationTime += dt / 1000;
+        if (!this.isManualTimeSet) {
+            this.frameAnimationTime += dt / 1000;
+            this.isManualTimeSet = false;
+        }
         var time = this.frameAnimationTime;
         var duration = this.item.duration;
         if (time > duration && this.frameAnimationLoop) {
@@ -16474,7 +16479,6 @@ function getTrailMeshShader(trails, particleMaxCount, name, gpuCapability, env)
 
 /**
  * @since 2.0.0
- * @internal
  */ var ParticleSystemRenderer = /*#__PURE__*/ function(RendererComponent) {
     _inherits(ParticleSystemRenderer, RendererComponent);
     function ParticleSystemRenderer(engine, particleMeshProps, trailMeshProps) {
@@ -16622,6 +16626,9 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
     _proto.isFrozen = function isFrozen() {
         return this.frozen;
     };
+    _proto.isEnded = function isEnded() {
+        return this.ended;
+    };
     _proto.initEmitterTransform = function initEmitterTransform() {
         var position = this.item.transform.position.clone();
         var rotation = this.item.transform.rotation.clone();
@@ -17540,7 +17547,6 @@ function randomArrItem(arr, keepArr) {
 
 /**
  * @since 2.0.0
- * @internal
  */ var ParticleBehaviourPlayable = /*#__PURE__*/ function(Playable) {
     _inherits(ParticleBehaviourPlayable, Playable);
     function ParticleBehaviourPlayable() {
@@ -17568,11 +17574,8 @@ function randomArrItem(arr, keepArr) {
         }
         var particleSystem = this.particleSystem;
         if (particleSystem) {
-            // TODO: [1.31] @十弦 验证 https://github.com/galacean/effects-runtime/commit/3e7d73d37b7d98c2a25e4544e80e928b17801ccd#diff-fae062f28caf3771cfedd3a20dc22f9749bd054c7541bf2fd50a9a5e413153d4
-            // particleSystem.setParentTransform(parentItem.transform);
-            particleSystem.setVisible(true);
             var deltaTime = context.deltaTime;
-            if (this.time < particleSystem.item.duration && particleSystem.isFrozen()) {
+            if (this.time >= 0 && this.time < particleSystem.item.duration && particleSystem.isEnded()) {
                 particleSystem.reset();
             }
             if (Math.abs(this.time - this.lastTime) < 0.001) {
@@ -18600,7 +18603,6 @@ var tempSize = new Vector3(1, 1, 1);
 var tempPos = new Vector3();
 /**
  * @since 2.0.0
- * @internal
  */ var TransformAnimationPlayable = /*#__PURE__*/ function(AnimationPlayable) {
     _inherits(TransformAnimationPlayable, AnimationPlayable);
     function TransformAnimationPlayable() {
@@ -18762,7 +18764,6 @@ exports.TransformPlayableAsset = __decorate([
 ], exports.TransformPlayableAsset);
 /**
  * @since 2.0.0
- * @internal
  */ var ActivationPlayable = /*#__PURE__*/ function(Playable) {
     _inherits(ActivationPlayable, Playable);
     function ActivationPlayable() {
@@ -18913,7 +18914,6 @@ var AnimationClipPlayable = /*#__PURE__*/ function(Playable) {
 
 /**
  * @since 2.0.0
- * @internal
  */ var TimelineClip = /*#__PURE__*/ function() {
     function TimelineClip() {
         this.start = 0;
@@ -19338,7 +19338,6 @@ function compareTracks(a, b) {
 
 /**
  * @since 2.0.0
- * @internal
  */ var CompositionComponent = /*#__PURE__*/ function(Behaviour) {
     _inherits(CompositionComponent, Behaviour);
     function CompositionComponent() {
@@ -19449,6 +19448,18 @@ function compareTracks(a, b) {
             }
         }
     };
+    _proto.showItems = function showItems() {
+        for(var _iterator = _create_for_of_iterator_helper_loose(this.items), _step; !(_step = _iterator()).done;){
+            var item = _step.value;
+            item.setVisible(true);
+        }
+    };
+    _proto.hideItems = function hideItems() {
+        for(var _iterator = _create_for_of_iterator_helper_loose(this.items), _step; !(_step = _iterator()).done;){
+            var item = _step.value;
+            item.setVisible(false);
+        }
+    };
     _proto.onDestroy = function onDestroy() {
         if (this.item.composition) {
             if (this.items) {
@@ -19559,6 +19570,34 @@ function compareTracks(a, b) {
     return CompositionComponent;
 }(Behaviour);
 
+var SubCompositionMixerPlayable = /*#__PURE__*/ function(Playable) {
+    _inherits(SubCompositionMixerPlayable, Playable);
+    function SubCompositionMixerPlayable() {
+        return Playable.apply(this, arguments);
+    }
+    var _proto = SubCompositionMixerPlayable.prototype;
+    _proto.processFrame = function processFrame(context) {
+        var boundObject = context.output.getUserData();
+        if (!_instanceof1(boundObject, CompositionComponent)) {
+            return;
+        }
+        var compositionComponent = boundObject;
+        var hasInput = false;
+        for(var i = 0; i < this.getInputCount(); i++){
+            if (this.getInputWeight(i) > 0) {
+                hasInput = true;
+                break;
+            }
+        }
+        if (hasInput) {
+            compositionComponent.showItems();
+        } else {
+            compositionComponent.hideItems();
+        }
+    };
+    return SubCompositionMixerPlayable;
+}(Playable);
+
 exports.SubCompositionTrack = /*#__PURE__*/ function(TrackAsset) {
     _inherits(SubCompositionTrack, TrackAsset);
     function SubCompositionTrack() {
@@ -19571,6 +19610,9 @@ exports.SubCompositionTrack = /*#__PURE__*/ function(TrackAsset) {
         }
         return parentBinding.getComponent(CompositionComponent);
     };
+    _proto.createTrackMixer = function createTrackMixer(graph) {
+        return new SubCompositionMixerPlayable(graph);
+    };
     return SubCompositionTrack;
 }(exports.TrackAsset);
 exports.SubCompositionTrack = __decorate([
@@ -21627,7 +21669,6 @@ var SerializationHelper = /*#__PURE__*/ function() {
 
 /**
  * @since 2.0.0
- * @internal
  */ var AssetLoader = /*#__PURE__*/ function() {
     function AssetLoader(engine) {
         this.engine = engine;
@@ -23608,22 +23649,6 @@ var seed = 1;
         this.timeout = timeout;
     };
     /**
-   * 根据用户传入的参数修改场景数据
-   */ _proto.updateSceneData = function updateSceneData(items) {
-        var variables = this.options.variables;
-        if (!variables || Object.keys(variables).length === 0) {
-            return;
-        }
-        items.forEach(function(item) {
-            if (item.type === ItemType.text) {
-                var textVariable = variables[item.name];
-                if (textVariable) {
-                    item.content.options.text = textVariable;
-                }
-            }
-        });
-    };
-    /**
    * 场景创建，通过 json 创建出场景对象，并进行提前编译等工作
    * @param url - json 的 URL 链接或者 json 对象
    * @param renderer - renderer 对象，用于获取管理、编译 shader 及 GPU 上下文的参数
@@ -23750,7 +23775,6 @@ var seed = 1;
                                 for(i1 = 0; i1 < scene.images.length; i1++){
                                     scene.textureOptions[i1].image = scene.images[i1];
                                 }
-                                _this.updateSceneData(scene.jsonScene.items);
                                 _state.label = 5;
                             case 5:
                                 return [
@@ -23807,7 +23831,6 @@ var seed = 1;
                                 ];
                             case 10:
                                 loadedTextures = _state.sent();
-                                _this.updateSceneData(jsonScene.items);
                                 scene = {
                                     timeInfos: timeInfos,
                                     url: url,
@@ -24099,7 +24122,7 @@ var seed = 1;
                                 ];
                             case 6:
                                 e = _state.sent();
-                                throw new Error("Failed to load. Check the template or if the URL is " + (isVideo ? "video" : "image") + " type, URL: " + url + ", Error: " + e.message + ".");
+                                throw new Error("Failed to load. Check the template or if the URL is " + (isVideo ? "video" : "image") + " type, URL: " + url + ", Error: " + (e.message || e) + ".");
                             case 7:
                                 return [
                                     3,
@@ -25025,6 +25048,7 @@ var listOrder = 0;
    * 跳到指定时间点（不做任何播放行为）
    * @param time - 相对 startTime 的时间
    */ _proto.setTime = function setTime(time) {
+        var speed = this.speed;
         var pause = this.paused;
         if (pause) {
             this.resume();
@@ -25033,7 +25057,9 @@ var listOrder = 0;
             this.rootComposition.start();
             this.rootComposition.isStartCalled = true;
         }
+        this.setSpeed(1);
         this.forwardTime(time + this.startTime);
+        this.setSpeed(speed);
         if (pause) {
             this.pause();
         }
@@ -25045,7 +25071,6 @@ var listOrder = 0;
     /**
    * 前进合成到指定时间
    * @param time - 相对0时刻的时间
-   * @param skipRender - 是否跳过渲染
    */ _proto.forwardTime = function forwardTime(time) {
         var deltaTime = time * 1000 - this.rootComposition.time * 1000;
         var reverse = deltaTime < 0;
@@ -25095,7 +25120,6 @@ var listOrder = 0;
     /**
    * 合成更新，针对所有 item 的更新
    * @param deltaTime - 更新的时间步长
-   * @param skipRender - 是否需要渲染
    */ _proto.update = function update(deltaTime) {
         if (!this.assigned || this.paused) {
             return;
@@ -27113,7 +27137,6 @@ var FBGeometryDataT = /*#__PURE__*/ function() {
 
 /**
  * @since 2.0.0
- * @internal
  */ var EffectsPackage = /*#__PURE__*/ function() {
     function EffectsPackage() {
         this.exportObjectDatas = [];
@@ -27522,11 +27545,12 @@ var FBGeometryDataT = /*#__PURE__*/ function() {
     return Engine;
 }();
 
+var DEFAULT_FPS = 60;
 /**
  * 定时器类
  */ var Ticker = /*#__PURE__*/ function() {
     function Ticker(fps) {
-        if (fps === void 0) fps = 60;
+        if (fps === void 0) fps = DEFAULT_FPS;
         this.paused = true;
         this.lastTime = 0;
         // deltaTime
@@ -27661,7 +27685,7 @@ registerPlugin("sprite", SpriteLoader, exports.VFXItem, true);
 registerPlugin("particle", ParticleLoader, exports.VFXItem, true);
 registerPlugin("cal", CalculateLoader, exports.VFXItem, true);
 registerPlugin("interact", InteractLoader, exports.VFXItem, true);
-var version = "2.0.2";
+var version = "2.0.4";
 logger.info("Core version: " + version + ".");
 
 exports.AbstractPlugin = AbstractPlugin;
@@ -27685,6 +27709,7 @@ exports.Composition = Composition;
 exports.CompositionComponent = CompositionComponent;
 exports.CompositionSourceManager = CompositionSourceManager;
 exports.DEFAULT_FONTS = DEFAULT_FONTS;
+exports.DEFAULT_FPS = DEFAULT_FPS;
 exports.Database = Database;
 exports.Downloader = Downloader;
 exports.EFFECTS_COPY_MESH_NAME = EFFECTS_COPY_MESH_NAME;