@galacean/effects-plugin-model 0.0.1-alpha.0

package/dist/utility/index.d.ts

@@ -0,0 +1,6 @@
+export * from './debug-helper';
+export * from './hit-test-helper';
+export * from './plugin-helper';
+export * from './ri-helper';
+export * from './shader-helper';
+export * from './ts-helper';

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

@@ -0,0 +1,197 @@
+import type { Scene, Composition, Attribute, GeometryProps, TextureSourceOptions, TextureSourceCubeData, TextureConfigOptions, Engine } from '@galacean/effects';
+import { Player, spec, Transform, Mesh, Texture, Geometry, Renderer, RenderPass } from '@galacean/effects';
+import type { GLTFCamera, GLTFImage, GLTFLight, GLTFTexture } from '@vvfx/resource-detection';
+import type { MarsAnimationOptions, MarsMeshOptions, MarsMaterialOptions, MarsLightOptions, MarsCameraOptions, MarsSkyboxOptions, MarsSkinOptions, MarsPrimitiveOptions, MarsTextureTransform, MarsTreeOptions, MarsAnimTrackOptions } from '../index';
+import type { Box3 } from '../math';
+import { Matrix3, Matrix4, Vector3, Vector4 } from '../math';
+import type { FBOOptions } from './ri-helper';
+import type { PMaterialBase } from '../runtime/material';
+import type { PImageBufferData } from '../runtime/skybox';
+import type { CompositionCache } from '../runtime/cache';
+type MarsRIVertexArray = Float32Array | Int32Array | Int16Array | Int8Array | Uint32Array | Uint16Array | Uint8Array;
+export declare class MarsRIHelper {
+    static cubemapTexConfig: TextureConfigOptions;
+    static cubemapMipTexConfig: TextureConfigOptions;
+    static createTexture2D(engine: Engine, image: GLTFImage, texture: GLTFTexture, isBaseColor?: boolean, tiny3dMode?: boolean): Promise<Texture>;
+    static createTextureList(engine: Engine, images: GLTFImage[], textures: GLTFTexture[]): Promise<Texture[]>;
+    static getTextureCubeData(images: PImageBufferData[]): Promise<TextureSourceCubeData>;
+    static getTextureCubeMipmapData(images: PImageBufferData[][]): Promise<TextureSourceCubeData[]>;
+    static createTextureCubeFromURL(engine: Engine, cubeImage: string[]): Promise<Texture>;
+    static createTextureCubeMipmapFromURL(engine: Engine, cubeImages: string[][]): Promise<Texture>;
+    static createTextureCubeFromBuffer(engine: Engine, cubeImages: PImageBufferData[]): Promise<Texture>;
+    static createTextureCubeMipmapFromBuffer(engine: Engine, cubeImages: PImageBufferData[][], level0Size: number): Promise<Texture>;
+    static getTexture(index: number, textures: Texture[]): Texture | undefined;
+    static createTextureFromImage(engine: Engine, image: HTMLImageElement | HTMLCanvasElement): Texture;
+    static createRenderPass(renderer: Renderer, name: string, priority: number, meshData: Mesh | Mesh[], fboOpts: FBOOptions): RenderPass;
+    static deleteTexture(texture: Texture): void;
+    static deleteMesh(mesh: Mesh): void;
+    static deleteGeometry(geometry: Geometry): void;
+    static deleteRenderPass(pass: RenderPass): void;
+    /**
+     * 返回 Mesh 是否半透明
+     *
+     * @param mesh - gl mesh 对象
+     * @return 是否半透明
+     */
+    static isTransparentMesh(mesh: Mesh): boolean;
+    /**
+     * renderer 是否支持 Float 纹理
+     * @returns
+     */
+    static isSupportFloatTexture(engine: Engine): boolean;
+    /**
+     * renderer 是否支持 HalfFloat 纹理
+     * @returns
+     */
+    static isSupportHalfFloatTexture(engine: Engine): boolean;
+    static isPow2(v: number): boolean;
+}
+export declare class MeshHelper {
+    static createMarsFilterMesh(engine: Engine, name: string, material: PMaterialBase, uniformSemantics: {
+        [k: string]: any;
+    }): Mesh;
+    static getPlaneGeometry(): GeometryProps;
+    static getPlaneVertexArray(): Float32Array;
+}
+export interface MarsSceneInfo {
+    loadSkybox?: boolean;
+}
+export declare class PluginHelper {
+    static createLightOptions(light: GLTFLight): MarsLightOptions;
+    static createCameraOptions(camera: GLTFCamera): MarsCameraOptions | undefined;
+    static toPlayerColor3(color: spec.vec3): spec.vec3;
+    static toPlayerColor4(color: spec.vec4): spec.vec4;
+    static toPluginColor3(color: spec.vec3): spec.vec3;
+    static toPluginColor4(color: spec.vec4): spec.vec4;
+    static createUVTransform(transform?: spec.ModelTextureTransform): Matrix3 | undefined;
+    static clamp(val: number, minv: number, maxv: number): number;
+    static scaleTo255(val: number): number;
+    static scaleTo1(val: number): number;
+    static focusOnPoint(cameraPosition: spec.vec3, YRotationAngle: number, targetPoint: spec.vec3): Transform;
+    static preprocessMarsScene(scene: Scene, runtimeEnv: string, compatibleMode: string, autoAdjustScene: boolean): MarsSceneInfo;
+    static preprocessTextureOptions(index: number, textures: Array<TextureSourceOptions>, isBaseColor: boolean, tiny3dMode: boolean): void;
+    static setupItem3DOptions(scene: Scene, cache: CompositionCache, composition: Composition): void;
+    static createGeometry(engine: Engine, geomJson: spec.GeometryOptionsJSON, bins: ArrayBuffer[]): Geometry;
+    static getIndexArray(type: number, array: spec.TypedArray): Uint32Array | Uint8Array | Uint16Array | undefined;
+    static getAttributeName(name: string): string;
+    static getTextureObj(textures: Texture[], index?: number): Texture | undefined;
+}
+export declare class WebHelper {
+    static getImageFileName(url: string, ext?: string): string;
+    static getCurrnetTimeStr(): string;
+    static saveFileForURL(url: string, filename: string): void;
+    static createPlayer(): Player;
+    static sleep(ms: number): Promise<unknown>;
+    static loadImageFromGLTFImage(image: GLTFImage): Promise<HTMLImageElement>;
+    static loadImageFromImageData(image: PImageBufferData): Promise<HTMLImageElement>;
+    static getCanvasArrayBuffer(canvas: HTMLCanvasElement): Promise<ArrayBuffer>;
+    static getImageArrayBuffer(image: HTMLImageElement | ImageBitmap | HTMLVideoElement): Promise<ArrayBuffer>;
+    static getCanvasImageData(canvas: HTMLCanvasElement): ImageData;
+    static flipImageData(imageData: ImageData): ImageData;
+    static getImageData(image: HTMLImageElement | ImageBitmap | HTMLVideoElement): ImageData;
+    static getWebGLCanvasImageBuffer(canvas: HTMLCanvasElement): Uint8Array;
+}
+export declare class VertexAttribBuffer {
+    data: MarsRIVertexArray;
+    component: number;
+    length: number;
+    offset: number;
+    stride: number;
+    typeSize: number;
+    getBoundingBox(box: Box3): Box3;
+}
+declare class AttributeArray {
+    data: spec.TypedArray;
+    length: number;
+    offset: number;
+    stride: number;
+    typeSize: number;
+    compCount: number;
+    signed: boolean;
+    compressed: boolean;
+    compressScale: number;
+    create(inAttrib: Attribute, inArray: spec.TypedArray): void;
+    getData(index: number): [number, number, number, number] | undefined;
+    getLength(): number;
+}
+export declare class GeometryBoxProxy {
+    drawStart: number;
+    drawCount: number;
+    index?: spec.TypedArray;
+    position: AttributeArray;
+    joint?: AttributeArray;
+    weight?: AttributeArray;
+    bindMatrices: Matrix4[];
+    create(geometry: Geometry, bindMatrices: Matrix4[]): void;
+    getBoundingBox(box: Box3): Box3;
+}
+export declare class HitTestingProxy {
+    drawStart: number;
+    drawCount: number;
+    index?: spec.TypedArray;
+    position: AttributeArray;
+    joint?: AttributeArray;
+    weight?: AttributeArray;
+    doubleSided: boolean;
+    bindMatrices: Matrix4[];
+    hasAnimation: boolean;
+    skinMatrix: Matrix4;
+    create(geometry: Geometry, doubleSided: boolean, bindMatrices: Matrix4[]): void;
+    getHitPoint(rayOrigin: Vector3, rayDirection: Vector3): number | undefined;
+    getPosition(index: number, vec3: Vector3, vec4: Vector4): Vector3 | undefined;
+}
+export declare class CheckerHelper {
+    static checkNumber(v: number): boolean;
+    static checkNumberUndef(v: number | undefined): boolean;
+    static checkNumber01(v: number): boolean;
+    static checkNumber01Undef(v: number | undefined): boolean;
+    static checkPositive(v: number): boolean;
+    static checkNonnegative(v: number): boolean;
+    static checkNonnegativeUndef(v: number | undefined): boolean;
+    static checkBoolean(v: boolean): boolean;
+    static checkBooleanUndef(v: boolean | undefined): boolean;
+    static checkString(v: string): boolean;
+    static checkStringUndef(v: string | undefined): boolean;
+    static checkFloat32Array(v: Float32Array): boolean;
+    static checkFloat32ArrayUndef(v: Float32Array | undefined): boolean;
+    static checkParent(v: number | undefined): boolean;
+    static checkTexCoord(v: number | undefined): boolean;
+    static checkVec2(v: spec.vec2): boolean;
+    static checkVec2Undef(v?: spec.vec2): boolean;
+    static checkVec3(v: spec.vec3): boolean;
+    static checkNonnegative3(v: spec.vec3): boolean;
+    static checkVec4(v: spec.vec4): boolean;
+    static checkNonnegative4(v: spec.vec4): boolean;
+    static checkNumberArray(v: number[]): boolean;
+    static checkTexture(v: Texture): boolean;
+    static checkTextureUndef(v: Texture | undefined): boolean;
+    static checkMarsTexTransform(v: MarsTextureTransform): boolean;
+    static checkMarsTexTransformUndef(v: MarsTextureTransform | undefined): boolean;
+    static checkMarsMatBlending(v: spec.MaterialBlending | undefined): boolean;
+    static checkMarsMatSide(v: spec.SideMode | undefined): boolean;
+    static checkAnimPath(v: string): boolean;
+    static checkAnimInterp(v: string): boolean;
+    static assertGeometry(v: Geometry, s?: MarsSkinOptions): void;
+    static assertGeometryBuffer(v: Geometry, name: string, drawCount: number): void;
+    static createAttributeArray(v: Geometry, name: string): AttributeArray | undefined;
+    static assertMarsSkinOptions(v: MarsSkinOptions): void;
+    static assertMarsMatOptions(v: MarsMaterialOptions): void;
+    static assertMarsPrimOptions(v: MarsPrimitiveOptions, s?: MarsSkinOptions): boolean;
+    static assertMarsMeshOptions(v: MarsMeshOptions): void;
+    static assertMarsCameraOptions(v: MarsCameraOptions): void;
+    static assertMarsLightOptions(v: MarsLightOptions): void;
+    static assertMarsSkyboxOptions(v: MarsSkyboxOptions): void;
+    static checkMarsAnimTrackOptions(v: MarsAnimTrackOptions): boolean;
+    static assertMarsAnimOptions(v: MarsAnimationOptions): void;
+    static assertTreeOptions(v: MarsTreeOptions): void;
+    static stringify(object: any): string;
+    static pow2(index: number): number;
+}
+export declare class Float16ArrayWrapper {
+    size: number;
+    data: Uint16Array;
+    constructor(size: number);
+    set(number: ArrayLike<number>, startIndex: number): void;
+    get bytes(): number;
+}
+export {};

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

