@galacean/effects-threejs 0.0.0-experimental-downgrade624-20240904

package/dist/material/index.d.ts

@@ -0,0 +1,2 @@
+export * from './three-material';
+export * from './three-material-util';

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

@@ -0,0 +1,30 @@
+import type { UniformValue } from '@galacean/effects-core';
+import * as THREE from 'three';
+/**
+ * WebGL 中和 blend 相关参数到 THREE 的常量映射表
+ */
+export declare const CONSTANT_MAP_BLEND: Record<string, THREE.BlendingDstFactor>;
+/**
+ * WebGL 中和 stencil 相关参数到 THREE 的常量映射表
+ */
+export declare const CONSTANT_MAP_STENCIL_FUNC: Record<string, THREE.StencilFunc>;
+/**
+ * WebGL 中和 stencil 相关测试结果参数到 THREE 的常量映射表
+ */
+export declare const CONSTANT_MAP_STENCIL_OP: Record<string, THREE.StencilOp>;
+/**
+ * WebGL 中和 depth 相关参数到 THREE 的常量映射表
+ */
+export declare const CONSTANT_MAP_DEPTH: Record<string, THREE.DepthModes>;
+/**
+ * THREE 中自定义 shader 在 Galacean Effects 中的设置工具类方法
+ *
+ * @param uniforms - uniform 缓存以及 THREE 的 material 的 uniform 对象
+ * @param name - uniform 名称
+ * @param value - uniform 值
+ */
+export declare function setUniformValue(uniforms: Record<string, any>, name: string, value: UniformValue | THREE.Matrix4): void;
+/**
+ * 必须初始化的 uniform 的 map 对象（THREE 必须在初始化的时候赋值）
+ */
+export declare const TEXTURE_UNIFORM_MAP: string[];

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

