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

package/dist/runtime/material.d.ts

@@ -4,98 +4,403 @@ import type { ModelMaterialOptions, ModelMaterialUnlitOptions, ModelMaterialPBRO
 import { Vector3, Vector4, Matrix3 } from './math';
 import { PMaterialType, PBlendMode, PFaceSideMode } from './common';
 import { PObject } from './object';
+/**
+ * 3D 材质基础类，支持公共的材质功能
+ */
 export declare abstract class PMaterialBase extends PObject {
+    /**
+     * 材质类型，主要是 pbr 和 unlit 两类
+     */
     materialType: PMaterialType;
+    /**
+     * 顶点着色器代码
+     */
     vertexShaderCode: string;
+    /**
+     * 片段着色器代码
+     */
     fragmentShaderCode: string;
     /**
-     * 深度是否写入，默认是写入(true)
+     * 深度是否写入，默认是写入
      */
     depthMask: boolean;
+    /**
+     * 是否深度测试提示，默认开启
+     */
     depthTestHint: boolean;
+    /**
+     * 混合模式，默认是不透明
+     */
     blendMode: PBlendMode;
+    /**
+     * Alpha 测试截断值
+     */
     alphaCutOff: number;
+    /**
+     * 面侧模式，默认是正面
+     */
     faceSideMode: PFaceSideMode;
+    /**
+     * 获取着色器特性列表，根据材质状态
+     * @returns 特性列表
+     */
     getShaderFeatures(): string[];
+    /**
+     * 根据材质状态，更新 GE 材质状态
+     * @param material - GE 材质
+     */
     updateUniforms(material: Material): void;
+    /**
+     * 生成顶点和片段着色器代码
+     * 先获取着色器特性，再根据材质和全局状态，生成着色器代码
+     * @param inFeatureList - 外部特性列表
+     */
     build(inFeatureList?: string[]): void;
+    /**
+     * 获取混合模式，根据 GE 混合模式
+     * @param mode - GE 混合模式
+     * @returns
+     */
     getBlendMode(mode?: spec.MaterialBlending): PBlendMode;
+    /**
+     * 获取面侧模式，根据 GE 面侧模式
+     * @param mode - GE 面侧模式
+     * @returns
+     */
     getFaceSideMode(mode?: spec.SideMode): PFaceSideMode;
+    /**
+     * 设置材质状态，根据 GE 材质状态
+     * @param material - GE 材质
+     */
     setMaterialStates(material: Material): void;
     protected setFaceSideStates(material: Material): void;
+    /**
+     * 销毁材质，清除着色器代码
+     */
     dispose(): void;
+    /**
+     * 是否合法，材质类型非 none
+     * @returns
+     */
     isValid(): boolean;
+    /**
+     * 是否不透明
+     * @returns
+     */
     isOpaque(): boolean;
+    /**
+     * 是否遮罩
+     * @returns
+     */
     isMasked(): boolean;
+    /**
+     * 是否半透明
+     * @returns
+     */
     isTranslucent(): boolean;
+    /**
+     * 是否加法混合
+     * @returns
+     */
     isAdditive(): boolean;
+    /**
+     * 是否需要混合
+     * @returns
+     */
     requireBlend(): boolean;
+    /**
+     * 是否正面模式
+     * @returns
+     */
     isFrontFace(): boolean;
+    /**
+     * 是否背面模式
+     * @returns
+     */
     isBackFace(): boolean;
+    /**
+     * 是否双面模式
+     * @returns
+     */
     isBothFace(): boolean;
 }
+/**
+ * 无光照材质类，负责无关照或者不接受光照情况下的物体材质效果
+ */
 export declare class PMaterialUnlit extends PMaterialBase {
     private baseColorFactor;
     private baseColorTexture?;
+    /**
+     * 创建无光照材质，支持基础颜色纹理
+     * @param options - 无光照材质参数
+     */
     create(options: ModelMaterialUnlitOptions): void;
+    /**
+     * 销毁材质
+     */
     dispose(): void;
+    /**
+     * 获取着色器特性列表，根据材质状态
+     * @returns 着色器特性列表
+     */
     getShaderFeatures(): string[];
+    /**
+     * 更新对应的 GE 材质中着色器的 Uniform 数据
+     * @param material - GE 材质
+     */
     updateUniforms(material: Material): void;
+    /**
+     * 是否有基础颜色纹理
+     * @returns
+     */
     hasBaseColorTexture(): boolean;
+    /**
+     * 获取基础颜色纹理
+     * @returns
+     */
     getBaseColorTexture(): Texture;
+    /**
+     * 设置基础颜色纹理
+     * @param val - 纹理对象
+     */
     setBaseColorTexture(val: Texture): void;
+    /**
+     * 获取基础颜色值
+     * @returns
+     */
     getBaseColorFactor(): Vector4;
+    /**
+     * 设置基础颜色值
+     * @param val - 颜色值
+     */
     setBaseColorFactor(val: Vector4 | spec.vec4): void;
 }
+/**
+ * PBR 材质类，负责基于物理的材质效果，也是渲染中最常用的材质。
+ * 目前支持金属度/粗糙度工作流，与其他引擎中的 PBR 材质功能一致。
+ */
 export declare class PMaterialPBR extends PMaterialBase {
+    /**
+     * 基础颜色纹理
+     */
     baseColorTexture?: Texture;
+    /**
+     * 基础颜色纹理变换
+     */
     baseColorTextureTrans?: Matrix3;
+    /**
+     * 基础颜色值，默认是白色 Vector4(1, 1, 1, 1)
+     */
     baseColorFactor: Vector4;
+    /**
+     * 金属度粗超度纹理
+     */
     metallicRoughnessTexture?: Texture;
+    /**
+     * 金属度粗超度纹理变换
+     */
     metallicRoughnessTextureTrans?: Matrix3;
+    /**
+     * 是否高光抗锯齿，能够明显提升高光表现效果
+     */
     useSpecularAA: boolean;
+    /**
+     * 金属度值
+     */
     metallicFactor: number;
+    /**
+     * 粗超度值
+     */
     roughnessFactor: number;
+    /**
+     * 法线纹理
+     */
     normalTexture?: Texture;
+    /**
+     * 法线纹理变换
+     */
     normalTextureTrans?: Matrix3;
+    /**
+     * 法线纹理缩放
+     */
     normalTextureScale: number;
+    /**
+     * AO 纹理
+     */
     occlusionTexture?: Texture;
+    /**
+     * AO 纹理变换
+     */
     occlusionTextureTrans?: Matrix3;
+    /**
+     * AO 纹理强度
+     */
     occlusionTextureStrength: number;
+    /**
+     * 自发光纹理
+     */
     emissiveTexture?: Texture;
+    /**
+     * 自发光纹理变换
+     */
     emissiveTextureTrans?: Matrix3;
+    /**
+     * 自发光颜色值，默认是黑色 Vector3(0, 0, 0)
+     */
     emissiveFactor: Vector3;
+    /**
+     * 自发光强度
+     */
     emissiveIntensity: number;
     enableShadow: boolean;
+    /**
+     * 创建材质
+     * @param options - PBR 材质参数
+     */
     create(options: ModelMaterialPBROptions): void;
+    /**
+     * 销毁材质
+     */
     dispose(): void;
+    /**
+     * 获取材质特性列表
+     * @returns 材质特性列表
+     */
     getShaderFeatures(): string[];
+    /**
+     * 更新关联的 GE 材质中着色器的 Uniform 数据
+     * @param material - GE 材质
+     */
     updateUniforms(material: Material): void;
+    /**
+     * 是否有基础颜色纹理
+     * @returns
+     */
     hasBaseColorTexture(): boolean;
+    /**
+     * 是否有基础颜色纹理变换
+     * @returns
+     */
     hasBaseColorTextureTrans(): boolean;
+    /**
+     * 设置基础颜色纹理
+     * @param val - 纹理
+     */
     setBaseColorTexture(val: Texture): void;
+    /**
+     * 获取基础颜色纹理
+     * @returns
+     */
     getBaseColorFactor(): Vector4;
+    /**
+     * 设置基础颜色值
+     * @param val - 颜色值
+     */
     setBaseColorFactor(val: Vector4 | spec.vec4): void;
+    /**
+     * 是否有金属度粗超度纹理
+     * @returns
+     */
     hasMetallicRoughnessTexture(): boolean;
+    /**
+     * 是否有金属度粗超度纹理坐标变换
+     * @returns
+     */
     hasMetallicRoughnessTextureTrans(): boolean;
+    /**
+     * 获取金属度粗超度纹理
+     * @returns
+     */
     getMetallicRoughnessTexture(): Texture;
+    /**
+     * 设置金属度粗超度纹理
+     * @param val - 纹理
+     */
     setMetallicRoughnessTexture(val: Texture): void;
+    /**
+     * 是否有法线纹理
+     * @returns
+     */
     hasNormalTexture(): boolean;
+    /**
+     * 是否有法线纹理坐标变换
+     * @returns
+     */
     hasNormalTextureTrans(): boolean;
+    /**
+     * 获取法线纹理
+     * @returns
+     */
     getNormalTexture(): Texture;
+    /**
+     * 设置法线纹理
+     * @param val - 纹理
+     */
     setNormalTexture(val: Texture): void;
+    /**
+     * 是否有遮挡纹理
+     * @returns
+     */
     hasOcclusionTexture(): boolean;
+    /**
+     * 是否有遮挡纹理坐标变换
+     * @returns
+     */
     hasOcclusionTextureTrans(): boolean;
+    /**
+     * 获取遮挡纹理
+     * @returns
+     */
     getOcclusionTexture(): Texture;
+    /**
+     * 设置遮挡纹理
+     * @param val - 纹理
+     */
     setOcclusionTexture(val: Texture): void;
+    /**
+     * 是否有自发光纹理
+     * @returns
+     */
     hasEmissiveTexture(): boolean;
+    /**
+     * 是否有自发光纹理坐标变换
+     * @returns
+     */
     hasEmissiveTextureTrans(): boolean;
+    /**
+     * 获取自发光纹理
+     * @returns
+     */
     getEmissiveTexture(): Texture;
+    /**
+     * 设置自发光纹理
+     * @param val - 纹理
+     */
     setEmissiveTexture(val: Texture): void;
+    /**
+     * 是否有自发光颜色，包含强度
+     * @returns
+     */
     hasEmissiveFactor(): boolean;
+    /**
+     * 获取自发光颜色，包含强度
+     * @returns
+     */
     getEmissiveFactor(): Vector3;
+    /**
+     * 设置自发光颜色
+     * @param val - 颜色
+     */
     setEmissiveFactor(val: Vector3 | spec.vec3): void;
 }
+/**
+ * 材质类型，包括无光照材质和 PBR 材质
+ */
 export type PMaterial = PMaterialUnlit | PMaterialPBR;
+/**
+ * 创建插件材质对象
+ * @param options - 材质参数
+ * @returns 材质对象
+ */
 export declare function createPluginMaterial(options: ModelMaterialOptions): PMaterial;
 export declare function createInternalMaterial(options: {}): {};

package/dist/runtime/math.d.ts

@@ -1,5 +1,7 @@
 import { math } from '@galacean/effects';
 export declare const Vector2: typeof math.Vector2, Vector3: typeof math.Vector3, Vector4: typeof math.Vector4, Matrix3: typeof math.Matrix3, Matrix4: typeof math.Matrix4, Euler: typeof math.Euler, EulerOrder: typeof math.EulerOrder, Quaternion: typeof math.Quaternion, Box3: typeof math.Box3, Sphere: typeof math.Sphere, Ray: typeof math.Ray, DEG2RAD: number;
+export type Ray = math.Ray;
+export type Euler = math.Euler;
 export type Vector2 = math.Vector2;
 export type Vector3 = math.Vector3;
 export type Vector4 = math.Vector4;