@@ -0,0 +1,25 @@
+import type { GeometryProps, Engine } from '@galacean/effects';
+import { Mesh } from '@galacean/effects';
+import type { Matrix4, Vector3 } from '../math';
+import { Vector2 } from '../math';
+export declare class FBOOptions {
+    resolution: Vector2;
+    colorAttachments: object[];
+    depthAttachment?: any;
+    constructor(options: Record<string, any>);
+    addDepthAttachment(options: Record<string, any>): void;
+    addDefaultDepthAttachment(): void;
+    deleteDepthAttachment(): void;
+    addColorAttachment(options: Record<string, any>): void;
+    deleteColorAttachment(target: number): void;
+    get viewport(): [number, number, number, number];
+}
+export declare class BoxMesh {
+    mesh: Mesh;
+    constructor(engine: Engine, priority: number);
+    update(modelMatrix: Matrix4, viewProjMatrix: Matrix4, positions: Float32Array, lineColor: Vector3): void;
+    dispose(): void;
+    get vertexShader(): string;
+    get fragmentShader(): string;
+    get geometry(): GeometryProps;
+}

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

@@ -0,0 +1,13 @@
+import type { PShaderContext, PShaderResults } from '../runtime/shader';
+export declare function getPBRPassShaderCode(context: PShaderContext): PShaderResults;
+export declare function getShadowPassShaderCode(context: PShaderContext): PShaderResults;
+export declare function getSkyBoxShaderCode(context: PShaderContext): PShaderResults;
+export declare function getQuadFilterShaderCode(context: PShaderContext): PShaderResults;
+export declare function getNormalVisShaderCode(context: PShaderContext): PShaderResults;
+export declare function getDiffuseOnlyShaderCode(context: PShaderContext): PShaderResults;
+export declare function getKawaseBlurShaderCode(context: PShaderContext): PShaderResults;
+export declare function getSimpleFilterShaderCode(context: PShaderContext): PShaderResults;
+export declare function getGaussianBlurShaderCodeV2(context: PShaderContext): PShaderResults;
+export declare function getGaussianBlurShaderCodeV1(context: PShaderContext): PShaderResults;
+export declare function getTransparecyBaseShader(isVertexShader: boolean): string;
+export declare function getTransparecyFilterShader(isVertexShader: boolean): string;

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

