@galacean/effects-plugin-model 2.0.0-alpha.2 → 2.0.0-alpha.21

package/dist/plugin/model-item.d.ts

@@ -1,18 +1,10 @@
-import type { HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, Engine, Renderer } from '@galacean/effects';
-import { ItemBehaviour, RendererComponent, TimelineComponent } from '@galacean/effects';
-import { Vector3 } from '../runtime/math';
-import type { Euler } from '../runtime/math';
-import type { ModelItemBounding, ModelLightContent, ModelCameraContent, ModelMeshContent, ModelSkyboxContent } from '../index';
+import type { Engine, HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, Renderer, VFXItem } from '@galacean/effects';
+import { ItemBehaviour, RendererComponent, AnimationClip } from '@galacean/effects';
+import type { ModelCameraComponentData, ModelItemBounding, ModelLightComponentData, ModelMeshComponentData, ModelSkyboxComponentData, AnimationComponentData } from '../index';
 import type { PSceneManager } from '../runtime';
 import { PCamera, PLight, PMesh, PSkybox } from '../runtime';
-export declare enum ModelDataType {
-    MeshComponent = 10000,
-    SkyboxComponent = 10001,
-    LightComponent = 10002,
-    CameraComponent = 10003,
-    ModelPluginComponent = 10004,
-    TreeComponent = 10005
-}
+import type { Euler } from '../runtime/math';
+import { Vector3 } from '../runtime/math';
 /**
  * 插件 Mesh 组件类，支持 3D Mesh 渲染能力
  * @since 2.0.0
@@ -26,7 +18,7 @@ export declare class ModelMeshComponent extends RendererComponent {
     /**
      * 参数
      */
-    options?: ModelMeshContent;
+    data?: ModelMeshComponentData;
     /**
      * 包围盒
      */