@@ -0,0 +1,168 @@
+import type { MaterialProps, Texture, UniformValue, MaterialDestroyOptions, UndefinedAble, Engine, math } from '@galacean/effects-core';
+import { Material } from '@galacean/effects-core';
+import * as THREE from 'three';
+type Matrix4 = math.Matrix4;
+type Vector2 = math.Vector2;
+type Vector3 = math.Vector3;
+type Vector4 = math.Vector4;
+type Matrix3 = math.Matrix3;
+type Quaternion = math.Quaternion;
+/**
+ * THREE 抽象材质类
+ */
+export declare class ThreeMaterial extends Material {
+    /**
+     * 储存纹理类型的 uniform 值
+     */
+    textures: Record<string, Texture>;
+    /**
+     * THREE 原始着色器材质对象
+     */
+    material: THREE.RawShaderMaterial;
+    /**
+     * 储存 uniform 变量名及对应的 THREE uniform 对象
+     */
+    uniforms: Record<string, THREE.Uniform>;
+    /**
+     * 构造函数
+     *
+     * @param props - 材质属性
+     */
+    constructor(engine: Engine, props: MaterialProps);
+    /**
+     * 设置 uniform 变量值的回调函数
+     *
+     * @param name - uniform 变量名
+     * @param value - uniform 变量值
+     */
+    onSetUniformValue(name: string, value: UniformValue): void;
+    /**
+     * 移除 uniform 变量值的回调函数
+     *
+     * @param name - uniform 变量名
+     */
+    onRemoveUniformValue(name: string): void;
+    /**
+     * 获取混合模式
+     */
+    get blending(): UndefinedAble<boolean>;
+    set blending(blending: UndefinedAble<boolean>);
+    /**
+     * 获取混合函数
+     */
+    get blendFunction(): UndefinedAble<[blendSrc: number, blendDst: number, blendSrcAlpha: number, blendDstAlpha: number]>;
+    set blendFunction(func: UndefinedAble<[blendSrc: number, blendDst: number, blendSrcAlpha: number, blendDstAlpha: number]>);
+    /**
+     * 获取混合方程式
+     */
+    get blendEquation(): UndefinedAble<[rgb: number, alpha: number]>;
+    set blendEquation(equation: UndefinedAble<[rgb: number, alpha: number]>);
+    /**
+     * 获取深度测试结果
+     */
+    get depthTest(): UndefinedAble<boolean>;
+    set depthTest(value: UndefinedAble<boolean>);
+    /**
+     * 获取深度缓冲区结果
+     */
+    get depthMask(): UndefinedAble<boolean>;
+    set depthMask(value: UndefinedAble<boolean>);
+    /**
+     * 获取深度函数
+     */
+    get depthFunc(): UndefinedAble<number>;
+    set depthFunc(value: UndefinedAble<number>);
+    /**
+     * 获取多边形偏移开关
+     */
+    get polygonOffsetFill(): UndefinedAble<boolean>;
+    set polygonOffsetFill(value: UndefinedAble<boolean>);
+    /**
+     * 获取多边形偏移
+     */
+    get polygonOffset(): UndefinedAble<[number, number]>;
+    set polygonOffset(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取 alpha 抖动
+     */
+    get sampleAlphaToCoverage(): UndefinedAble<boolean>;
+    set sampleAlphaToCoverage(value: UndefinedAble<boolean>);
+    /**
+     * 获取模板测试开关
+     */
+    get stencilTest(): UndefinedAble<boolean>;
+    set stencilTest(value: UndefinedAble<boolean>);
+    /**
+     * 获取模板缓冲区
+     */
+    get stencilMask(): UndefinedAble<[number, number]>;
+    set stencilMask(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取模板测试参考值
+     */
+    get stencilRef(): UndefinedAble<[number, number]>;
+    set stencilRef(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取模版函数
+     */
+    get stencilFunc(): UndefinedAble<[number, number]>;
+    set stencilFunc(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取模板测试失败后参数
+     */
+    get stencilOpFail(): UndefinedAble<[number, number]>;
+    set stencilOpFail(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取模版测试通过深度测试失败后参数
+     */
+    get stencilOpZFail(): UndefinedAble<[number, number]>;
+    set stencilOpZFail(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取模版测试通过并设置深度值参数
+     */
+    get stencilOpZPass(): UndefinedAble<[number, number]>;
+    set stencilOpZPass(value: UndefinedAble<[number, number]>);
+    /**
+     * 获取剔除开关
+     */
+    get culling(): UndefinedAble<boolean>;
+    set culling(value: UndefinedAble<boolean>);
+    /**
+     * 获取剔除面
+     */
+    get cullFace(): UndefinedAble<number>;
+    set cullFace(value: UndefinedAble<number>);
+    getTexture(name: string): Texture | null;
+    setTexture(name: string, texture: Texture): void;
+    getVector4Array(name: string): number[];
+    setVector4Array(name: string, array: Vector4[]): void;
+    getMatrixArray(name: string): number[] | null;
+    setMatrixArray(name: string, array: Matrix4[]): void;
+    setMatrixNumberArray(name: string, array: number[]): void;
+    getMatrix(name: string): Matrix4 | null;
+    setMatrix(name: string, value: Matrix4): void;
+    setMatrix3(name: string, value: Matrix3): void;
+    getVector2(name: string): Vector2 | null;
+    setVector2(name: string, value: Vector2): void;
+    getVector3(name: string): Vector3;
+    setVector3(name: string, value: Vector3): void;
+    getVector4(name: string): Vector4 | null;
+    setVector4(name: string, value: Vector4): void;
+    getQuaternion(name: string): Quaternion | null;
+    setQuaternion(name: string, value: Quaternion): void;
+    getFloat(name: string): number | null;
+    setFloat(name: string, value: number): void;
+    getFloats(name: string): number[] | null;
+    setFloats(name: string, value: number[]): void;
+    getInt(name: string): number | null;
+    setInt(name: string, value: number): void;
+    hasUniform(name: string): boolean;
+    private setUniform;
+    enableKeyword(keyword: string): void;
+    disableKeyword(keyword: string): void;
+    isKeywordEnabled(keyword: string): boolean;
+    clone(props?: MaterialProps): Material;
+    cloneUniforms(sourceMaterial: Material): void;
+    dispose(destroyOptions?: MaterialDestroyOptions): void;
+}
+export {};

package/dist/three-composition.d.ts

@@ -0,0 +1,94 @@
+import type { Scene, ShaderLibrary, Transform, MeshRendererOptions, EventSystem, VFXItemContent, VFXItem, MessageItem, CompositionProps } from '@galacean/effects-core';
+import { Composition } from '@galacean/effects-core';
+import type THREE from 'three';
+/**
+ * 基础 composition 参数
+ */
+export interface CompositionBaseProps {
+    /**
+     * 画布宽度
+     */
+    width?: number;
+    /**
+     * 画布高度
+     */
+    height?: number;
+    event?: EventSystem;
+    /**
+     * 播放速度
+     */
+    speed?: number;
+    reusable?: boolean;
+    baseRenderOrder?: number;
+    /**
+     * 合成基础变换
+     */
+    transform?: Transform;
+    /**
+     * 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 {
+    /**
+     * 指定合成名字
+     */
+    compositionName?: string;
+    /**
+     * 是否多合成
+     */
+    multipleCompositions?: boolean;
+}
+/**
+ * composition 抽象类的实现
+ */
+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;
+    /**
+     * 获取 render 参数
+     *
+     * @returns
+     */
+    getRendererOptions(): MeshRendererOptions;
+}

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

@@ -0,0 +1,50 @@
+import type { EventSystem, SceneLoadOptions, Renderer, SceneType } from '@galacean/effects-core';
+import * as THREE from 'three';
+import { ThreeComposition } from './three-composition';
+export type ThreeDisplayObjectOptions = {
+    width: number;
+    height: number;
+    event?: EventSystem;
+    camera?: THREE.Camera;
+};
+/**
+ *
+ * @example
+ * ``` ts
+ * const renderer = new THREE.WebGLRenderer({...});
+ * const scene = new THREE.Scene();
+ * const { width, height } = renderer.domElement.getBoundingClientRect();
+ * const displayObject = new ThreeDisplayObject(renderer.getContext(), { width, height });
+ *
+ * await displayObject.loadScene(json);
+ * scene.add(displayObject);
+ * ```
+ */
+export declare class ThreeDisplayObject extends THREE.Group {
+    compositions: ThreeComposition[];
+    camera: THREE.Camera | undefined;
+    renderer: Renderer;
+    readonly width: number;
+    readonly height: number;
+    /**
+     *
+     * @param context
+     */
+    constructor(context: WebGLRenderingContext | WebGL2RenderingContext, options: ThreeDisplayObjectOptions);
+    /**
+     * 获取当前播放合成，如果是多个合成同时播放，返回第一个合成
+     */
+    get currentComposition(): ThreeComposition;
+    /**
+     * 异步加载动画资源并初始化合成
+     * @param url - URL 或者通过 URL 请求的 JSONObject
+     * @param options - 加载可选参数
+     * @returns
+     */
+    loadScene(url: SceneType, options?: SceneLoadOptions): Promise<void>;
+    /**
+     *
+     * @param delta
+     */
+    update(delta: number): void;
+}

package/dist/three-engine.d.ts

@@ -0,0 +1,4 @@
+import { Engine } from '@galacean/effects-core';
+export declare class ThreeEngine extends Engine {
+    constructor(gl: WebGL2RenderingContext | WebGLRenderingContext);
+}

package/dist/three-geometry.d.ts

@@ -0,0 +1,150 @@
+import type { Engine, GeometryProps, spec } from '@galacean/effects-core';
+import { Geometry } from '@galacean/effects-core';
+import * as THREE from 'three';
+/**
+ * THREE 中 attribute info 接口
+ */
+interface ThreeAttributeWithType {
+    /**
+     * THREE 中 attribute 对象
+     */
+    attribute: THREE.InterleavedBufferAttribute;
+    /**
+     * attribute 类型
+     */
+    type: number;
+    /**
+     * 共享或单独的 buffer
+     */
+    buffer: THREE.InterleavedBuffer;
+    /**
+     * 数据长度
+     */
+    dataLength: number;
+}
+/**
+ * THREE 中的 geometry 的抽象实现类
+ */
+export declare class ThreeGeometry extends Geometry {
+    /**
+     * geometry 对象
+     */
+    geometry: THREE.BufferGeometry;
+    /**
+     * 记录顶点属性信息用于缓存
+     */
+    attributes: Record<string, ThreeAttributeWithType>;
+    /**
+     * geometry 绘制模式
+     */
+    readonly mode: GLenum;
+    private destroyed;
+    private attributesName;
+    /**
+     * 构造函数
+     * @param props - geometry 创建参数
+     */
+    constructor(engine: Engine, props: GeometryProps);
+    /**
+     * 获取绘制数量
+     */
+    get drawCount(): number;
+    /**
+     * 设置绘制数量
+     */
+    set drawCount(val: number);
+    /**
+     * 获取绘制起点
+     */
+    get drawStart(): number;
+    /**
+     * 设置绘制起点
+     */
+    set drawStart(val: number);
+    /**
+     * 获取 attribute 数据
+     *
+     * @param name - attribute 名称
+     * @returns 返回 attribute 数据，如果为空返回 undefined
+     */
+    getAttributeData(name: string): spec.TypedArray | undefined;
+    /**
+     * 设置 attribute 数据
+     *
+     * @param name - attribute 名称
+     * @param data - attribute 数据
+     * @returns
+     */
+    setAttributeData(name: string, data: spec.TypedArray): void;
+    /**
+     * 设置可变的 attribute 数据
+     *
+     * @param name - attribute 名称
+     * @param dataOffset - 数据偏移
+     * @param data - 数据内容
+     * @returns
+     */
+    setAttributeSubData(name: string, dataOffset: number, data: spec.TypedArray): void;
+    /**
+     * 获取 attribute 数据步长
+     *
+     * @param name - attribute名称
+     * @returns 返回步长值
+     */
+    getAttributeStride(name: string): number;
+    /**
+     * 获取用到的所有 attribute 名称
+     * @returns 返回名称数组
+     */
+    getAttributeNames(): string[];
+    /**
+     * 获取 index attribute 数据
+     * @returns 返回数据，如果为空返回 undefined
+     */
+    getIndexData(): spec.TypedArray | undefined;
+    /**
+     * 设置 index attribute 数据
+     *
+     * @param data - index 数据
+     */
+    setIndexData(data?: spec.TypedArray): void;
+    /**
+     * 设置偏移 index 数据
+     *
+     * @param offset - 数据偏移量
+     * @param data - 数据内容
+     */
+    setIndexSubData(offset: number, data: spec.TypedArray): void;
+    /**
+     * 设置绘制偏移
+     *
+     * @param start - 绘制偏移
+     */
+    setDrawStart(start: number): void;
+    /**
+     * 获取绘制偏移
+     *
+     * @returns 返回绘制移
+     */
+    getDrawStart(): number;
+    /**
+     * 设置绘制数量
+     *
+     * @param count - 绘制数量
+     */
+    setDrawCount(count: number): void;
+    /**
+     * 获取绘制数量
+     *
+     * @returns 返回绘制数量
+     */
+    getDrawCount(): number;
+    /**
+     * 销毁方法
+     *
+     * @returns
+     */
+    dispose(): void;
+    private setAttributeType;
+}
+export {};

package/dist/three-mesh.d.ts

@@ -0,0 +1,62 @@
+import type { Geometry, Material, MaterialDestroyOptions, MeshDestroyOptions, GeometryMeshProps, Sortable, Engine } from '@galacean/effects-core';
+import { DestroyOptions, Mesh } from '@galacean/effects-core';
+import * as THREE from 'three';
+/**
+ * mesh 抽象类的 THREE 实现
+ */
+export declare class ThreeMesh extends Mesh implements Sortable {
+    /**
+     * mesh 对象
+     */
+    mesh: THREE.Mesh | THREE.LineSegments;
+    /**
+     * 构造函数
+     * @param props - mesh 创建参数
+     */
+    constructor(engine: Engine, props: GeometryMeshProps);
+    /**
+     * 设置 mesh 的渲染顺序
+     *
+     * @param v - 顺序 index
+     */
+    set priority(v: number);
+    /**
+     * 获取 mesh 的渲染顺序
+     */
+    get priority(): number;
+    /**
+     * 设置 mesh 可见性
+     *
+     * @param val - 可见性开关
+     */
+    setVisible(val: boolean): void;
+    /**
+     * 获取 mesh 的可见性
+     *
+     * @returns
+     */
+    getVisible(): boolean;
+    /**
+     * 获取 mesh 中的首个 geometry
+     *
+     * @returns 返回 geometry 对象
+     */
+    firstGeometry(): Geometry;
+    /**
+     * 设置 material
+     *
+     * @param mtl - material 对象
+     * @param destroy 销毁参数
+     */
+    setMaterial(mtl: Material, destroy?: MaterialDestroyOptions | DestroyOptions.keep): void;
+    /**
+     * 重建方法
+     */
+    restore(): void;
+    /**
+     * 销毁方法
+     *
+     * @param options - 销毁参数
+     */
+    dispose(options?: MeshDestroyOptions): void;
+}

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

@@ -0,0 +1,57 @@
+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;
+}

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

@@ -0,0 +1,42 @@
+import type { Texture, RenderPassOptions, RenderPassAttachmentOptions, RenderPassDepthStencilAttachment, RenderPassDestroyOptions, spec } from '@galacean/effects-core';
+import { RenderPass } from '@galacean/effects-core';
+/**
+ * THREE RenderPass 抽象类的实现（滤镜元素需要实现）
+ */
+export declare class ThreeRenderPass extends RenderPass {
+    /**
+     * 构造函数
+     * @param options - 设置 RenderPass 的参数选项
+     */
+    constructor(renderer: any, options: RenderPassOptions);
+    /**
+     * 重置颜色附件
+     * @param colors - 颜色附件数组
+     */
+    resetColorAttachments(colors: Texture[]): void;
+    /**
+     * 重置所有附件
+     * @param options - 返回渲染目标附件的选项
+     */
+    resetAttachments(options: RenderPassAttachmentOptions): void;
+    /**
+     * 获取视口
+     * @returns vec4 类型的值，表示视口的左上角 x 和 y 坐标以及宽度和高度
+     */
+    getViewport(): spec.vec4;
+    /**
+     * 获取深度附件
+     * @returns 返回深度附件信息
+     */
+    getDepthAttachment(): RenderPassDepthStencilAttachment | undefined;
+    /**
+     * 获取模板附件
+     * @returns 返回模板附件信息
+     */
+    getStencilAttachment(): RenderPassDepthStencilAttachment | undefined;
+    /**
+     * 销毁渲染目标及其所有附件
+     * @param options - 销毁渲染目标的选项
+     */
+    dispose(options?: RenderPassDestroyOptions): void;
+}

package/dist/three-renderer.d.ts

@@ -0,0 +1,4 @@
+import { Renderer } from '@galacean/effects-core';
+export declare class ThreeRenderer extends Renderer {
+    constructor(gl: WebGL2RenderingContext | WebGLRenderingContext);
+}