@@ -0,0 +1,34 @@
+/**
+ * 双状态 Set，用于保存前一帧和当前帧的信息
+ */
+export declare class TwoStatesSet<T> {
+    /**
+     * 当前帧 Set
+     */
+    now: Set<T>;
+    /**
+     * 前一帧 Set
+     */
+    last: Set<T>;
+    constructor();
+    /**
+     * 清空 last 和 now
+     */
+    clear(): void;
+    /**
+     * 状态前进，当前变成 last，now 被清空
+     */
+    forward(): void;
+    /**
+     * 遍历当前帧新加的元素
+     *
+     * @param callbackfn - 增加新元素的回调
+     */
+    forAddedItem(callbackfn: (value: T) => void): void;
+    /**
+     * 遍历当前帧删除的元素
+     *
+     * @param callbackfn - 删除旧元素的回调
+     */
+    forRemovedItem(callbackfn: (value: T) => void): void;
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@galacean/effects-plugin-model",
+  "version": "0.0.1-alpha.0",
+  "description": "Galacean Effects player model plugin",
+  "module": "./dist/index.mjs",
+  "main": "./dist/index.js",
+  "brower": "./dist/index.min.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./dist/*": {
+      "import": "./dist/*.mjs",
+      "require": "./dist/*.js",
+      "types": "./dist/*.d.ts"
+    }
+  },
+  "contributors": [
+    {
+      "name": "飂兮"
+    }
+  ],
+  "author": "Ant Group CO., Ltd.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "dependencies": {
+    "@galacean/effects-helper": "0.0.1-alpha.0"
+  },
+  "devDependencies": {
+    "@vvfx/resource-detection": "0.4.2-alpha.22",
+    "@types/hammerjs": "^2.0.41",
+    "fpsmeter": "^0.3.1",
+    "hammerjs": "^2.0.6",
+    "@galacean/effects-plugin-editor-gizmo": "0.0.1-alpha.0",
+    "@galacean/effects": "0.0.1-alpha.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "preview": "concurrently -k \"vite build -w\" \"sleep 6 && vite preview\"",
+    "prebuild": "pnpm clean",
+    "build": "pnpm build:declaration && pnpm build:module",
+    "build:module": "rollup -c",
+    "build:declaration": "tsc -d --declarationDir dist --emitDeclarationOnly",
+    "build:demo": "rimraf dist && vite build",
+    "clean": "rimraf dist && rimraf '*+(.tsbuildinfo)'"
+  }
+}