@galacean/effects-plugin-model 1.2.0 → 2.0.0-alpha.0

package/dist/runtime/common.d.ts

@@ -1,8 +1,9 @@
-import type { math } from '@galacean/effects';
 import { Transform as EffectsTransform, spec } from '@galacean/effects';
 import { Quaternion, Euler, Vector3, Matrix4 } from './math';
 import type { BaseTransform } from '../index';
-type Euler = math.Euler;
+/**
+ * Model 插件中的对象类型
+ */
 export declare enum PObjectType {
     none = 0,
     mesh = 1,
@@ -18,18 +19,27 @@ export declare enum PObjectType {
     animationManager = 11,
     reference = 12
 }
+/**
+ * 灯光类型
+ */
 export declare enum PLightType {
     directional = 0,
     point = 1,
     spot = 2,
     ambient = 3
 }
+/**
+ * 纹理类型
+ */
 export declare enum PTextureType {
     none = 0,
     t2d = 1,
     t3d = 2,
     cube = 3
 }
+/**
+ * 材质类型
+ */
 export declare enum PMaterialType {
     none = 0,
     unlit = 1,
@@ -40,12 +50,18 @@ export declare enum PMaterialType {
     shadowFilter = 6,
     skyboxFilter = 7
 }
+/**
+ * 混合模式
+ */
 export declare enum PBlendMode {
     opaque = 0,
     masked = 1,
     translucent = 2,
     additive = 3
 }
+/**
+ * 面片朝向模式
+ */
 export declare enum PFaceSideMode {
     both = 0,
     front = 1,
@@ -57,39 +73,145 @@ export declare enum PShadowType {
     variance = 2,
     expVariance = 3
 }
+/**
+ * 插件变换类
+ */
 export declare class PTransform {
     private translation;
     private rotation;
     private scale;
+    /**
+     * 从矩阵设置数据
+     * @param matrix - 4阶矩阵
+     * @returns
+     */
     fromMatrix4(matrix: Matrix4): this;
+    /**
+     * 从 GE 变换设置数据
+     * @param trans - GE 变换对象或数据
+     * @returns
+     */
     fromEffectsTransform(trans: EffectsTransform | BaseTransform): this;
+    /**
+     * 转成 GE 变换对象
+     * @param transform - GE 变换对象
+     * @returns
+     */
     toEffectsTransform(transform: EffectsTransform): EffectsTransform;
+    /**
+     * 通过 GE 变换参数设置
+     * @param trans - GE 变换参数
+     * @returns
+     */
     fromBaseTransform(trans: BaseTransform): this;
+    /**
+     * 获取平移
+     * @returns
+     */
     getTranslation(): Vector3;
+    /**
+     * 设置平移
+     * @param val - 平移
+     */
     setTranslation(val: Vector3 | spec.vec3): void;
+    /**
+     * 获取位置
+     * @returns
+     */
     getPosition(): Vector3;
+    /**
+     * 设置位置
+     * @param val - 位置
+     */
     setPosition(val: Vector3 | spec.vec3): void;
+    /**
+     * 获取旋转
+     * @returns
+     */
     getRotation(): Quaternion;
+    /**
+     * 设置旋转
+     * @param val - 旋转，可能是四元数或欧拉角
+     */
     setRotation(val: Quaternion | Euler | Vector3 | spec.vec4 | spec.vec3): void;
+    /**
+     * 获取缩放
+     * @returns
+     */
     getScale(): Vector3;
+    /**
+     * 设置缩放
+     * @param val - 缩放
+     */
     setScale(val: Vector3 | spec.vec3): void;
+    /**
+     * 获取矩阵
+     * @returns
+     */
     getMatrix(): Matrix4;
+    /**
+     * 设置矩阵
+     * @param mat - 4阶矩阵
+     */
     setMatrix(mat: Matrix4 | spec.mat4): void;
 }
+/**
+ * 坐标系类
+ */
 export declare class PCoordinate {
+    /**
+     * 原点
+     */
     origin: Vector3;
+    /**
+     * X 轴
+     */
     xAxis: Vector3;
+    /**
+     * Y 轴
+     */
     yAxis: Vector3;
+    /**
+     * Z 轴
+     */
     zAxis: Vector3;
     constructor();
+    /**
+     * 从插件变换创建坐标系
+     * @param trans - 变换
+     * @param invert - 是否旋转取反
+     * @returns 坐标系对象
+     */
     fromPTransform(trans: PTransform, invert?: boolean): this;
+    /**
+     * 从旋转矩阵创建坐标系
+     * @param matrix - 矩阵
+     */
     fromRotationMatrix(matrix: Matrix4): void;
 }
+/**
+ * 全局状态
+ */
 export declare class PGlobalState {
+    /**
+     * 是否 WebGL2
+     */
     isWebGL2: boolean;
+    /**
+     * 是否共享 Shader
+     */
     shaderShared: boolean;
+    /**
+     * 运行时环境，编辑器模式或设备模式
+     */
     runtimeEnv: string;
+    /**
+     * 兼容模式，glTF 模式或 Tiny3d 模式
+     */
     compatibleMode: string;
+    /**
+     * 是否显示包围盒
+     */
     visBoundingBox: boolean;
     /**
      * 渲染输出结果模式，可以换中间渲染数据
@@ -100,17 +222,34 @@ export declare class PGlobalState {
      */
     renderMode3DUVGridSize: number;
     private static instance;
+    /**
+     * 获取单例
+     * @returns
+     */
     static getInstance(): PGlobalState;
     private constructor();
+    /**
+     * 重置数据
+     */
     reset(): void;
     /**
      * 是否可视化渲染中间结果
      */
     hasRenderMode3D(): boolean;
+    /**
+     * 是否编辑器模式
+     */
     get isEditorEnv(): boolean;
+    /**
+     * 是否设备模式
+     */
     get isDeviceEnv(): boolean;
+    /**
+     * 是否 Tiny3d 模式
+     */
     get isTiny3dMode(): boolean;
-    get isOasisMode(): boolean;
+    /**
+     * 是否 glTF 模式
+     */
     get isGLTFMode(): boolean;
 }
-export {};

package/dist/runtime/light.d.ts

@@ -1,34 +1,123 @@
-import type { ModelItemLight } from '../index';
+import type { ModelLightOptions } from '../index';
 import { Vector2, Vector3 } from './math';
 import { PLightType } from './common';
 import { PEntity } from './object';
-import type { ModelVFXItem } from '../plugin/model-vfx-item';
+import type { ModelLightComponent } from '../plugin/model-item';
+/**
+ * 灯光类，支持 3D 场景中的灯光功能
+ */
 export declare class PLight extends PEntity {
+    /**
+     * 所属的灯光组件
+     */
+    owner?: ModelLightComponent;
+    /**
+     * 方向，仅用于方向光和聚光灯
+     */
     direction: Vector3;
+    /**
+     * 范围，仅用于点光源和聚光灯
+     */
     range: number;
+    /**
+     * 颜色
+     */
     color: Vector3;
+    /**
+     * 强度
+     */
     intensity: number;
+    /**
+     * 聚光灯外径
+     */
     outerConeAngle: number;
+    /**
+     * 聚光灯内径
+     */
     innerConeAngle: number;
+    /**
+     * 类型
+     */
     lightType: PLightType;
     padding: Vector2;
-    constructor(light: ModelItemLight, ownerItem?: ModelVFXItem);
-    tick(deltaSeconds: number): void;
+    /**
+     * 创建灯光对象
+     * @param light - 灯光参数
+     * @param ownerI - 所属灯光组件
+     */
+    constructor(name: string, options: ModelLightOptions, owner?: ModelLightComponent);
+    /**
+     * 更新灯光变换
+     */
+    update(): void;
+    /**
+     * 是否方向光
+     * @returns
+     */
     isDirectional(): boolean;
+    /**
+     * 是否点光源
+     * @returns
+     */
     isPoint(): boolean;
+    /**
+     * 是否聚光灯
+     * @returns
+     */
     isSpot(): boolean;
+    /**
+     * 是否环境光
+     * @returns
+     */
     isAmbient(): boolean;
+    /**
+     * 获取位置
+     */
     get position(): Vector3;
+    /**
+     * 获取世界坐标中的位置
+     * @returns
+     */
     getWorldPosition(): Vector3;
+    /**
+     * 获取世界坐标中的方向
+     * @returns
+     */
     getWorldDirection(): Vector3;
 }
+/**
+ * 灯光管理类，负责 3D 场景灯光的管理
+ */
 export declare class PLightManager {
+    /**
+     * 灯光数组
+     */
     lightList: PLight[];
     constructor();
-    tick(deltaSeconds: number): void;
-    insertItem(inLight: ModelItemLight, ownerItem?: ModelVFXItem): PLight;
+    /**
+     * 通过灯光参数，创建灯光对象，并保存到灯光数组中
+     * @param inLight - 灯光参数
+     * @param owner - 所属灯光组件
+     * @returns 插入的灯光对象
+     */
+    insertItem(name: string, inLight: ModelLightOptions, owner?: ModelLightComponent): PLight;
+    /**
+     * 插入灯光对象
+     * @param inLight - 灯光对象
+     * @returns 插入的灯光对象
+     */
     insertLight(inLight: PLight): PLight;
+    /**
+     * 删除灯光对象，从灯光数组中查找对象并进行删除，如果没有找到就忽略
+     * @param inLight - 删除的灯光对象
+     */
     remove(inLight: PLight): void;
+    /**
+     * 销毁
+     */
     dispose(): void;
+    /**
+     * 灯光数目
+     */
     get lightCount(): number;
 }