@galacean/effects-plugin-model 1.2.3 → 2.0.0-alpha.1

package/dist/utility/ri-helper.d.ts

@@ -2,24 +2,91 @@ import type { GeometryProps, Engine } from '@galacean/effects';
 import { Mesh } from '@galacean/effects';
 import type { Matrix4 } from '../runtime/math';
 import { Vector2, Vector3 } from '../runtime/math';
+/**
+ * FBO 选项类，负责构造 FBO 创建时的选项信息
+ */
 export declare class FBOOptions {
+    /**
+     * 分辨率
+     */
     resolution: Vector2;
+    /**
+     * 颜色附件列表
+     */
     colorAttachments: object[];
+    /**
+     * 深度附件
+     */
     depthAttachment?: any;
+    /**
+     * 构造函数
+     * @param options - FBO 参数
+     */
     constructor(options: Record<string, any>);
+    /**
+     * 添加深度附件
+     * @param options - 深度附件参数
+     */
     addDepthAttachment(options: Record<string, any>): void;
+    /**
+     * 添加默认深度附件，数据格式是 depth_16_texture
+     */
     addDefaultDepthAttachment(): void;
+    /**
+     * 删除深度附件
+     */
     deleteDepthAttachment(): void;
+    /**
+     * 添加颜色附件
+     * @param options - 颜色附件参数
+     */
     addColorAttachment(options: Record<string, any>): void;
+    /**
+     * 删除颜色附件，按照索引值
+     * @param target - 颜色附件索引值
+     */
     deleteColorAttachment(target: number): void;
+    /**
+     * 获取视口大小
+     */
     get viewport(): [number, number, number, number];
 }
+/**
+ * 包围盒 Mesh 类，负责 3D Mesh 测试包围盒的显示
+ */
 export declare class BoxMesh {
+    /**
+     * core 层 Mesh 对象
+     */
     mesh: Mesh;
+    /**
+     * 构造函数，创建基础 Mesh 对象
+     * @param engine - 引擎
+     * @param priority - 优先级
+     */
     constructor(engine: Engine, priority: number);
+    /**
+     * 更新包围盒着色器 Uniform 数据
+     * @param modelMatrix - 模型矩阵
+     * @param viewProjMatrix - 相机投影矩阵
+     * @param positions - 位置数组
+     * @param lineColor - 线颜色
+     */
     update(modelMatrix: Matrix4, viewProjMatrix: Matrix4, positions: Float32Array, lineColor: Vector3): void;
+    /**
+     * 销毁，需要销毁 Mesh 对象
+     */
     dispose(): void;
+    /**
+     * 获取顶点着色器代码
+     */
     get vertexShader(): string;
+    /**
+     * 获取片段着色器代码
+     */
     get fragmentShader(): string;
+    /**
+     * 获取基础几何体
+     */
     get geometry(): GeometryProps;
 }

package/dist/utility/shader-helper.d.ts

@@ -1,13 +1,68 @@
 import type { PShaderContext, PShaderResults } from '../runtime/shader';
+/**
+ * 获取 PBR 材质着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getPBRPassShaderCode(context: PShaderContext): PShaderResults;
 export declare function getShadowPassShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取天空盒着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getSkyBoxShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取四边形滤波着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getQuadFilterShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取法线可视化着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getNormalVisShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取仅漫反射着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getDiffuseOnlyShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取 Kawase 模糊着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getKawaseBlurShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取简单滤波着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getSimpleFilterShaderCode(context: PShaderContext): PShaderResults;
+/**
+ * 获取高斯模糊着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getGaussianBlurShaderCodeV2(context: PShaderContext): PShaderResults;
+/**
+ * 获取高斯模糊着色器代码
+ * @param context - 着色器上下文
+ * @returns
+ */
 export declare function getGaussianBlurShaderCodeV1(context: PShaderContext): PShaderResults;
+/**
+ * 获取透明效果着色器代码
+ * @param isVertexShader - 是否顶点着色器
+ * @returns
+ */
 export declare function getTransparecyBaseShader(isVertexShader: boolean): string;