@@ -35,12 +27,16 @@ export declare class ModelMeshComponent extends RendererComponent {
      * 场景管理器
      */
     sceneManager?: PSceneManager;
+    /**
+     * morph 动画权重
+     */
+    morphWeights: number[];
     /**
      * 构造函数，只保存传入参数，不在这里创建内部对象
      * @param engine - 引擎
-     * @param options - Mesh 参数
+     * @param data - Mesh 参数
      */
-    constructor(engine: Engine, options?: ModelMeshContent);
+    constructor(engine: Engine, data?: ModelMeshComponentData);
     /**
      * 组件开始，需要创建内部对象，更新父元素信息和添加到场景管理器中
      */
@@ -62,9 +58,9 @@ export declare class ModelMeshComponent extends RendererComponent {
     onDestroy(): void;
     /**
      * 反序列化，记录传入参数
-     * @param options - 组件参数
+     * @param data - 组件参数
      */
-    fromData(options: ModelMeshContent): void;
+    fromData(data: ModelMeshComponentData): void;
     /**
      * 创建内部对象
      */
@@ -103,7 +99,7 @@ export declare class ModelSkyboxComponent extends RendererComponent {
     /**
      * 天空盒参数
      */
-    options?: ModelSkyboxContent;
+    data?: ModelSkyboxComponentData;
     /**
      * 场景管理器
      */
@@ -111,9 +107,9 @@ export declare class ModelSkyboxComponent extends RendererComponent {
     /**
      * 构造函数，只保存传入参数，不在这里创建内部对象
      * @param engine - 引擎
-     * @param options - Mesh 参数
+     * @param data - Mesh 参数
      */
-    constructor(engine: Engine, options?: ModelSkyboxContent);
+    constructor(engine: Engine, data?: ModelSkyboxComponentData);
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
@@ -130,9 +126,9 @@ export declare class ModelSkyboxComponent extends RendererComponent {
     onDestroy(): void;
     /**
      * 反序列化，记录传入参数
-     * @param options - 组件参数
+     * @param data - 组件参数
      */
-    fromData(options: ModelSkyboxContent): void;
+    fromData(data: ModelSkyboxComponentData): void;
     /**
      * 创建内部对象
      */
@@ -160,13 +156,13 @@ export declare class ModelLightComponent extends ItemBehaviour {
     /**
      * 参数
      */
-    options?: ModelLightContent;
+    data?: ModelLightComponentData;
     /**
      * 构造函数，只保存传入参数，不在这里创建内部对象
      * @param engine - 引擎
-     * @param options - Mesh 参数
+     * @param data - Mesh 参数
      */
-    constructor(engine: Engine, options?: ModelLightContent);
+    constructor(engine: Engine, data?: ModelLightComponentData);
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
@@ -182,9 +178,9 @@ export declare class ModelLightComponent extends ItemBehaviour {
     onDestroy(): void;
     /**
      * 反序列化，记录传入参数
-     * @param options - 组件参数
+     * @param data - 组件参数
      */
-    fromData(options: ModelLightContent): void;
+    fromData(data: ModelLightComponentData): void;
     /**
      * 创建内部对象
      */
@@ -212,17 +208,13 @@ export declare class ModelCameraComponent extends ItemBehaviour {
     /**
      * 参数
      */
-    options?: ModelCameraContent;
-    /**
-     * 时间轴组件
-     */
-    timeline?: TimelineComponent;
+    data?: ModelCameraComponentData;
     /**
      * 构造函数，只保存传入参数，不在这里创建内部对象
      * @param engine - 引擎
-     * @param options - Mesh 参数
+     * @param data - Mesh 参数
      */
-    constructor(engine: Engine, options?: ModelCameraContent);
+    constructor(engine: Engine, data?: ModelCameraComponentData);
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
@@ -238,9 +230,9 @@ export declare class ModelCameraComponent extends ItemBehaviour {
     onDestroy(): void;
     /**
      * 反序列化，记录传入参数
-     * @param options - 组件参数
+     * @param data - 组件参数
      */
-    fromData(options: ModelCameraContent): void;
+    fromData(data: ModelCameraComponentData): void;
     /**
      * 创建内部对象
      */
@@ -256,3 +248,47 @@ export declare class ModelCameraComponent extends ItemBehaviour {
      */
     setTransform(position?: Vector3, rotation?: Euler): void;
 }
+/**
+ * 插件动画组件类，支持 3D 动画能力
+ * @since 2.0.0
+ * @internal
+ */
+export declare class AnimationComponent extends ItemBehaviour {
+    /**
+     * 参数
+     */
+    data?: AnimationComponentData;
+    elapsedTime: number;
+    animation: number;
+    clips: ModelAnimationClip[];
+    /**
+     * 构造函数，只保存传入参数，不在这里创建内部对象
+     * @param engine - 引擎
+     */
+    constructor(engine: Engine);
+    /**
+     * 组件开始，需要创建内部对象和添加到场景管理器中
+     */
+    start(): void;
+    /**
+     * 组件更新，更新内部对象状态
+     * @param dt - 更新间隔
+     */
+    update(dt: number): void;
+    /**
+     * 组件销毁
+     */
+    onDestroy(): void;
+    /**
+     * 反序列化，记录传入参数
+     * @param data - 组件参数
+     */
+    fromData(data: AnimationComponentData): void;
+}
+declare class ModelAnimationClip extends AnimationClip {
+    path2Node: Record<string, VFXItem>;
+    sampleAnimation(vfxItem: VFXItem, time: number): void;
+    setFromAnimationClip(clip: AnimationClip): void;
+    getTargetItem(rootItem: VFXItem, path: string): VFXItem;
+}
+export {};

package/dist/plugin/model-plugin.d.ts

@@ -1,5 +1,5 @@
-import type { Scene, SceneLoadOptions, Composition, RenderFrame, Engine, Component } from '@galacean/effects';
-import { AbstractPlugin, ItemBehaviour } from '@galacean/effects';
+import type { Scene, SceneLoadOptions, Composition, RenderFrame, Engine, Component, Renderer } from '@galacean/effects';
+import { AbstractPlugin, spec, ItemBehaviour } from '@galacean/effects';
 import { CompositionCache } from '../runtime/cache';
 import { PSceneManager } from '../runtime';
 /**
@@ -24,6 +24,7 @@ export declare class ModelPlugin extends AbstractPlugin {
      * @param options - 加载选项
      */
     static prepareResource(scene: Scene, options: SceneLoadOptions): Promise<void>;
+    static precompile(compositions: spec.Composition[], renderer: Renderer): Promise<void>;
     /**
      * 创建 3D 场景管理器和缓存器
      * @param composition - 合成
@@ -98,7 +99,7 @@ export declare class ModelPluginComponent extends ItemBehaviour {
      * 反序列化，创建场景管理器
      * @param date - 组件参数
      */
-    fromData(data: any): void;
+    fromData(data: ModelPluginOptions): void;
     /**
      * 组件初始化，初始化场景管理器并更新合成相机
      * @param sceneParams - 场景参数

package/dist/plugin/model-tree-item.d.ts

@@ -1,6 +1,6 @@
-import { Transform, ItemBehaviour } from '@galacean/effects';
-import type { TimelineComponent, VFXItemContent, Engine, VFXItem } from '@galacean/effects';
-import type { ModelTreeOptions, ModelTreeContent } from '../index';
+import type { Engine, VFXItem } from '@galacean/effects';
+import { ItemBehaviour, Transform } from '@galacean/effects';
+import type { ModelTreeContent, ModelTreeOptions } from '../index';
 import { PAnimationManager } from '../runtime';
 /**
  * 场景树节点描述
@@ -47,7 +47,7 @@ export declare class ModelTreeItem {
      * @param props - 场景树数据
      * @param owner - 场景树元素
      */
-    constructor(props: ModelTreeOptions, owner: VFXItem<VFXItemContent>);
+    constructor(props: ModelTreeOptions, owner: VFXItem);
     /**
      * 场景树更新，主要是动画更新
      * @param dt - 时间间隔
@@ -96,10 +96,6 @@ export declare class ModelTreeComponent extends ItemBehaviour {
      * 参数
      */
     options?: ModelTreeContent;
-    /**
-     * 时间轴组件
-     */
-    timeline?: TimelineComponent;
     /**
      * 构造函数，创建节点树元素
      * @param engine

package/dist/runtime/animation.d.ts

@@ -1,6 +1,6 @@
-import type { Geometry, Engine, VFXItemContent, VFXItem } from '@galacean/effects';
+import type { Geometry, Engine, VFXItem, SkinProps } from '@galacean/effects';
 import { Texture } from '@galacean/effects';
-import type { ModelSkinOptions, ModelAnimTrackOptions, ModelAnimationOptions, ModelTreeOptions } from '../index';
+import type { ModelAnimTrackOptions, ModelAnimationOptions, ModelTreeOptions } from '../index';
 import { Matrix4 } from './math';
 import { PObject } from './object';
 import type { PSceneManager } from './scene';
@@ -19,7 +19,7 @@ export declare class PSkin extends PObject {
     /**
      * 场景树父元素
      */
-    parentItem?: VFXItem<VFXItemContent>;
+    rootBoneItem?: VFXItem;
     /**
      * 骨骼索引
      */
@@ -27,7 +27,7 @@ export declare class PSkin extends PObject {
     /**
      * 关节索引
      */
-    jointList: number[];
+    jointItem: VFXItem[];
     /**
      * 逆绑定矩阵
      */
@@ -42,11 +42,11 @@ export declare class PSkin extends PObject {
     textureDataMode: TextureDataMode;
     /**
      * 创建蒙皮对象
-     * @param options - 蒙皮相关数据
+     * @param props - 蒙皮相关数据
      * @param engine - 引擎对象
-     * @param parentItem - 场景树父元素
+     * @param rootBoneItem - 场景树父元素
      */
-    create(options: ModelSkinOptions, engine: Engine, parentItem?: VFXItem<VFXItemContent>): void;
+    create(props: SkinProps, engine: Engine, rootBoneItem: VFXItem): void;
     /**
      * 更新蒙皮矩阵
      */
@@ -62,7 +62,7 @@ export declare class PSkin extends PObject {
      * 更新父元素
      * @param parentItem - 场景树父元素
      */
-    updateParentItem(parentItem: VFXItem<VFXItemContent>): void;
+    updateParentItem(parentItem: VFXItem): void;
     /**
      * 获取关节点数
      * @returns
@@ -78,6 +78,9 @@ export declare class PSkin extends PObject {
      */
     dispose(): void;
     private getTextureDataMode;
+    private getJointItems;
+    private genNodeName;
+    private genNodeNameDFS;
 }
 /**
  * Morph 动画类
@@ -95,7 +98,7 @@ export declare class PMorph extends PObject {
      * weights 数组的具体数据，来自动画控制器的每帧更新
      * 数组的长度必须和 morphWeightsLength 相同，否则会出错。
      */
-    morphWeightsArray?: Float32Array;
+    morphWeightsArray: number[];
     /**
      * 是否有 Position 相关的 Morph 动画，shader 中需要知道
      */
@@ -114,12 +117,12 @@ export declare class PMorph extends PObject {
      * @returns 是否创建成功
      */
     create(geometry: Geometry): boolean;
-    dispose(): void;
     /**
      * 初始化 Morph target 的权重数组
      * @param weights - glTF Mesh 的权重数组，长度必须严格一致
      */
     initWeights(weights: number[]): void;
+    updateWeights(weights: number[]): void;
     /**
      * 当前状态是否有 Morph 动画：
      * 需要判断 weights 数组长度，以及 Position、Normal 和 Tangent 是否有动画
@@ -133,7 +136,7 @@ export declare class PMorph extends PObject {
      * @returns 返回两个 Morph 动画状态是否相等
      */
     equals(morph: PMorph): boolean;
-    getMorphWeightsArray(): Float32Array;
+    getMorphWeightsArray(): number[];
     /**
      * 统计 Geometry 中 Attribute 名称个数：
      * 主要用于统计 Morph 动画中新增的 Attribute 名称的个数，会作为最终的 weights 数组长度使用
@@ -216,7 +219,7 @@ export declare class PAnimTrack {
      * @param treeItem - 节点树元素
      * @param sceneManager - 3D 场景管理器
      */
-    tick(time: number, treeItem: VFXItem<VFXItemContent>, sceneManager?: PSceneManager): void;
+    tick(time: number, treeItem: VFXItem, sceneManager?: PSceneManager): void;
     /**
      * 获取动画结束时间
      * @returns
@@ -290,7 +293,7 @@ export declare class PAnimation extends PObject {
      * @param treeItem - 场景树元素
      * @param sceneManager - 3D 场景管理器
      */
-    tick(time: number, treeItem: VFXItem<VFXItemContent>, sceneManager?: PSceneManager): void;
+    tick(time: number, treeItem: VFXItem, sceneManager?: PSceneManager): void;
     /**
      * 销毁
      */
@@ -312,7 +315,7 @@ export declare class PAnimationManager extends PObject {
      * @param treeOptions - 场景树参数
      * @param ownerItem - 场景树所属元素
      */
-    constructor(treeOptions: ModelTreeOptions, ownerItem: VFXItem<VFXItemContent>);
+    constructor(treeOptions: ModelTreeOptions, ownerItem: VFXItem);
     /**
      * 设置场景管理器
      * @param sceneManager - 场景管理器
@@ -337,5 +340,5 @@ export declare class PAnimationManager extends PObject {
      * 获取场景树元素
      * @returns
      */
-    getTreeItem(): VFXItem<VFXItemContent>;
+    getTreeItem(): VFXItem;
 }

package/dist/runtime/camera.d.ts

@@ -1,6 +1,6 @@
 import type { math } from '@galacean/effects';
 import { spec } from '@galacean/effects';
-import type { ModelCameraOptions } from '../index';
+import type { ModelCameraComponentData } from '../index';
 import { Vector2, Vector3, Matrix4 } from './math';
 import { PEntity } from './object';
 import type { ModelCameraComponent } from '../plugin/model-item';
@@ -33,7 +33,7 @@ export declare class PCamera extends PEntity {
     /**
      * Y 轴上视角
      */
-    fovy: number;
+    fov: number;
     /**
      * 纵横比
      */
@@ -57,7 +57,7 @@ export declare class PCamera extends PEntity {
      * @param height - 画布高度
      * @param owner - 所属的相机组件
      */
-    constructor(name: string, width: number, height: number, options: ModelCameraOptions, owner?: ModelCameraComponent);
+    constructor(name: string, width: number, height: number, data: ModelCameraComponentData, owner?: ModelCameraComponent);
     /**
      * 更新相机矩阵和投影矩阵，从所属的元素中获取变换数据
      */
@@ -112,11 +112,12 @@ export declare class PCameraManager {
     initial(width: number, height: number): void;
     /**
      * 插入相机数据，创建新的相机对象
-     * @param inCamera - 相机数据
-     * @param owner - 所属的相机组件
+     * @param name - 相机名称
+     * @param data - 相机相关数据
+     * @param owner - 相机所属组件
      * @returns 新的相机对象
      */
-    insert(name: string, options: ModelCameraOptions, owner?: ModelCameraComponent): PCamera;
+    insert(name: string, data: ModelCameraComponentData, owner?: ModelCameraComponent): PCamera;
     /**
      * 插入相机对象
      * @param camera - 相机对象

package/dist/runtime/common.d.ts

@@ -73,6 +73,8 @@ export declare enum PShadowType {
     variance = 2,
     expVariance = 3
 }
+export declare const PBRShaderGUID = "pbr00000000000000000000000000000";
+export declare const UnlitShaderGUID = "unlit000000000000000000000000000";
 /**
  * 插件变换类
  */

package/dist/runtime/index.d.ts

@@ -10,3 +10,4 @@ export * from './object';
 export * from './scene';
 export * from './shader';
 export * from './skybox';
+export * from './math';

package/dist/runtime/light.d.ts

@@ -1,4 +1,4 @@
-import type { ModelLightOptions } from '../index';
+import type { ModelLightComponentData } from '../index';
 import { Vector2, Vector3 } from './math';
 import { PLightType } from './common';
 import { PEntity } from './object';
@@ -42,10 +42,11 @@ export declare class PLight extends PEntity {
     padding: Vector2;
     /**
      * 创建灯光对象
-     * @param light - 灯光参数
-     * @param ownerI - 所属灯光组件
+     * @param name - 灯光名称
+     * @param data - 灯光相关数据
+     * @param owner - 所属灯光组件
      */
-    constructor(name: string, options: ModelLightOptions, owner?: ModelLightComponent);
+    constructor(name: string, data: ModelLightComponentData, owner?: ModelLightComponent);
     /**
      * 更新灯光变换
      */
@@ -100,7 +101,7 @@ export declare class PLightManager {
      * @param owner - 所属灯光组件
      * @returns 插入的灯光对象
      */
-    insertItem(name: string, inLight: ModelLightOptions, owner?: ModelLightComponent): PLight;
+    insertItem(name: string, inLight: ModelLightComponentData, owner?: ModelLightComponent): PLight;
     /**
      * 插入灯光对象
      * @param inLight - 灯光对象