@galacean/effects-threejs 0.0.0-experimental-downgrade628-20240904 → 0.0.0-experimental-20250807

package/dist/material/three-material.d.ts

@@ -1,5 +1,5 @@
-import type { MaterialProps, Texture, UniformValue, MaterialDestroyOptions, UndefinedAble, Engine, math } from '@galacean/effects-core';
-import { Material } from '@galacean/effects-core';
+import type { MaterialProps, Texture, UniformValue, MaterialDestroyOptions, UndefinedAble, Engine, GlobalUniforms, Renderer } from '@galacean/effects-core';
+import { math, Material } from '@galacean/effects-core';
 import * as THREE from 'three';
 type Matrix4 = math.Matrix4;
 type Vector2 = math.Vector2;
@@ -7,6 +7,7 @@ type Vector3 = math.Vector3;
 type Vector4 = math.Vector4;
 type Matrix3 = math.Matrix3;
 type Quaternion = math.Quaternion;
+type Color = math.Color;
 /**
  * THREE 抽象材质类
  */
@@ -23,12 +24,13 @@ export declare class ThreeMaterial extends Material {
      * 储存 uniform 变量名及对应的 THREE uniform 对象
      */
     uniforms: Record<string, THREE.Uniform>;
+    macrosDirty: boolean;
     /**
      * 构造函数
      *
      * @param props - 材质属性
      */
-    constructor(engine: Engine, props: MaterialProps);
+    constructor(engine: Engine, props?: MaterialProps);
     /**
      * 设置 uniform 变量值的回调函数
      *
@@ -36,6 +38,7 @@ export declare class ThreeMaterial extends Material {
      * @param value - uniform 变量值
      */
     onSetUniformValue(name: string, value: UniformValue): void;
+    use(render: Renderer, globalUniforms: GlobalUniforms): void;
     /**
      * 移除 uniform 变量值的回调函数
      *
@@ -132,6 +135,11 @@ export declare class ThreeMaterial extends Material {
      */
     get cullFace(): UndefinedAble<number>;
     set cullFace(value: UndefinedAble<number>);
+    /**
+     * 获取颜色写入开关
+     */
+    set colorMask(value: boolean);
+    get colorMask(): boolean;
     getTexture(name: string): Texture | null;
     setTexture(name: string, texture: Texture): void;
     getVector4Array(name: string): number[];
@@ -148,6 +156,8 @@ export declare class ThreeMaterial extends Material {
     setVector3(name: string, value: Vector3): void;
     getVector4(name: string): Vector4 | null;
     setVector4(name: string, value: Vector4): void;
+    getColor(name: string): Color | null;
+    setColor(name: string, value: Color): void;
     getQuaternion(name: string): Quaternion | null;
     setQuaternion(name: string, value: Quaternion): void;
     getFloat(name: string): number | null;
@@ -158,11 +168,12 @@ export declare class ThreeMaterial extends Material {
     setInt(name: string, value: number): void;
     hasUniform(name: string): boolean;
     private setUniform;
-    enableKeyword(keyword: string): void;
-    disableKeyword(keyword: string): void;
-    isKeywordEnabled(keyword: string): boolean;
+    enableMacro(keyword: string, value?: boolean | number): void;
+    disableMacro(keyword: string): void;
+    isMacroEnabled(keyword: string): boolean;
     clone(props?: MaterialProps): Material;
     cloneUniforms(sourceMaterial: Material): void;
+    fromData(data: unknown): void;
     dispose(destroyOptions?: MaterialDestroyOptions): void;
 }
 export {};

package/dist/three-composition.d.ts

@@ -1,4 +1,4 @@
-import type { Scene, ShaderLibrary, Transform, MeshRendererOptions, EventSystem, VFXItemContent, VFXItem, MessageItem, CompositionProps } from '@galacean/effects-core';
+import type { Scene, ShaderLibrary, Transform, MeshRendererOptions, EventSystem, CompositionProps } from '@galacean/effects-core';
 import { Composition } from '@galacean/effects-core';
 import type THREE from 'three';
 /**
@@ -28,37 +28,16 @@ export interface CompositionBaseProps {
      * Shader 库
      */
     shaderLibrary?: ShaderLibrary;
-    /**
-     * end 状态监听函数
-     *
-     * @param composition - composition 对象
-     * @returns
-     */
-    onEnd?: (composition: Composition) => void;
-    /**
-     * 交互元素监听函数
-     *
-     * @param item
-     * @returns
-     */
-    onMessageItem?: (item: MessageItem) => void;
-    /**
-     * player 暂停监听函授
-     *
-     * @param item
-     * @returns
-     */
-    onPlayerPause?: (item: VFXItem<VFXItemContent>) => void;
 }
-export interface ThreeCompositionProps extends CompositionBaseProps {
+export interface ThreeCompositionProps extends CompositionProps {
     /**
-     * 指定合成名字
+     * Three.js 中的相机对象
      */
-    compositionName?: string;
+    threeCamera?: THREE.Camera;
     /**
-     * 是否多合成
+     * Three.js 中的 Group 对象
      */
-    multipleCompositions?: boolean;
+    threeGroup?: THREE.Group;
 }
 /**
  * composition 抽象类的实现
@@ -68,23 +47,8 @@ export declare class ThreeComposition extends Composition {
      * 发射器形状缓存 map
      */
     static shape: Record<string, number>;
-    /**
-     * 相机参数
-     */
-    threeCamera: THREE.Camera;
-    constructor(props: CompositionProps, scene: Scene);
-    /**
-     * 开始
-     */
-    createRenderFrame(): void;
-    /**
-     * 更新 video texture 数据
-     */
-    updateVideo(): void;
-    /**
-     * 更新相机
-     */
-    updateCamera(): void;
+    constructor(props: ThreeCompositionProps, scene: Scene);
+    prepareRender(): void;
     /**
      * 获取 render 参数
      *

package/dist/three-display-object.d.ts

@@ -1,4 +1,5 @@
-import type { EventSystem, SceneLoadOptions, Renderer, SceneType } from '@galacean/effects-core';
+import type { EventSystem, SceneLoadOptions, Renderer, Composition, Scene } from '@galacean/effects-core';
+import { AssetManager } from '@galacean/effects-core';
 import * as THREE from 'three';
 import { ThreeComposition } from './three-composition';
 export type ThreeDisplayObjectOptions = {
@@ -22,10 +23,14 @@ export type ThreeDisplayObjectOptions = {
  */
 export declare class ThreeDisplayObject extends THREE.Group {
     compositions: ThreeComposition[];
-    camera: THREE.Camera | undefined;
+    camera?: THREE.Camera;
     renderer: Renderer;
+    assetManager: AssetManager;
+    env: string;
     readonly width: number;
     readonly height: number;
+    private baseCompositionIndex;
+    private assetService;
     /**
      *
      * @param context
@@ -36,12 +41,16 @@ export declare class ThreeDisplayObject extends THREE.Group {
      */
     get currentComposition(): ThreeComposition;
     /**
-     * 异步加载动画资源并初始化合成
-     * @param url - URL 或者通过 URL 请求的 JSONObject
+     * 加载动画资源
+     * @param scene - 一个或一组 URL 或者通过 URL 请求的 JSONObject 或者 Scene 对象
      * @param options - 加载可选参数
      * @returns
      */
-    loadScene(url: SceneType, options?: SceneLoadOptions): Promise<void>;
+    loadScene(scene: Scene.LoadType, options?: SceneLoadOptions): Promise<Composition>;
+    loadScene(scene: Scene.LoadType[], options?: SceneLoadOptions): Promise<Composition[]>;
+    private createComposition;
+    pause(): void;
+    resume(): void;
     /**
      *
      * @param delta

package/dist/three-engine.d.ts

@@ -1,4 +1,18 @@
+import type { Composition } from '@galacean/effects-core';
 import { Engine } from '@galacean/effects-core';
+import type * as THREE from 'three';
+export interface ThreeEngineOptions {
+    threeCamera?: THREE.Camera;
+    composition: Composition;
+    threeGroup: THREE.Group;
+}
+/**
+ * 挂载着合成需要的全局对象等
+ */
 export declare class ThreeEngine extends Engine {
+    threeCamera?: THREE.Camera;
+    threeGroup: THREE.Group;
+    composition: Composition;
     constructor(gl: WebGL2RenderingContext | WebGLRenderingContext);
+    setOptions(threeEngineOptions: ThreeEngineOptions): void;
 }

package/dist/three-geometry.d.ts

@@ -1,4 +1,4 @@
-import type { Engine, GeometryProps, spec } from '@galacean/effects-core';
+import type { Engine, GeometryProps, SkinProps, spec } from '@galacean/effects-core';
 import { Geometry } from '@galacean/effects-core';
 import * as THREE from 'three';
 /**
@@ -44,7 +44,7 @@ export declare class ThreeGeometry extends Geometry {
      * 构造函数
      * @param props - geometry 创建参数
      */
-    constructor(engine: Engine, props: GeometryProps);
+    constructor(engine: Engine, props?: GeometryProps);
     /**
      * 获取绘制数量
      */
@@ -139,6 +139,12 @@ export declare class ThreeGeometry extends Geometry {
      * @returns 返回绘制数量
      */
     getDrawCount(): number;
+    /**
+     * 获取蒙皮数据
+     *
+     * @returns 返回蒙皮数据
+     */
+    getSkinProps(): SkinProps;
     /**
      * 销毁方法
      *

package/dist/three-mesh.d.ts

@@ -1,4 +1,4 @@
-import type { Geometry, Material, MaterialDestroyOptions, MeshDestroyOptions, GeometryMeshProps, Sortable, Engine } from '@galacean/effects-core';
+import type { Geometry, Material, MaterialDestroyOptions, MeshDestroyOptions, GeometryMeshProps, Sortable, Engine, Renderer } from '@galacean/effects-core';
 import { DestroyOptions, Mesh } from '@galacean/effects-core';
 import * as THREE from 'three';
 /**
@@ -13,7 +13,7 @@ export declare class ThreeMesh extends Mesh implements Sortable {
      * 构造函数
      * @param props - mesh 创建参数
      */
-    constructor(engine: Engine, props: GeometryMeshProps);
+    constructor(engine: Engine, props?: GeometryMeshProps);
     /**
      * 设置 mesh 的渲染顺序
      *
@@ -49,10 +49,12 @@ export declare class ThreeMesh extends Mesh implements Sortable {
      * @param destroy 销毁参数
      */
     setMaterial(mtl: Material, destroy?: MaterialDestroyOptions | DestroyOptions.keep): void;
+    onStart(): void;
     /**
      * 重建方法
      */
     restore(): void;
+    render(renderer: Renderer): void;
     /**
      * 销毁方法
      *

package/dist/three-sprite-component.d.ts

@@ -0,0 +1,41 @@
+import type { Renderer } from '@galacean/effects-core';
+import { SpriteComponent, spec } from '@galacean/effects-core';
+import * as THREE from 'three';
+export declare class ThreeSpriteComponent extends SpriteComponent {
+    threeMesh: THREE.Mesh | THREE.LineSegments;
+    /**
+     * 设置 mesh 的渲染顺序
+     *
+     * @param v - 顺序 index
+     */
+    set priority(v: number);
+    /**
+     * 获取 mesh 的渲染顺序
+     */
+    get priority(): number;
+    /**
+     * TODO: 待移除
+     * 设置 mesh 可见性
+     *
+     * @param val - 可见性开关
+     */
+    setVisible(val: boolean): void;
+    /**
+     * TODO: 待移除
+     * 获取 mesh 的可见性
+     *
+     * @returns
+     */
+    getVisible(): boolean;
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /**
+     * 销毁方法
+     *
+     */
+    dispose(): void;
+    fromData(data: spec.SpriteComponentData): void;
+    onStart(): void;
+    render(renderer: Renderer): void;
+    onDestroy(): void;
+}

package/dist/three-text-component.d.ts

@@ -0,0 +1,18 @@
+import type { Engine } from '@galacean/effects-core';
+import { spec, TextComponentBase } from '@galacean/effects-core';
+import { ThreeSpriteComponent } from './three-sprite-component';
+export interface ThreeTextComponent extends TextComponentBase {
+}
+/**
+ * @since 2.0.0
+ */
+export declare class ThreeTextComponent extends ThreeSpriteComponent {
+    isDirty: boolean;
+    canvas: HTMLCanvasElement;
+    context: CanvasRenderingContext2D | null;
+    constructor(engine: Engine, props?: spec.TextContent);
+    onUpdate(dt: number): void;
+    fromData(data: spec.SpriteComponentData): void;
+    updateWithOptions(options: spec.TextContentOptions): void;
+    updateTexture(flipY?: boolean): void;
+}

package/dist/three-texture.d.ts

@@ -1,5 +1,5 @@
-import type { TextureDataType, TextureSourceOptions } from '@galacean/effects-core';
-import { Texture, TextureSourceType } from '@galacean/effects-core';
+import type { Engine, TextureDataType, TextureSourceOptions } from '@galacean/effects-core';
+import { Texture } from '@galacean/effects-core';
 import * as THREE from 'three';
 /**
  * THREE 抽象纹理类
@@ -26,183 +26,26 @@ export declare class ThreeTexture extends Texture {
      * @param data - 纹理数据
      * @param options - 纹理选项
      */
-    constructor(data?: TextureDataType, options?: TextureSourceOptions);
+    constructor(engine: Engine, data?: TextureDataType, options?: TextureSourceOptions);
     /**
      * 更新纹理数据
      * @param options - 纹理选项
      */
     updateSource(options: TextureSourceOptions): void;
-    /**
-     * 开始更新视频数据
-     *
-     */
-    startVideo(): Promise<void>;
     /**
      * 组装纹理选项
      * @param options - 纹理选项
      * @returns 组装后的纹理选项
      */
-    assembleOptions(options: TextureSourceOptions): {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.image | undefined;
-        image: HTMLImageElement | HTMLCanvasElement;
-        target: number;
-        generateMipmap?: boolean | undefined;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.data | undefined;
-        data: TextureDataType;
-        target: number;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.video | undefined;
-        video: HTMLVideoElement;
-        target: number;
-        generateMipmap?: boolean | undefined;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.mipmaps | undefined;
-        mipmaps: ((HTMLImageElement | HTMLCanvasElement) | TextureDataType)[];
-        target: number;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.compressed | undefined;
-        mipmaps: TextureDataType[];
-        target: number;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType: TextureSourceType.framebuffer;
-        data?: {
-            width: number;
-            height: number;
-        } | undefined;
-        target: number;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.none | undefined;
-        target: number;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType: TextureSourceType.data | TextureSourceType.image;
-        target: 34067;
-        cube: import("@galacean/effects-core").TextureSourceCubeData;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    } | {
-        minFilter: THREE.TextureFilter;
-        magFilter: THREE.TextureFilter;
-        wrapS: THREE.Wrapping;
-        wrapT: THREE.Wrapping;
-        sourceType?: TextureSourceType.mipmaps | undefined;
-        mipmaps: import("@galacean/effects-core").TextureSourceCubeData[];
-        target: 34067;
-        sourceFrom?: import("@galacean/effects-core").TextureFactorySourceFrom | undefined;
-        name?: string | undefined;
-        anisotropic?: number | undefined;
-        flipY?: boolean | undefined;
-        premultiplyAlpha?: boolean | undefined;
-        keepImageSource?: boolean | undefined;
-        format: number | THREE.PixelFormat;
-        internalFormat?: number | undefined;
-        type: number | THREE.TextureDataType;
-    };
+    assembleOptions(options: TextureSourceOptions): TextureSourceOptions;
     /**
      * 释放纹理占用的内存
      */
     dispose(): void;
+    /**
+     * 通过图层设置创建贴图
+     * @param data - 图层设置
+     */
+    fromData(data: any): void;
     private createTextureByType;
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@galacean/effects-threejs",
-  "version": "0.0.0-experimental-downgrade628-20240904",
+  "version": "0.0.0-experimental-20250807",
   "description": "Galacean Effects runtime threejs plugin for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
-  "brower": "./dist/index.min.js",
+  "browser": "./dist/index.min.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
@@ -43,7 +43,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-core": "0.0.0-experimental-downgrade628-20240904"
+    "@galacean/effects-core": "0.0.0-experimental-20250807"
   },
   "devDependencies": {
     "three": "^0.149.0",
@@ -53,7 +53,7 @@
     "prebuild": "pnpm clean",
     "build": "pnpm build:declaration && pnpm build:module",
     "build:module": "rollup -c",
-    "build:declaration": "tsc -d --declarationDir dist --emitDeclarationOnly",
-    "clean": "rimraf dist && rimraf '*+(.tsbuildinfo)'"
+    "build:declaration": "tsc -d --emitDeclarationOnly",
+    "clean": "rimraf dist && rimraf \"*+(.tsbuildinfo)\""
   }
 }

package/dist/three-render-frame.d.ts

@@ -1,57 +0,0 @@
-import type { Mesh, RenderPass, Texture, RenderFrameOptions } from '@galacean/effects-core';
-import { RenderFrame } from '@galacean/effects-core';
-import * as THREE from 'three';
-/**
- * runtime 中对渲染中的一帧的流程管理对象
- * THREE 对此抽象类的实现
- */
-export declare class ThreeRenderFrame extends RenderFrame {
-    group: THREE.Group;
-    threeCamera: THREE.Camera | undefined;
-    constructor(options: RenderFrameOptions);
-    /**
-     * 设置 pass 数组
-     *
-     * @param passes - pass 数组
-     */
-    setRenderPasses(passes: RenderPass[]): void;
-    /**
-     * 添加 render pass
-     *
-     * @param pass - render pass 对象
-     */
-    addRenderPass(pass: RenderPass): void;
-    /**
-     * 创建资源（滤镜元素会用到）
-     */
-    createResource(): void;
-    /**
-     * 创建默认 mesh（滤镜元素会用到）
-     *
-     * @param semantics - mesh 创建参数
-     */
-    createCopyMesh(semantics?: {
-        tex?: string;
-        size?: string;
-        blend?: boolean;
-        depthTexture?: Texture;
-    }): Mesh;
-    /**
-     * 添加 mesh 到默认 render pass 中
-     *
-     * @param mesh - mesh 对象
-     */
-    addMeshToDefaultRenderPass(mesh: Mesh): void;
-    /**
-     * 从默认 render pass 删除 mesh
-     *
-     * @param mesh - mesh 对象
-     */
-    removeMeshFromDefaultRenderPass(mesh: Mesh): void;
-    updateMatrix(): void;
-    updateUniform(): void;
-    /**
-     * 主要用来做 group 和 composition 的清理
-     */
-    dispose(): void;
-}