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

package/dist/runtime/material.d.ts

@@ -1,13 +1,15 @@
-import type { Material, Texture } from '@galacean/effects';
+import type { Texture, Material } from '@galacean/effects';
 import { spec } from '@galacean/effects';
-import type { ModelMaterialOptions, ModelMaterialUnlitOptions, ModelMaterialPBROptions } from '../index';
-import { Vector3, Vector4, Matrix3 } from './math';
-import { PMaterialType, PBlendMode, PFaceSideMode } from './common';
+import type { MacroInfo } from '../index';
+import type { Matrix3 } from './math';
+import { Vector3, Vector4, Color } from './math';
+import { PMaterialType } from './common';
 import { PObject } from './object';
 /**
  * 3D 材质基础类，支持公共的材质功能
  */
 export declare abstract class PMaterialBase extends PObject {
+    effectMaterial: Material;
     /**
      * 材质类型，主要是 pbr 和 unlit 两类
      */
@@ -23,28 +25,33 @@ export declare abstract class PMaterialBase extends PObject {
     /**
      * 深度是否写入，默认是写入
      */
-    depthMask: boolean;
+    ZWrite: boolean;
     /**
      * 是否深度测试提示，默认开启
      */
-    depthTestHint: boolean;
+    ZTest: boolean;
     /**
-     * 混合模式，默认是不透明
+     * 渲染类型，默认是不透明
      */
-    blendMode: PBlendMode;
+    renderType: spec.RenderType;
+    /**
+     * 是否 Alpha 裁剪，默认关闭
+     */
+    alphaClip: boolean;
     /**
      * Alpha 测试截断值
      */
-    alphaCutOff: number;
+    alphaCutoff: number;
     /**
      * 面侧模式，默认是正面
      */
-    faceSideMode: PFaceSideMode;
+    renderFace: spec.RenderFace;
     /**
      * 获取着色器特性列表，根据材质状态
      * @returns 特性列表
      */
     getShaderFeatures(): string[];
+    getShaderMacros(): MacroInfo[];
     /**
      * 根据材质状态，更新 GE 材质状态
      * @param material - GE 材质
@@ -56,18 +63,8 @@ export declare abstract class PMaterialBase extends PObject {
      * @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;
+    getFeatureList(inFeatureList?: string[]): string[];
+    getMacroList(inMacroList?: MacroInfo[]): MacroInfo[];
     /**
      * 设置材质状态，根据 GE 材质状态
      * @param material - GE 材质
@@ -89,52 +86,52 @@ export declare abstract class PMaterialBase extends PObject {
      */
     isOpaque(): boolean;
     /**
-     * 是否遮罩
+     * 是否 Alpha 裁剪
      * @returns
      */
-    isMasked(): boolean;
+    isAlphaClip(): boolean;
     /**
      * 是否半透明
      * @returns
      */
-    isTranslucent(): boolean;
-    /**
-     * 是否加法混合
-     * @returns
-     */
-    isAdditive(): boolean;
-    /**
-     * 是否需要混合
-     * @returns
-     */
-    requireBlend(): boolean;
+    isTransparent(): boolean;
     /**
      * 是否正面模式
      * @returns
      */
-    isFrontFace(): boolean;
+    isFrontSide(): boolean;
     /**
      * 是否背面模式
      * @returns
      */
-    isBackFace(): boolean;
+    isBackSide(): boolean;
     /**
      * 是否双面模式
      * @returns
      */
-    isBothFace(): boolean;
+    isBothSide(): boolean;
 }
 /**
  * 无光照材质类，负责无关照或者不接受光照情况下的物体材质效果
  */
 export declare class PMaterialUnlit extends PMaterialBase {
-    private baseColorFactor;
-    private baseColorTexture?;
+    /**
+     * 基础颜色纹理
+     */
+    baseColorTexture?: Texture;
+    /**
+     * 基础颜色纹理变换
+     */
+    baseColorTextureTrans: Matrix3;
+    /**
+     * 基础颜色值，默认是白色 Color(1, 1, 1, 1)
+     */
+    baseColorFactor: Color;
     /**
      * 创建无光照材质，支持基础颜色纹理
-     * @param options - 无光照材质参数
+     * @param material - effect 材质对象
      */
-    create(options: ModelMaterialUnlitOptions): void;
+    create(material: Material): void;
     /**
      * 销毁材质
      */
@@ -144,6 +141,7 @@ export declare class PMaterialUnlit extends PMaterialBase {
      * @returns 着色器特性列表
      */
     getShaderFeatures(): string[];
+    getShaderMacros(): MacroInfo[];
     /**
      * 更新对应的 GE 材质中着色器的 Uniform 数据
      * @param material - GE 材质
@@ -165,15 +163,15 @@ export declare class PMaterialUnlit extends PMaterialBase {
      */
     setBaseColorTexture(val: Texture): void;
     /**
-     * 获取基础颜色值
+     * 获取基础颜色纹理
      * @returns
      */
-    getBaseColorFactor(): Vector4;
+    getBaseColorFactor(): Color;
     /**
      * 设置基础颜色值
      * @param val - 颜色值
      */
-    setBaseColorFactor(val: Vector4 | spec.vec4): void;
+    setBaseColorFactor(val: Color | Vector4 | spec.vec4): void;
 }
 /**
  * PBR 材质类，负责基于物理的材质效果，也是渲染中最常用的材质。
@@ -187,11 +185,11 @@ export declare class PMaterialPBR extends PMaterialBase {
     /**
      * 基础颜色纹理变换
      */
-    baseColorTextureTrans?: Matrix3;
+    baseColorTextureTrans: Matrix3;
     /**
-     * 基础颜色值，默认是白色 Vector4(1, 1, 1, 1)
+     * 基础颜色值，默认是白色 Color(1, 1, 1, 1)
      */
-    baseColorFactor: Vector4;
+    baseColorFactor: Color;
     /**
      * 金属度粗超度纹理
      */
@@ -199,7 +197,7 @@ export declare class PMaterialPBR extends PMaterialBase {
     /**
      * 金属度粗超度纹理变换
      */
-    metallicRoughnessTextureTrans?: Matrix3;
+    metallicRoughnessTextureTrans: Matrix3;
     /**
      * 是否高光抗锯齿，能够明显提升高光表现效果
      */
@@ -219,7 +217,7 @@ export declare class PMaterialPBR extends PMaterialBase {
     /**
      * 法线纹理变换
      */
-    normalTextureTrans?: Matrix3;
+    normalTextureTrans: Matrix3;
     /**
      * 法线纹理缩放
      */
@@ -231,7 +229,7 @@ export declare class PMaterialPBR extends PMaterialBase {
     /**
      * AO 纹理变换
      */
-    occlusionTextureTrans?: Matrix3;
+    occlusionTextureTrans: Matrix3;
     /**
      * AO 纹理强度
      */
@@ -243,21 +241,20 @@ export declare class PMaterialPBR extends PMaterialBase {
     /**
      * 自发光纹理变换
      */
-    emissiveTextureTrans?: Matrix3;
+    emissiveTextureTrans: Matrix3;
     /**
-     * 自发光颜色值，默认是黑色 Vector3(0, 0, 0)
+     * 自发光颜色值，默认是黑色 Vector4(0, 0, 0, 0)
      */
-    emissiveFactor: Vector3;
+    emissiveFactor: Color;
     /**
      * 自发光强度
      */
     emissiveIntensity: number;
-    enableShadow: boolean;
     /**
      * 创建材质
-     * @param options - PBR 材质参数
+     * @param material - effect 材质对象
      */
-    create(options: ModelMaterialPBROptions): void;
+    create(material: Material): void;
     /**
      * 销毁材质
      */
@@ -267,6 +264,7 @@ export declare class PMaterialPBR extends PMaterialBase {
      * @returns 材质特性列表
      */
     getShaderFeatures(): string[];
+    getShaderMacros(): MacroInfo[];
     /**
      * 更新关联的 GE 材质中着色器的 Uniform 数据
      * @param material - GE 材质
@@ -277,11 +275,6 @@ export declare class PMaterialPBR extends PMaterialBase {
      * @returns
      */
     hasBaseColorTexture(): boolean;
-    /**
-     * 是否有基础颜色纹理变换
-     * @returns
-     */
-    hasBaseColorTextureTrans(): boolean;
     /**
      * 设置基础颜色纹理
      * @param val - 纹理
@@ -291,22 +284,17 @@ export declare class PMaterialPBR extends PMaterialBase {
      * 获取基础颜色纹理
      * @returns
      */
-    getBaseColorFactor(): Vector4;
+    getBaseColorFactor(): Color;
     /**
      * 设置基础颜色值
      * @param val - 颜色值
      */
-    setBaseColorFactor(val: Vector4 | spec.vec4): void;
+    setBaseColorFactor(val: Color | Vector4 | spec.vec4): void;
     /**
      * 是否有金属度粗超度纹理
      * @returns
      */
     hasMetallicRoughnessTexture(): boolean;
-    /**
-     * 是否有金属度粗超度纹理坐标变换
-     * @returns
-     */
-    hasMetallicRoughnessTextureTrans(): boolean;
     /**
      * 获取金属度粗超度纹理
      * @returns
@@ -322,11 +310,6 @@ export declare class PMaterialPBR extends PMaterialBase {
      * @returns
      */
     hasNormalTexture(): boolean;
-    /**
-     * 是否有法线纹理坐标变换
-     * @returns
-     */
-    hasNormalTextureTrans(): boolean;
     /**
      * 获取法线纹理
      * @returns
@@ -342,11 +325,6 @@ export declare class PMaterialPBR extends PMaterialBase {
      * @returns
      */
     hasOcclusionTexture(): boolean;
-    /**
-     * 是否有遮挡纹理坐标变换
-     * @returns
-     */
-    hasOcclusionTextureTrans(): boolean;
     /**
      * 获取遮挡纹理
      * @returns
@@ -362,11 +340,6 @@ export declare class PMaterialPBR extends PMaterialBase {
      * @returns
      */
     hasEmissiveTexture(): boolean;
-    /**
-     * 是否有自发光纹理坐标变换
-     * @returns
-     */
-    hasEmissiveTextureTrans(): boolean;
     /**
      * 获取自发光纹理
      * @returns
@@ -378,20 +351,30 @@ export declare class PMaterialPBR extends PMaterialBase {
      */
     setEmissiveTexture(val: Texture): void;
     /**
-     * 是否有自发光颜色，包含强度
+     * 是否有自发光值，包含强度
      * @returns
      */
-    hasEmissiveFactor(): boolean;
+    hasEmissiveValue(): boolean;
     /**
-     * 获取自发光颜色，包含强度
+     * 获取自发光颜色
      * @returns
      */
-    getEmissiveFactor(): Vector3;
+    getEmissiveFactor(): Color;
     /**
      * 设置自发光颜色
      * @param val - 颜色
      */
-    setEmissiveFactor(val: Vector3 | spec.vec3): void;
+    setEmissiveFactor(val: Color | Vector3 | spec.vec3): void;
+    /**
+     * 获取自发光强度
+     * @returns
+     */
+    getEmissiveIntensity(): number;
+    /**
+     * 设置自发光强度
+     * @param val - 强度
+     */
+    setEmissiveIntensity(val: number): void;
 }
 /**
  * 材质类型，包括无光照材质和 PBR 材质
@@ -399,8 +382,7 @@ export declare class PMaterialPBR extends PMaterialBase {
 export type PMaterial = PMaterialUnlit | PMaterialPBR;
 /**
  * 创建插件材质对象
- * @param options - 材质参数
+ * @param material - Effects 材质对象
  * @returns 材质对象
  */
-export declare function createPluginMaterial(options: ModelMaterialOptions): PMaterial;
-export declare function createInternalMaterial(options: {}): {};
+export declare function createPluginMaterial(material: Material): PMaterial;

package/dist/runtime/math.d.ts

@@ -1,5 +1,5 @@
 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 declare const Vector2: typeof math.Vector2, Vector3: typeof math.Vector3, Vector4: typeof math.Vector4, Matrix3: typeof math.Matrix3, Matrix4: typeof math.Matrix4, Color: typeof math.Color, 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;
@@ -7,4 +7,5 @@ export type Vector3 = math.Vector3;
 export type Vector4 = math.Vector4;
 export type Matrix3 = math.Matrix3;
 export type Matrix4 = math.Matrix4;
+export type Color = math.Color;
 export type Quaternion = math.Quaternion;

package/dist/runtime/mesh.d.ts

@@ -1,6 +1,6 @@
-import type { Geometry, Engine, math, VFXItemContent, VFXItem, Renderer } from '@galacean/effects';
-import { spec, Mesh, Material } from '@galacean/effects';
-import type { ModelMeshContent, ModelMaterialOptions, ModelPrimitiveOptions } from '../index';
+import type { Engine, math, VFXItem, Renderer, Geometry } from '@galacean/effects';
+import { spec, Material } from '@galacean/effects';
+import type { ModelMeshComponentData } from '../index';
 import { PEntity } from './object';
 import type { PMaterial } from './material';
 import { Matrix4, Vector3, Box3 } from './math';
@@ -26,11 +26,12 @@ export declare class PMesh extends PEntity {
     /**
      * 父元素
      */
-    parentItem?: VFXItem<VFXItemContent>;
+    parentItem?: VFXItem;
     /**
      * 父元素索引
      */
     parentItemId?: string;
+    rootBoneItem?: VFXItem;
     /**
      * 蒙皮
      */
@@ -42,7 +43,7 @@ export declare class PMesh extends PEntity {
     /**
      * primitive 对象数组
      */
-    primitives: PPrimitive[];
+    subMeshes: PSubMesh[];
     /**
      * 是否隐藏，默认是隐藏
      */
@@ -75,12 +76,12 @@ export declare class PMesh extends PEntity {
      * 构造函数，创建 Mesh 对象，并与所属组件和父元素相关联
      * @param engine - 引擎
      * @param name - 名称
-     * @param meshContent - Mesh 参数
+     * @param meshData - Mesh 参数
      * @param owner - 所属的 Mesh 组件
      * @param parentId - 父元素索引
      * @param parent - 父元素
      */
-    constructor(engine: Engine, name: string, meshContent: ModelMeshContent, owner?: ModelMeshComponent, parentId?: string, parent?: VFXItem<VFXItemContent>);
+    constructor(engine: Engine, name: string, meshData: ModelMeshComponentData, owner?: ModelMeshComponent, parentId?: string, parent?: VFXItem);
     /**
      * 创建 GE 的 Mesh、Geometry 和 Material 对象
      * @param scene - 场景管理器
@@ -115,7 +116,7 @@ export declare class PMesh extends PEntity {
      * @param parentId - 父元素索引
      * @param parentItem - 父 VFX 元素
      */
-    updateParentInfo(parentId: string, parentItem: VFXItem<VFXItemContent>): void;
+    updateParentInfo(parentId: string, parentItem: VFXItem): void;
     /**
      * 根据当前场景状态更新内部材质数据
      * @param scene - 场景管理器
@@ -144,15 +145,11 @@ export declare class PMesh extends PEntity {
      * 是否有蒙皮
      */
     get hasSkin(): boolean;
-    /**
-     * 获取 GE Mesh 数组
-     */
-    get mriMeshs(): Mesh[];
 }
 /**
- * Primitive 类，负责 Sub Mesh相关的功能，支持骨骼动画和 PBR 渲染
+ * PSubMesh 类，负责 Sub Mesh相关的功能，支持骨骼动画和 PBR 渲染
  */
-export declare class PPrimitive {
+export declare class PSubMesh {
     private engine;
     /**
      * 宿主 Mesh，包含了当前 Primitive
@@ -173,10 +170,6 @@ export declare class PPrimitive {
      * 名称
      */
     name: string;
-    /**
-     * GE Mesh
-     */
-    effectsMesh: Mesh;
     /**
      * 渲染优先级
      */
@@ -192,10 +185,10 @@ export declare class PPrimitive {
     constructor(engine: Engine);
     /**
      * 创建 Primitive 对象
-     * @param options - Primitive 参数
+     * @param data - Primitive 参数
      * @param parent - 所属 Mesh 对象
      */
-    create(options: ModelPrimitiveOptions, parent: PMesh): void;
+    create(geometry: Geometry, material: Material, parent: PMesh): void;
     /**
      * 创建 GE Mesh、Geometry 和 Material 对象，用于后面的渲染
      * 着色器部分 Uniform 数据来自 uniformSemantics
@@ -207,6 +200,7 @@ export declare class PPrimitive {
         [k: string]: any;
     }, skybox?: PSkybox): void;
     private getFeatureList;
+    private getMacroList;
     /**
      * 销毁，需要释放创建的 GE 对象
      */
@@ -260,12 +254,12 @@ export declare class PPrimitive {
      * 设置材质
      * @param val - 插件材质对象或材质参数
      */
-    setMaterial(val: PMaterial | ModelMaterialOptions): void;
+    setMaterial(val: PMaterial | Material): void;
     /**
      * 获取 GE 材质
      * @returns
      */
-    getModelMaterial(): Material;
+    getEffectsMaterial(): Material;
     /**
      * 是否无光照材质
      * @returns
@@ -354,4 +348,8 @@ export declare class PGeometry {
      */
     hasWeights(): boolean;
 }
+export interface MacroInfo {
+    name: string;
+    value?: boolean | number;
+}
 export {};

package/dist/runtime/scene.d.ts

@@ -4,7 +4,8 @@ import { PMesh } from './mesh';
 import type { PCamera } from './camera';
 import { PCameraManager } from './camera';
 import { PLight, PLightManager } from './light';
-import { Vector3, Matrix4, Box3 } from './math';
+import type { Vector3 } from './math';
+import { Matrix4, Box3 } from './math';
 import { PSkybox } from './skybox';
 import type { CompositionCache } from './cache';
 import type { PEntity } from './object';

package/dist/runtime/shader-libs/standard-shader-source.d.ts

@@ -10,4 +10,5 @@ export declare namespace StandardShaderSource {
      * @returns 最终代码
      */
     function build(source: string, features: string[], isWebGL2: boolean): string;
+    function getSourceCode(source: string, isWebGL2?: boolean): string;
 }

package/dist/runtime/shader-libs/standard-shader.d.ts

@@ -1,3 +1,4 @@
+import { PMaterialType } from '../common';
 import type { PShaderContext } from '../shader';
 /**
  * 着色器代码生成类
@@ -19,4 +20,11 @@ export declare class StandardShader {
      * @returns
      */
     static getFragmentShaderCode(context: PShaderContext): string;
+    static genVertexShaderCode(materialType: PMaterialType, isWebGL2?: boolean): string;
+    /**
+     * 获取片段着色器代码
+     * @param materialType - 材质类型
+     * @returns
+     */
+    static genFragmentShaderCode(materialType: PMaterialType, isWebGL2?: boolean): string;
 }

package/dist/runtime/skybox.d.ts

@@ -1,6 +1,6 @@
 import type { Mesh, Material, TextureSourceOptions, Engine, Renderer } from '@galacean/effects';
-import { Texture } from '@galacean/effects';
-import type { ModelSkyboxOptions } from '../index';
+import { spec, Texture } from '@galacean/effects';
+import type { ModelSkyboxComponentData, ModelSkyboxOptions } from '../index';
 import { PEntity } from './object';
 import { PMaterialBase } from './material';
 import type { PSceneManager } from './scene';
@@ -68,10 +68,10 @@ export declare class PSkybox extends PEntity {
     /**
      * 构造函数
      * @param name - 名称
-     * @param options - 天空盒参数
+     * @param data - 天空盒参数
      * @param owner - 所属天空盒组件元素
      */
-    constructor(name: string, options: ModelSkyboxOptions, owner?: ModelSkyboxComponent);
+    constructor(name: string, data: ModelSkyboxComponentData, owner?: ModelSkyboxComponent);
     /**
      * 设置 BRDF 查询纹理
      * @param brdfLUT - 纹理
@@ -212,7 +212,7 @@ export interface PSkyboxBaseParams {
     /**
      * 辐射照度系数
      */
-    irradianceCoeffs?: number[][];
+    irradianceCoeffs?: number[];
     /**
      * 高光贴图 Mip 层数
      */
@@ -286,6 +286,17 @@ export declare class PSkyboxCreator {
      * @returns 天空盒选项
      */
     static createSkyboxOptions(engine: Engine, params: PSkyboxParams): Promise<ModelSkyboxOptions>;
+    /**
+     * 创建天空盒选项
+     * @param engine - 引擎
+     * @param params - 天空盒参数
+     * @returns 天空盒选项
+     */
+    static createSkyboxComponentData(params: PSkyboxParams): {
+        imageList: spec.Image[];
+        textureOptionsList: TextureSourceOptions[];
+        component: spec.SkyboxComponentData;
+    };
     /**
      * 创建高光 Cube Map 纹理
      * @param engine - 引擎
@@ -293,13 +304,21 @@ export declare class PSkyboxCreator {
      * @returns 纹理
      */
     static createSpecularCubeMap(engine: Engine, params: PSkyboxParams): Promise<Texture>;
+    static getSpecularCubeMapData(params: PSkyboxParams): {
+        images: spec.Image[];
+        textureOptions: TextureSourceOptions;
+    };
     /**
      * 创建漫反射纹理
      * @param engine - 引擎
      * @param params - 天空盒参数
      * @returns 纹理或未定义
      */
-    static createDiffuseCubeMap(engine: Engine, params: PSkyboxParams): Promise<Texture | undefined>;
+    static createDiffuseCubeMap(engine: Engine, params: PSkyboxParams): Promise<Texture | null>;
+    static getDiffuseCubeMapData(params: PSkyboxParams): {
+        images: spec.Image[];
+        textureOptions: TextureSourceOptions;
+    } | undefined;
     /**
      * 创建天空盒参数
      * @param skyboxType - 天空盒类型