@galacean/effects-core 0.0.1-alpha.0 → 0.0.1-alpha.2

package/LICENSE

@@ -0,0 +1,22 @@
+MIT LICENSE
+
+Copyright (c) 2019-present Ant Group Co., Ltd. https://www.antgroup.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -32,7 +32,7 @@ mesh 会从 `renderFrame` 中移除。
       - 插件系统 `pluginSystem.initializeComposition()`
       - `composition.resetRenderFrame()`：`renderFrame` 的创建和初始化
       - `composition.reset()`：动画数据解析、Mesh 等渲染实例的状态初始化
-      - `composition.start()`：合成状态重置
+      - `composition.play()`：合成播放
   3. `update` 方法：用于调用 `renderFrame` 的方法增加/修改/删除 mesh，驱动 `VFXItem` 更新并刷新顶点数据、uniform 变量值等，以下函数会被调用，需要实现：
      - `updateVideo`：更新视频帧，用于视频播放使用
      - `getRendererOptions`：返回使用数据创建的空白 `Texture`
@@ -159,4 +159,4 @@ mesh 会根据 `priority` 属性被添加到 `renderPass` 合适位置上。
 
 ## API 文档
 
-TODO
+[Galacean Effects Core API 文档](https://galacean.antgroup.com/effects/#/api/modules_galacean_effects_core)

package/dist/asset-manager.d.ts

@@ -72,10 +72,6 @@ export interface SceneLoadOptions {
      * 播放速度，当速度为负数时，合成倒播
      */
     speed?: number;
-    /**
-     * 播放完成后不销毁 texture 对象，`loadScene` 的结果能再次被播放
-     */
-    keepResource?: boolean;
 }
 /**
  * 资源管理器

package/dist/camera.d.ts

@@ -1,3 +1,4 @@
+import type { vec3 } from '@galacean/effects-specification';
 import * as spec from '@galacean/effects-specification';
 import type { mat4 } from './math';
 /**
@@ -133,6 +134,11 @@ export declare class Camera {
      * @param model - 模型变换矩阵
      */
     getModelViewProjection(out: mat4 | number[], model: mat4): mat4;
+    /**
+     * 获取归一化坐标和 3D 世界坐标的换算比例
+     * @param z - 当前的位置 z
+     */
+    getInverseVPRatio(z: number): vec3;
     /**
      * 设置相机的旋转四元数
      * @param value - 旋转四元数

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

@@ -37,6 +37,7 @@ export declare class CompVFXItem extends VFXItem<void> {
     onItemUpdate(dt: number, lifetime: number): void;
     onItemRemoved(composition: Composition): void;
     reset(): void;
+    handleVisibleChanged(visible: boolean): void;
     getUpdateTime(t: number): number;
     removeItem(item: VFXItem<VFXItemContent>): boolean;
     /**
@@ -47,6 +48,7 @@ export declare class CompVFXItem extends VFXItem<void> {
     setItemParent(item: VFXItem<VFXItemContent>, parentItem?: VFXItem<VFXItemContent>): void;
     /**
      * 获取指定元素当前时刻真正起作用的父元素, 需要在元素生命周期内获取
+     * @internal
      * @param item - 指定元素
      * @return 当父元素生命周期结束时，返回空
      */

package/dist/composition.d.ts

@@ -33,10 +33,8 @@ interface CompositionHitTestOptions {
     skip?: (item: VFXItem<VFXItemContent>) => boolean;
 }
 export interface CompositionProps {
-    keepResource?: boolean;
     reusable?: boolean;
     baseRenderOrder?: number;
-    multipleCompositions?: boolean;
     renderer: Renderer;
     handlePlayerPause?: (item: VFXItem<any>) => void;
     handleMessageItem?: (item: MessageItem) => void;
@@ -44,6 +42,7 @@ export interface CompositionProps {
     event?: EventSystem;
     width: number;
     height: number;
+    speed?: number;
 }
 /**
  * 合成抽象类：核心对象，通常一个场景只包含一个合成，可能会有多个合成。
@@ -73,9 +72,9 @@ export declare class Composition implements Disposable, LostHandler {
     /**
      * 所有合成 Item 的根变换
      */
-    rootTransform: Transform;
+    transform: Transform;
     /**
-     * 播放完成后是否需要再使用，是的话生命周期结束后不会 dispose
+     * 播放完成后是否需要再使用，是的话生命周期结束后不会自动 dispose
      */
     reusable: boolean;
     /**
@@ -182,6 +181,10 @@ export declare class Composition implements Disposable, LostHandler {
      * 获取合成当前时间
      */
     get time(): number;
+    /**
+     * 获取合成的时长
+     */
+    getDuration(): number;
     /**
      * 获取销毁状态
      */
@@ -200,6 +203,16 @@ export declare class Composition implements Disposable, LostHandler {
      * @returns
      */
     getIndex(): number;
+    /**
+     * 设置合成的动画速度
+     * @param speed - 速度
+     */
+    setSpeed(speed: number): void;
+    /**
+     * 获取合成的动画速度
+     * @returns
+     */
+    getSpeed(): number;
     play(): void;
     /**
      * 暂停合成的播放
@@ -210,23 +223,17 @@ export declare class Composition implements Disposable, LostHandler {
      */
     resume(): void;
     gotoAndPlay(time: number): void;
-    gotoAndPause(time: number): void;
-    start(): void;
+    gotoAndStop(time: number): void;
     /**
      *
      */
     createRenderFrame(): void;
     /**
      * 跳到指定时间点（不做任何播放行为）
-     *
-     * @param time - 时间点（秒），可正可负
+     * @param time - 指定的时间
      */
     setTime(time: number): void;
-    /**
-     * 快进/快退指定时间间隔
-     * @param timeInSeconds - 需要快进/快退的时间长度（秒），可正可负
-     */
-    forwardTime(timeInSeconds: number): void;
+    private forwardTime;
     /**
      * 重置状态函数
      */
@@ -245,8 +252,9 @@ export declare class Composition implements Disposable, LostHandler {
     /**
      * 合成更新，针对所有 item 的更新
      * @param deltaTime - 更新的时间步长
+     * @param skipRender - 是否需要渲染
      */
-    update(deltaTime: number): void;
+    update(deltaTime: number, skipRender?: boolean): void;
     /**
      * 更新视频数据到纹理
      * @override
@@ -349,6 +357,22 @@ export declare class Composition implements Disposable, LostHandler {
      * @param dy - y偏移量
      */
     setEditorTransform(scale: number, dx: number, dy: number): void;
+    /**
+     * 合成整体在水平方向移动 x 像素，垂直方向移动 y 像素
+     */
+    translateByPixel(x: number, y: number): void;
+    /**
+     * 设置合成在 3D 坐标轴上相对移动
+     */
+    translate(x: number, y: number, z: number): void;
+    /**
+     * 设置合成在 3D 坐标轴上相对旋转（角度）
+     */
+    rotate(x: number, y: number, z: number): void;
+    /**
+     * 设置合成在 3D 坐标轴上相对缩放
+     */
+    scale(x: number, y: number, z: number): void;
     /**
      * 卸载贴图纹理方法，减少内存
      */
@@ -359,10 +383,4 @@ export declare class Composition implements Disposable, LostHandler {
      */
     reloadTexture(): Promise<void>;
 }
-/**
- * 根据 id 查找对应的合成，可能找不到
- * @param compositions - 合成列表
- * @param id - 目标合成 id
- */
-export declare function getComposition(compositions: spec.Composition[], id?: string): spec.Composition | undefined;
 export {};

package/dist/config.d.ts

@@ -1,4 +1,5 @@
 export declare const RUNTIME_ENV = "runtime_env";
+export declare const LOG_TYPE = "galacean-effects";
 export declare const RENDER_PREFER_LOOKUP_TEXTURE = "lookup_texture";
 export declare const TEMPLATE_USE_OFFSCREEN_CANVAS = "offscreen_canvas";
 export declare const POST_PROCESS_SETTINGS = "post_process_settings";