@galacean/effects-plugin-model 2.0.3 → 2.1.0-alpha.0

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

@@ -1 +1,294 @@
+import type { Engine, HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, Renderer, VFXItem } from '@galacean/effects';
+import { Behaviour, 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';
+import type { Euler } from '../runtime/math';
+import { Vector3 } from '../runtime/math';
+/**
+ * 插件 Mesh 组件类，支持 3D Mesh 渲染能力
+ * @since 2.0.0
+ */
+export declare class ModelMeshComponent extends RendererComponent {
+    /**
+     * 内部 Mesh 对象
+     */
+    content: PMesh;
+    /**
+     * 参数
+     */
+    data?: ModelMeshComponentData;
+    /**
+     * 包围盒
+     */
+    bounding?: ModelItemBounding;
+    /**
+     * 场景管理器
+     */
+    sceneManager?: PSceneManager;
+    /**
+     * morph 动画权重
+     */
+    morphWeights: number[];
+    /**
+     * 构造函数，只保存传入参数，不在这里创建内部对象
+     * @param engine - 引擎
+     * @param data - Mesh 参数
+     */
+    constructor(engine: Engine, data?: ModelMeshComponentData);
+    /**
+     * 组件开始，需要创建内部对象，更新父元素信息和添加到场景管理器中
+     */
+    onStart(): void;
+    /**
+     * 组件更新，更新内部对象状态
+     * @param dt - 更新间隔
+     */
+    onUpdate(dt: number): void;
+    /**
+     * 组件晚更新，晚更新内部对象状态
+     * @param dt - 更新间隔
+     */
+    onLateUpdate(dt: number): void;
+    /**
+     * 组件渲染，需要检查可见性
+     * @param renderer - 渲染器
+     * @returns
+     */
+    render(renderer: Renderer): void;
+    /**
+     * 组件销毁，需要重场景管理器中删除
+     */
+    onDestroy(): void;
+    /**
+     * 反序列化，记录传入参数
+     * @param data - 组件参数
+     */
+    fromData(data: ModelMeshComponentData): void;
+    /**
+     * 创建内部对象
+     */
+    createContent(): void;
+    /**
+     * 设置当前 Mesh 的可见性。
+     * @param visible - true：可见，false：不可见
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * 获取当前 Mesh 的可见性。
+     */
+    getVisible(): boolean;
+    /**
+     * 获取点击测试参数，根据元素包围盒进行相交测试，Mesh 对象会进行更加精确的点击测试
+     * @param force - 是否强制进行点击测试
+     * @returns 点击测试参数
+     */
+    getHitTestParams: (force?: boolean) => HitTestBoxParams | HitTestSphereParams | HitTestCustomParams | undefined;
+    /**
+     * 计算元素包围盒，只针对 Mesh 对象
+     * @returns 包围盒
+     */
+    computeBoundingBox(): ModelItemBounding | undefined;
+}
+/**
+ * 插件天空盒组件类，支持 3D 天空盒渲染能力
+ * @since 2.0.0
+ */
+export declare class ModelSkyboxComponent extends RendererComponent {
+    /**
+     * 内部天空盒对象
+     */
+    content: PSkybox;
+    /**
+     * 天空盒参数
+     */
+    data?: ModelSkyboxComponentData;
+    /**
+     * 场景管理器
+     */
+    sceneManager?: PSceneManager;
+    /**
+     * 构造函数，只保存传入参数，不在这里创建内部对象
+     * @param engine - 引擎
+     * @param data - Mesh 参数
+     */
+    constructor(engine: Engine, data?: ModelSkyboxComponentData);
+    /**
+     * 组件开始，需要创建内部对象和添加到场景管理器中
+     */
+    onStart(): void;
+    /**
+     * 组件渲染，需要检查可见性
+     * @param renderer - 渲染器
+     * @returns
+     */
+    render(renderer: Renderer): void;
+    /**
+     * 组件销毁，需要重场景管理器中删除
+     */
+    onDestroy(): void;
+    /**
+     * 反序列化，记录传入参数
+     * @param data - 组件参数
+     */
+    fromData(data: ModelSkyboxComponentData): void;
+    /**
+     * 创建内部对象
+     */
+    createContent(): void;
+    /**
+     * 设置当前可见性。
+     * @param visible - true：可见，false：不可见
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * 获取当前可见性。
+     */
+    getVisible(): boolean;
+}
+/**
+ * 插件灯光组件类，支持 3D 灯光能力
+ * @since 2.0.0
+ */
+export declare class ModelLightComponent extends Behaviour {
+    /**
+     * 内部灯光对象
+     */
+    content: PLight;
+    /**
+     * 参数
+     */
+    data?: ModelLightComponentData;
+    /**
+     * 构造函数，只保存传入参数，不在这里创建内部对象
+     * @param engine - 引擎
+     * @param data - Mesh 参数
+     */
+    constructor(engine: Engine, data?: ModelLightComponentData);
+    /**
+     * 组件开始，需要创建内部对象和添加到场景管理器中
+     */
+    onStart(): void;
+    /**
+     * 组件更新，更新内部对象状态
+     * @param dt - 更新间隔
+     */
+    onUpdate(dt: number): void;
+    /**
+     * 组件销毁
+     */
+    onDestroy(): void;
+    /**
+     * 反序列化，记录传入参数
+     * @param data - 组件参数
+     */
+    fromData(data: ModelLightComponentData): void;
+    /**
+     * 创建内部对象
+     */
+    createContent(): void;
+    /**
+     * 设置当前可见性。
+     * @param visible - true：可见，false：不可见
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * 获取当前 Mesh 的可见性。
+     */
+    getVisible(): boolean;
+}
+/**
+ * 插件相机组件类，支持 3D 相机能力
+ * @since 2.0.0
+ */
+export declare class ModelCameraComponent extends Behaviour {
+    /**
+     * 内部相机对象
+     */
+    content: PCamera;
+    /**
+     * 参数
+     */
+    data?: ModelCameraComponentData;
+    /**
+     * 构造函数，只保存传入参数，不在这里创建内部对象
+     * @param engine - 引擎
+     * @param data - Mesh 参数
+     */
+    constructor(engine: Engine, data?: ModelCameraComponentData);
+    /**
+     * 组件开始，需要创建内部对象和添加到场景管理器中
+     */
+    onStart(): void;
+    /**
+     * 组件更新，更新内部对象状态
+     * @param dt - 更新间隔
+     */
+    onUpdate(dt: number): void;
+    /**
+     * 组件销毁
+     */
+    onDestroy(): void;
+    /**
+     * 反序列化，记录传入参数
+     * @param data - 组件参数
+     */
+    fromData(data: ModelCameraComponentData): void;
+    /**
+     * 创建内部对象
+     */
+    createContent(): void;
+    /**
+     * 更新合成主相机，更加当前相机元素状态
+     */
+    updateMainCamera(): void;
+    /**
+     * 设置变换
+     * @param position - 位置
+     * @param rotation - 旋转
+     */
+    setTransform(position?: Vector3, rotation?: Euler): void;
+}
+/**
+ * 插件动画组件类，支持 3D 动画能力
+ * @since 2.0.0
+ */
+export declare class AnimationComponent extends Behaviour {
+    /**
+     * 参数
+     */
+    data?: AnimationComponentData;
+    elapsedTime: number;
+    animation: number;
+    clips: ModelAnimationClip[];
+    /**
+     * 构造函数，只保存传入参数，不在这里创建内部对象
+     * @param engine - 引擎
+     */
+    constructor(engine: Engine);
+    /**
+     * 组件开始，需要创建内部对象和添加到场景管理器中
+     */
+    onStart(): void;
+    /**
+     * 组件更新，更新内部对象状态
+     * @param dt - 更新间隔
+     */
+    onUpdate(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-tree-item.d.ts

@@ -1,6 +1,6 @@
-import type { VFXItem } from '@galacean/effects';
-import { Transform } from '@galacean/effects';
-import type { ModelTreeOptions } from '../index';
+import type { Engine, VFXItem } from '@galacean/effects';
+import { Behaviour, Transform } from '@galacean/effects';
+import type { ModelTreeContent, ModelTreeOptions } from '../index';
 import { PAnimationManager } from '../runtime';
 /**
  * 场景树节点描述
@@ -82,3 +82,51 @@ export declare class ModelTreeItem {
     dispose(): void;
     private build;
 }
+/**
+ * 插件场景树组件类，实现 3D 场景树功能
+ * @since 2.0.0
+ */
+export declare class ModelTreeComponent extends Behaviour {
+    /**
+     * 内部节点树元素
+     */
+    content: ModelTreeItem;
+    /**
+     * 参数
+     */
+    options?: ModelTreeContent;
+    /**
+     * 构造函数，创建节点树元素
+     * @param engine
+     * @param options
+     */
+    constructor(engine: Engine, options?: ModelTreeContent);
+    /**
+     * 反序列化，保存入参和创建节点树元素
+     * @param options
+     */
+    fromData(options: ModelTreeContent): void;
+    /**
+     * 组件开始，查询合成中场景管理器并设置到动画管理器中
+     */
+    onStart(): void;
+    /**
+     * 组件更新，内部对象更新
+     * @param dt
+     */
+    onUpdate(dt: number): void;
+    /**
+     * 组件销毁，内部对象销毁
+     */
+    onDestroy(): void;
+    /**
+     * 创建内部场景树元素
+     */
+    createContent(): void;
+    /**
+     * 获取元素的变换
+     * @param itemId - 元素索引
+     * @returns
+     */
+    getNodeTransform(itemId: string): Transform;
+}

package/dist/weapp.js

@@ -4443,7 +4443,7 @@ exports.ModelMeshComponent = /*#__PURE__*/ function(RendererComponent) {
     var _proto = ModelMeshComponent.prototype;
     /**
    * 组件开始，需要创建内部对象，更新父元素信息和添加到场景管理器中
-   */ _proto.start = function start() {
+   */ _proto.onStart = function onStart() {
         var _this_sceneManager;
         this.sceneManager = getSceneManager(this);
         this.createContent();
@@ -4459,7 +4459,7 @@ exports.ModelMeshComponent = /*#__PURE__*/ function(RendererComponent) {
     /**
    * 组件更新，更新内部对象状态
    * @param dt - 更新间隔
-   */ _proto.update = function update(dt) {
+   */ _proto.onUpdate = function onUpdate(dt) {
         if (this.sceneManager) {
             this.content.build(this.sceneManager);
         }
@@ -4468,7 +4468,7 @@ exports.ModelMeshComponent = /*#__PURE__*/ function(RendererComponent) {
     /**
    * 组件晚更新，晚更新内部对象状态
    * @param dt - 更新间隔
-   */ _proto.lateUpdate = function lateUpdate(dt) {
+   */ _proto.onLateUpdate = function onLateUpdate(dt) {
         this.content.lateUpdate();
     };
     /**
@@ -4566,7 +4566,7 @@ exports.ModelSkyboxComponent = /*#__PURE__*/ function(RendererComponent) {
     var _proto = ModelSkyboxComponent.prototype;
     /**
    * 组件开始，需要创建内部对象和添加到场景管理器中
-   */ _proto.start = function start() {
+   */ _proto.onStart = function onStart() {
         var _this_sceneManager;
         this.createContent();
         this.item.type = VFX_ITEM_TYPE_3D;
@@ -4640,7 +4640,7 @@ exports.ModelLightComponent = /*#__PURE__*/ function(Behaviour) {
     var _proto = ModelLightComponent.prototype;
     /**
    * 组件开始，需要创建内部对象和添加到场景管理器中
-   */ _proto.start = function start() {
+   */ _proto.onStart = function onStart() {
         this.createContent();
         this.item.type = VFX_ITEM_TYPE_3D;
         var scene = getSceneManager(this);
@@ -4650,7 +4650,7 @@ exports.ModelLightComponent = /*#__PURE__*/ function(Behaviour) {
     /**
    * 组件更新，更新内部对象状态
    * @param dt - 更新间隔
-   */ _proto.update = function update(dt) {
+   */ _proto.onUpdate = function onUpdate(dt) {
         this.content.update();
     };
     /**
@@ -4705,7 +4705,7 @@ exports.ModelCameraComponent = /*#__PURE__*/ function(Behaviour) {
     var _proto = ModelCameraComponent.prototype;
     /**
    * 组件开始，需要创建内部对象和添加到场景管理器中
-   */ _proto.start = function start() {
+   */ _proto.onStart = function onStart() {
         this.createContent();
         this.item.type = VFX_ITEM_TYPE_3D;
         var scene = getSceneManager(this);
@@ -4715,7 +4715,7 @@ exports.ModelCameraComponent = /*#__PURE__*/ function(Behaviour) {
     /**
    * 组件更新，更新内部对象状态
    * @param dt - 更新间隔
-   */ _proto.update = function update(dt) {
+   */ _proto.onUpdate = function onUpdate(dt) {
         this.content.update();
         this.updateMainCamera();
     };
@@ -4786,14 +4786,14 @@ exports.AnimationComponent = /*#__PURE__*/ function(Behaviour) {
     var _proto = AnimationComponent.prototype;
     /**
    * 组件开始，需要创建内部对象和添加到场景管理器中
-   */ _proto.start = function start() {
+   */ _proto.onStart = function onStart() {
         this.elapsedTime = 0;
         this.item.type = VFX_ITEM_TYPE_3D;
     };
     /**
    * 组件更新，更新内部对象状态
    * @param dt - 更新间隔
-   */ _proto.update = function update(dt) {
+   */ _proto.onUpdate = function onUpdate(dt) {
         this.elapsedTime += dt * 0.001;
         if (this.animation >= 0 && this.animation < this.clips.length) {
             this.clips[this.animation].sampleAnimation(this.item, this.elapsedTime);
@@ -9771,7 +9771,7 @@ exports.ModelPluginComponent = /*#__PURE__*/ function(Behaviour) {
     /**
    * 组件后更新，合成相机和场景管理器更新
    * @param dt - 更新间隔
-   */ _proto.lateUpdate = function lateUpdate(dt) {
+   */ _proto.onLateUpdate = function onLateUpdate(dt) {
         var composition = this.item.composition;
         if (this.autoAdjustScene && this.scene.tickCount == 1) {
             var _composition_items;
@@ -10061,7 +10061,7 @@ exports.ModelTreeComponent = /*#__PURE__*/ function(Behaviour) {
     };
     /**
    * 组件开始，查询合成中场景管理器并设置到动画管理器中
-   */ _proto.start = function start() {
+   */ _proto.onStart = function onStart() {
         this.item.type = EFFECTS.spec.ItemType.tree;
         this.content.baseTransform.setValid(true);
         var sceneManager = getSceneManager(this);
@@ -10072,7 +10072,7 @@ exports.ModelTreeComponent = /*#__PURE__*/ function(Behaviour) {
     /**
    * 组件更新，内部对象更新
    * @param dt
-   */ _proto.update = function update(dt) {
+   */ _proto.onUpdate = function onUpdate(dt) {
         var // this.timeline?.getRenderData(time, true);
         // TODO: 需要使用lifetime
         _this_content;
@@ -13794,7 +13794,7 @@ var GLTFHelper = /*#__PURE__*/ function() {
 
 EFFECTS.registerPlugin("tree", ModelTreePlugin, EFFECTS.VFXItem, true);
 EFFECTS.registerPlugin("model", ModelPlugin, EFFECTS.VFXItem);
-var version = "2.0.3";
+var version = "2.1.0-alpha.0";
 EFFECTS.logger.info("Plugin model version: " + version + ".");
 if (version !== EFFECTS__namespace.version) {
     console.error("注意：请统一 Model 插件与 Player 版本，不统一的版本混用会有不可预知的后果！", "\nAttention: Please ensure the Model plugin is synchronized with the Player version. Mixing and matching incompatible versions may result in unpredictable consequences!");