+/**
+ * 获取透明效果滤波着色器代码
+ * @param isVertexShader - 是否顶点着色器
+ * @returns
+ */
 export declare function getTransparecyFilterShader(isVertexShader: boolean): string;

package/dist/utility/ts-helper.d.ts

@@ -31,4 +31,10 @@ export declare class TwoStatesSet<T> {
      * @param callbackfn - 删除旧元素的回调
      */
     forRemovedItem(callbackfn: (value: T) => void): void;
+    /**
+     * 遍历当前帧所有的元素
+     *
+     * @param callbackfn - 当前帧元素的回调
+     */
+    forNowItem(callbackfn: (value: T) => void): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-plugin-model",
-  "version": "1.2.3",
+  "version": "2.0.0-alpha.1",
   "description": "Galacean Effects player model plugin",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -33,15 +33,15 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-helper": "1.2.3"
+    "@galacean/effects-helper": "2.0.0-alpha.1"
   },
   "devDependencies": {
     "@vvfx/resource-detection": "0.4.2-alpha.22",
     "@types/hammerjs": "^2.0.45",
     "fpsmeter": "^0.3.1",
     "hammerjs": "^2.0.8",
-    "@galacean/effects": "1.2.3",
-    "@galacean/effects-plugin-editor-gizmo": "1.2.3"
+    "@galacean/effects": "2.0.0-alpha.1",
+    "@galacean/effects-plugin-editor-gizmo": "2.0.0-alpha.1"
   },
   "scripts": {
     "dev": "vite",

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

@@ -1,15 +0,0 @@
-import type { Transform, Composition } from '@galacean/effects';
-import { spec, VFXItem, TimelineComponent } from '@galacean/effects';
-import { ModelTreeItem } from './model-tree-item';
-import type { ModelItemTree, ModelTreeOptions } from '../index';
-export declare class ModelTreeVFXItem extends VFXItem<ModelTreeItem> {
-    options: ModelTreeOptions;
-    timeline?: TimelineComponent;
-    get type(): spec.ItemType;
-    onConstructed(props: ModelItemTree): void;
-    onLifetimeBegin(): void;
-    protected onItemRemoved(composition: Composition, content?: ModelTreeItem | undefined): void;
-    onItemUpdate(dt: number, lifetime: number): void;
-    protected doCreateContent(): ModelTreeItem;
-    getNodeTransform(itemId: string): Transform;
-}

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

@@ -1,28 +0,0 @@
-import type { HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, Composition, math } from '@galacean/effects';
-import { VFXItem, spec, TimelineComponent } from '@galacean/effects';
-import type { ModelItemBounding, ModelItemCamera, ModelItemLight, ModelItemMesh, ModelItemSkybox } from '../index';
-import { PCamera, PLight, PSkybox } from '../runtime';
-import { PMesh } from '../runtime';
-import { Vector3 } from '../runtime/math';
-type Euler = math.Euler;
-export type ModelItem = PMesh | PCamera | PLight | PSkybox;
-export type ModelItemOptions = ModelItemMesh | ModelItemCamera | ModelItemLight | ModelItemSkybox;
-export declare class ModelVFXItem extends VFXItem<ModelItem> {
-    options?: ModelItemOptions;
-    bounding?: ModelItemBounding;
-    timeline?: TimelineComponent;
-    get type(): spec.ItemType;
-    set type(v: spec.ItemType);
-    onConstructed(options: ModelItemOptions): void;
-    handleVisibleChanged(visible: boolean): void;
-    doCreateContent(composition: Composition): PLight | PMesh | PCamera | PSkybox;
-    private overwriteSkyboxFromCache;
-    computeBoundingBox(): ModelItemBounding | undefined;
-    updateTransform(): void;
-    setTransform(position?: Vector3, rotation?: Euler): void;
-    onLifetimeBegin(composition: Composition, content: ModelItem): void;
-    onItemUpdate(dt: number, lifetime: number): void;
-    onItemRemoved(composition: Composition, content?: ModelItem): void;
-    getHitTestParams(force?: boolean): HitTestBoxParams | HitTestSphereParams | HitTestCustomParams | undefined;
-}
-export {};

package/dist/runtime/shadow.d.ts

@@ -1,230 +0,0 @@
-import type { RenderFrame, Mesh, Material, RenderPass, SemanticMap, Renderer, Engine } from '@galacean/effects';
-import { math } from '@galacean/effects';
-import { Matrix4, Vector2, Box3 } from './math';
-import type { PShadowType } from './common';
-import type { PMesh, PPrimitive } from './mesh';
-import { PMaterialBase } from './material';
-import type { PLight } from './light';
-import type { PSceneManager, PSceneStates } from './scene';
-import { FBOOptions } from '../utility/ri-helper';
-import { TwoStatesSet } from '../utility/ts-helper';
-type Box3 = math.Box3;
-export interface PMaterialShadowBaseOptions {
-    name: string;
-    shadowType: PShadowType;
-}
-export declare class PMaterialShadowBase extends PMaterialBase {
-    shadowType: PShadowType;
-    create(options: PMaterialShadowBaseOptions): void;
-    getShaderFeatures(): string[];
-    updateUniforms(material: Material): void;
-}
-export declare class PMaterialShadowBaseTest extends PMaterialBase {
-    shadowType: PShadowType;
-    create(options: PMaterialShadowBaseOptions): void;
-    getShaderFeatures(): string[];
-    updateUniforms(material: Material): void;
-}
-export interface PMaterialShadowFilterOptions {
-    name: string;
-    blurScale: Vector2;
-}
-export declare class PMaterialShadowFilter extends PMaterialBase {
-    blurScale: Vector2;
-    create(options: PMaterialShadowFilterOptions): void;
-    getShaderFeatures(): string[];
-    updateUniforms(material: Material): void;
-}
-/**
- * 阴影初始化选项，包括控制选项和纹理选项
- */
-export interface PShadowInitOptions {
-    /**
-     * 控制相关的参数
-     */
-    enable?: boolean;
-    quality?: 'low' | 'medium' | 'high';
-    softness?: number;
-    /**
-     * 纹理相关的参数
-     */
-    width?: number;
-    height?: number;
-    type?: GLenum;
-    format?: GLenum;
-    filter?: GLenum;
-}
-/**
- * 阴影运行时选项，包括 light 的变换矩阵和柔软度
- */
-export interface PShadowRuntimeOptions {
-    viewProjectionMatrix: Matrix4;
-    softness: number;
-}
-export declare class PShadowManager {
-    /**
-     * 是否启用阴影效果，会根据硬件等情况进行设置
-     */
-    enable: boolean;
-    /**
-     * 阴影质量参数，一般都用 medium
-     */
-    quality: 'low' | 'medium' | 'high';
-    /**
-     * 阴影柔软度，范围[0, 2]
-     */
-    softness: number;
-    /**
-     * 阴影纹理相关参数
-     */
-    width: number;
-    height: number;
-    type: GLenum;
-    format: GLenum;
-    filter: GLenum;
-    /**
-     * shadow map 渲染时 FBO
-     */
-    baseFBOOpts: FBOOptions;
-    /**
-     * shadow map 滤波时 FBO
-     */
-    filterFBOOpts: FBOOptions;
-    /**
-     * 是否激活运行时阴影
-     */
-    runtimeEnable: boolean;
-    /**
-     * 启用阴影效果的 Mesh 列表，来自场景中的 Mesh 列表
-     */
-    meshList: PMesh[];
-    /**
-     * 当前帧启用阴影效果的 Primitive 列表，来自上面的 Mesh 列表
-     */
-    primitiveList: PPrimitive[];
-    viewAABB: Box3;
-    sceneAABB: Box3;
-    shadowAABB: Box3;
-    shadowLight?: PLight;
-    lightView: Matrix4;
-    lightProjection: Matrix4;
-    lightViewProjection: Matrix4;
-    renderer?: Renderer;
-    sceneManager: PSceneManager;
-    xFilterMaterial: PMaterialShadowFilter;
-    yFilterMaterial: PMaterialShadowFilter;
-    basePass?: RenderPass;
-    xFilterPass?: RenderPass;
-    yFilterPass?: RenderPass;
-    /**
-     * Primitive 与 RenderPass 的前一帧与当前帧状态缓存
-     */
-    meshCacheSet: TwoStatesSet<Mesh>;
-    renderPassCacheSet: TwoStatesSet<RenderPass>;
-    engine: Engine;
-    constructor();
-    initial(sceneManager: PSceneManager, options?: PShadowInitOptions): void;
-    build(): void;
-    tick(sceneStates: PSceneStates): void;
-    /**
-     * 更新当前阴影物体的包围盒数据
-     * TODO: 需要注意动画物体的包围盒更新
-     */
-    private updateAABBInfo;
-    private updateLightViewProjection;
-    private updateDirectionalLightViewProjection;
-    private updateSpotLightViewProjection;
-    private getShadowOptions;
-    private updateShadowUniforms;
-    private getShadowLight;
-    /**
-     * 统计场景中启用阴影的 Primitive 数目
-     *
-     * @param sceneManager - Model 场景的场景管理器
-     * @returns 启用阴影的 Primitve 数目
-     */
-    private getShadowPrimitiveCount;
-    /**
-     * 更新阴影渲染时 Pass 中渲染的对象，注意阴影有 3 个渲染 Pass
-     * 开始时 Frame 中没有阴影 Pass，会先添加阴影 Pass
-     *
-     * @param frame - RI 帧对象
-     */
-    updateRenderPass(frame: RenderFrame): void;
-    updateFrameSemantics(map: SemanticMap, addSemantic: boolean): void;
-    /**
-     * 是否启用了阴影效果
-     * 是否有需要启用阴影效果的物体，以及当前硬件是否支持启用阴影效果
-     * @return 是否启用
-     */
-    isEnable(): boolean;
-    /**
-     * 是否有需要渲染的对象，需要先启用阴影
-     * @return 是否有渲染对象
-     */
-    hasRenderObject(): boolean;
-    /**
-     * 在当前 PMesh 列表中，查找需要在阴影 Pass 中渲染的 Primitive
-     *
-     * @returns 当前阴影 Pass 要渲染的 Primitive 列表
-     */
-    getCurrentPrimitiveList(): PPrimitive[];
-    isSupportTextureOptions(): boolean;
-    /**
-     * 根据当前阴影参数生成 BasePass 的 FBO 对象
-     *
-     * @returns BasePass 的 FBO 对象
-     */
-    getBaseFBOOptions(): FBOOptions;
-    /**
-     * 根据当前阴影参数生成 FilterPass 的 FBO 对象
-     *
-     * @returns FilterPass 的 FBO 对象
-     */
-    getFilterFBOOptions(): FBOOptions;
-    /**
-     * 返回 softness 值，并检查是否在指定范围内
-     *
-     * @param options - 阴影相关的初始化参数
-     * @returns 阴影柔软度值
-     */
-    getSoftness(options?: PShadowInitOptions): number;
-    /**
-     * 返回贴图大小，并检查是否在指定范围内
-     *
-     * @param options - 阴影相关的初始化参数
-     * @returns 阴影贴图大小
-     */
-    getTextureSize(options?: PShadowInitOptions): [number, number];
-    /**
-     * 返回纹理类型，并检查是否指定类型
-     *
-     * @param options - 阴影相关的初始化参数
-     * @returns 纹理类型
-     */
-    getTextureType(options?: PShadowInitOptions): GLenum;
-    /**
-     * 返回纹理格式，并检查是否指定格式
-     *
-     * @param options - 阴影相关的初始化参数
-     * @returns 纹理格式
-     */
-    getTextureFormat(options?: PShadowInitOptions): GLenum;
-    /**
-     * 返回纹理滤波格式，并检查是否指定滤波格式
-     *
-     * @param options - 阴影相关的初始化参数
-     * @returns 纹理滤波格式
-     */
-    getTextureFilter(options?: PShadowInitOptions): GLenum;
-    get mainPassUniformSemantics(): {
-        u_ShadowSampler: string;
-    };
-    get basePassName(): string;
-    get xFilterPassName(): string;
-    get yFilterPassName(): string;
-    get xFilterMeshName(): string;
-    get yFilterMeshName(): string;
-    get shadowPassList(): RenderPass[];
-}
-export {};