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

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

@@ -8,7 +8,6 @@ import { Vector3 } from '../runtime/math';
 /**
  * 插件 Mesh 组件类，支持 3D Mesh 渲染能力
  * @since 2.0.0
- * @internal
  */
 export declare class ModelMeshComponent extends RendererComponent {
     /**
@@ -40,17 +39,17 @@ export declare class ModelMeshComponent extends RendererComponent {
     /**
      * 组件开始，需要创建内部对象，更新父元素信息和添加到场景管理器中
      */
-    start(): void;
+    onStart(): void;
     /**
      * 组件更新，更新内部对象状态
      * @param dt - 更新间隔
      */
-    update(dt: number): void;
+    onUpdate(dt: number): void;
     /**
      * 组件晚更新，晚更新内部对象状态
      * @param dt - 更新间隔
      */
-    lateUpdate(dt: number): void;
+    onLateUpdate(dt: number): void;
     /**
      * 组件渲染，需要检查可见性
      * @param renderer - 渲染器
@@ -94,7 +93,6 @@ export declare class ModelMeshComponent extends RendererComponent {
 /**
  * 插件天空盒组件类，支持 3D 天空盒渲染能力
  * @since 2.0.0
- * @internal
  */
 export declare class ModelSkyboxComponent extends RendererComponent {
     /**
@@ -118,7 +116,7 @@ export declare class ModelSkyboxComponent extends RendererComponent {
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
-    start(): void;
+    onStart(): void;
     /**
      * 组件渲染，需要检查可见性
      * @param renderer - 渲染器
@@ -151,7 +149,6 @@ export declare class ModelSkyboxComponent extends RendererComponent {
 /**
  * 插件灯光组件类，支持 3D 灯光能力
  * @since 2.0.0
- * @internal
  */
 export declare class ModelLightComponent extends Behaviour {
     /**
@@ -171,12 +168,12 @@ export declare class ModelLightComponent extends Behaviour {
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
-    start(): void;
+    onStart(): void;
     /**
      * 组件更新，更新内部对象状态
      * @param dt - 更新间隔
      */
-    update(dt: number): void;
+    onUpdate(dt: number): void;
     /**
      * 组件销毁
      */
@@ -203,7 +200,6 @@ export declare class ModelLightComponent extends Behaviour {
 /**
  * 插件相机组件类，支持 3D 相机能力
  * @since 2.0.0
- * @internal
  */
 export declare class ModelCameraComponent extends Behaviour {
     /**
@@ -223,12 +219,12 @@ export declare class ModelCameraComponent extends Behaviour {
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
-    start(): void;
+    onStart(): void;
     /**
      * 组件更新，更新内部对象状态
      * @param dt - 更新间隔
      */
-    update(dt: number): void;
+    onUpdate(dt: number): void;
     /**
      * 组件销毁
      */
@@ -256,7 +252,6 @@ export declare class ModelCameraComponent extends Behaviour {
 /**
  * 插件动画组件类，支持 3D 动画能力
  * @since 2.0.0
- * @internal
  */
 export declare class AnimationComponent extends Behaviour {
     /**
@@ -274,12 +269,12 @@ export declare class AnimationComponent extends Behaviour {
     /**
      * 组件开始，需要创建内部对象和添加到场景管理器中
      */
-    start(): void;
+    onStart(): void;
     /**
      * 组件更新，更新内部对象状态
      * @param dt - 更新间隔
      */
-    update(dt: number): void;
+    onUpdate(dt: number): void;
     /**
      * 组件销毁
      */

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

@@ -1,5 +1,5 @@
-import type { Scene, SceneLoadOptions, Composition, RenderFrame, Engine, Component, Renderer } from '@galacean/effects';
-import { AbstractPlugin, spec, Behaviour } from '@galacean/effects';
+import type { Scene, SceneLoadOptions, Composition, RenderFrame, Component, Renderer } from '@galacean/effects';
+import { AbstractPlugin, spec } from '@galacean/effects';
 import { CompositionCache } from '../runtime/cache';
 import { PSceneManager } from '../runtime';
 /**
@@ -46,75 +46,6 @@ export declare class ModelPlugin extends AbstractPlugin {
 export interface ModelPluginOptions {
     cache: CompositionCache;
 }
-/**
- * 插件组件类，实现特定的插件功能
- * @since 2.0.0
- * @internal
- */
-export declare class ModelPluginComponent extends Behaviour {
-    private runtimeEnv;
-    private compatibleMode;
-    private renderSkybox;
-    private visBoundingBox;
-    private autoAdjustScene;
-    /**
-     * 渲染插件是否启用动态排序功能
-     * 支持在渲染的时候对透明 Mesh 进行动态排序
-     */
-    private enableDynamicSort;
-    /**
-     * 3D 渲染模式，支持可视化渲染中间结果
-     * none 表示正常的渲染结果
-     */
-    private renderMode3D;
-    /**
-     * UV 渲染模式中，指定棋盘格的大小，相对于大小为 1 的纹理
-     * 取值范围(0, 1)
-     */
-    private renderMode3DUVGridSize;
-    /**
-     * 合成缓存器
-     */
-    cache: CompositionCache;
-    /**
-     * 场景管理器
-     */
-    scene: PSceneManager;
-    /**
-     * 构造函数，创建场景管理器
-     * @param engine - 引擎
-     * @param options - Mesh 参数
-     */
-    constructor(engine: Engine, options?: ModelPluginOptions);
-    /**
-     * 组件后更新，合成相机和场景管理器更新
-     * @param dt - 更新间隔
-     */
-    lateUpdate(dt: number): void;
-    /**
-     * 组件销毁，同时销毁场景管理器和缓存器
-     */
-    onDestroy(): void;
-    /**
-     * 反序列化，创建场景管理器
-     * @param date - 组件参数
-     */
-    fromData(data: ModelPluginOptions): void;
-    /**
-     * 组件初始化，初始化场景管理器并更新合成相机
-     * @param sceneParams - 场景参数
-     */
-    initial(sceneParams: Record<string, any>): void;
-    /**
-     * 更新 SceneManager 中渲染用的相机，相机参数来自 composition.camera
-     *
-     * @param composition - 当前合成对象
-     * @param sceneManager - 当前合成对象绑定的 SceneManager
-     */
-    private updateSceneCamera;
-    private getLightItemCount;
-    private getMaxJointCount;
-}
 /**
  * 获取场景管理器，从合成中查找
  * @param component

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

@@ -85,7 +85,6 @@ export declare class ModelTreeItem {
 /**
  * 插件场景树组件类，实现 3D 场景树功能
  * @since 2.0.0
- * @internal
  */
 export declare class ModelTreeComponent extends Behaviour {
     /**
@@ -110,12 +109,12 @@ export declare class ModelTreeComponent extends Behaviour {
     /**
      * 组件开始，查询合成中场景管理器并设置到动画管理器中
      */
-    start(): void;
+    onStart(): void;
     /**
      * 组件更新，内部对象更新
      * @param dt
      */
-    update(dt: number): void;
+    onUpdate(dt: number): void;
     /**
      * 组件销毁，内部对象销毁
      */

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.2";
+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!");