@galacean/effects-threejs 1.2.1 → 2.0.0-alpha.0

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

@@ -1,4 +1,4 @@
-import type { MaterialProps, Texture, UniformValue, MaterialDestroyOptions, UndefinedAble, Engine, math } from '@galacean/effects-core';
+import type { MaterialProps, Texture, UniformValue, MaterialDestroyOptions, UndefinedAble, Engine, math, GlobalUniforms, Renderer } from '@galacean/effects-core';
 import { Material } from '@galacean/effects-core';
 import * as THREE from 'three';
 type Matrix4 = math.Matrix4;
@@ -28,7 +28,7 @@ export declare class ThreeMaterial extends Material {
      *
      * @param props - 材质属性
      */
-    constructor(engine: Engine, props: MaterialProps);
+    constructor(engine: Engine, props?: MaterialProps);
     /**
      * 设置 uniform 变量值的回调函数
      *
@@ -36,6 +36,7 @@ export declare class ThreeMaterial extends Material {
      * @param value - uniform 变量值
      */
     onSetUniformValue(name: string, value: UniformValue): void;
+    use(render: Renderer, globalUniforms: GlobalUniforms): void;
     /**
      * 移除 uniform 变量值的回调函数
      *
@@ -163,6 +164,7 @@ export declare class ThreeMaterial extends Material {
     isKeywordEnabled(keyword: string): boolean;
     clone(props?: MaterialProps): Material;
     cloneUniforms(sourceMaterial: Material): void;
+    fromData(data: any): 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, VFXItemContent, VFXItem, MessageItem, CompositionProps, CompositionSourceManager } from '@galacean/effects-core';
 import { Composition } from '@galacean/effects-core';
 import type THREE from 'three';
 /**
@@ -50,15 +50,15 @@ export interface CompositionBaseProps {
      */
     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 +68,12 @@ export declare class ThreeComposition extends Composition {
      * 发射器形状缓存 map
      */
     static shape: Record<string, number>;
-    /**
-     * 相机参数
-     */
-    threeCamera: THREE.Camera;
-    constructor(props: CompositionProps, scene: Scene);
-    /**
-     * 开始
-     */
-    createRenderFrame(): void;
+    constructor(props: ThreeCompositionProps, scene: Scene, compositionSourceManager: CompositionSourceManager);
     /**
      * 更新 video texture 数据
      */
     updateVideo(): void;
-    /**
-     * 更新相机
-     */
-    updateCamera(): void;
+    prepareRender(): void;
     /**
      * 获取 render 参数
      *

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

@@ -1,4 +1,5 @@
-import type { EventSystem, JSONValue, SceneLoadOptions, Renderer } from '@galacean/effects-core';
+import type { EventSystem, SceneLoadOptions, Renderer, Composition, SceneLoadType, SceneWithOptionsType } 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,13 @@ export type ThreeDisplayObjectOptions = {
  */
 export declare class ThreeDisplayObject extends THREE.Group {
     compositions: ThreeComposition[];
-    camera: THREE.Camera | undefined;
+    camera?: THREE.Camera;
     renderer: Renderer;
     readonly width: number;
     readonly height: number;
+    assetManager: AssetManager;
+    private baseCompositionIndex;
+    env: string;
     /**
      *
      * @param context
@@ -36,15 +40,18 @@ 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: string | JSONValue, options?: SceneLoadOptions): Promise<void>;
+    loadScene(scene: SceneLoadType, options?: SceneLoadOptions): Promise<Composition>;
+    loadScene(scene: SceneLoadType[], options?: SceneLoadOptions): Promise<Composition[]>;
+    private createComposition;
     /**
      *
      * @param delta
      */
     update(delta: number): void;
 }
+export declare function isSceneWithOptions(scene: any): scene is SceneWithOptionsType;

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

@@ -44,7 +44,7 @@ export declare class ThreeGeometry extends Geometry {
      * 构造函数
      * @param props - geometry 创建参数
      */
-    constructor(engine: Engine, props: GeometryProps);
+    constructor(engine: Engine, props?: GeometryProps);
     /**
      * 获取绘制数量
      */

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;
+    start(): void;
     /**
      * 重建方法
      */
     restore(): void;
+    render(renderer: Renderer): void;
     /**
      * 销毁方法
      *

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

@@ -0,0 +1,41 @@
+import type { Renderer, SpriteItemProps } from '@galacean/effects-core';
+import { SpriteComponent } 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: SpriteItemProps): void;
+    start(): void;
+    render(renderer: Renderer): void;
+    onDestroy(): void;
+}

package/dist/three-texture.d.ts

@@ -1,4 +1,4 @@
-import type { TextureDataType, TextureSourceOptions } from '@galacean/effects-core';
+import type { Engine, TextureDataType, TextureSourceOptions } from '@galacean/effects-core';
 import { Texture, TextureSourceType } from '@galacean/effects-core';
 import * as THREE from 'three';
 /**
@@ -26,7 +26,7 @@ export declare class ThreeTexture extends Texture {
      * @param data - 纹理数据
      * @param options - 纹理选项
      */
-    constructor(data?: TextureDataType, options?: TextureSourceOptions);
+    constructor(engine: Engine, data?: TextureDataType, options?: TextureSourceOptions);
     /**
      * 更新纹理数据
      * @param options - 纹理选项
@@ -55,6 +55,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -72,6 +75,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -90,6 +96,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -107,6 +116,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -124,6 +136,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -144,6 +159,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -160,6 +178,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -177,6 +198,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;
@@ -194,6 +218,9 @@ export declare class ThreeTexture extends Texture {
         name?: string | undefined;
         anisotropic?: number | undefined;
         flipY?: boolean | undefined;
+        /**
+         * THREE 纹理对象
+         */
         premultiplyAlpha?: boolean | undefined;
         keepImageSource?: boolean | undefined;
         format: number | THREE.PixelFormat;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-threejs",
-  "version": "1.2.1",
+  "version": "2.0.0-alpha.0",
   "description": "Galacean Effects runtime threejs plugin for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -43,7 +43,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-core": "1.2.1"
+    "@galacean/effects-core": "2.0.0-alpha.0"
   },
   "devDependencies": {
     "three": "^0.149.0",

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;
-}