@galacean/effects-core 2.0.0-alpha.1 → 2.0.0-alpha.10

package/dist/scene.d.ts

@@ -1,10 +1,9 @@
 import type * as spec from '@galacean/effects-specification';
-import type { SceneType } from './asset-manager';
 import type { Texture } from './texture';
 import type { PluginSystem } from './plugin-system';
 export type ImageSource = spec.TemplateImage | spec.Image | spec.CompressedImage;
 /**
- *
+ * 场景类型
  */
 export interface Scene {
     readonly jsonScene: spec.JSONScene;
@@ -27,4 +26,81 @@ export interface Scene {
     url: SceneType;
     usedImages: Record<number, boolean>;
 }
-export declare function isScene(scene: any): scene is Scene;
+/**
+ * 场景加载参数
+ */
+export interface SceneLoadOptions {
+    /**
+     * 动态数据的参数
+     * key 是 JSON 中配置的字段名
+     * value 是要使用的值，图片使用 url 链接
+     * 图片链接可以使用数组传递，如果第一个加载失败，将尝试使用第二个地址
+     *
+     * @example
+     * ``` ts
+     * {
+     *   variables: {
+     *     bg: ['url','fallback_url'], // 如果两个图片都失败，将会触发加载失败
+     *     fg: 'url' // 如果图片加载失败，将会触发加载失败,
+     *     amount: 88.8,
+     *     name: 'abc'
+     *   }
+     * }
+     * ```
+     */
+    variables?: Record<string, number | string | string[]>;
+    /**
+     * 是否使用压缩纹理
+     */
+    useCompressedTexture?: boolean;
+    /**
+     * 渲染分级。
+     * 分级之后，只会加载当前渲染等级的资源。
+     * 当渲染等级被设置为 B 后，player 的 fps 会降到 30 帧
+     * @default 's'
+     */
+    renderLevel?: spec.RenderLevel;
+    /**
+     * 资源加载超时，时间单位秒
+     * @default 10s
+     */
+    timeout?: number;
+    /***
+     * 用于给 plugin 的加载数据
+     * key/value 的内容由 plugin 自己实现
+     */
+    pluginData?: Record<string, any>;
+    /**
+     * 场景加载时的环境（加载后把 env 结果写入 scene）
+     * @default '' - 编辑器中为 'editor'
+     */
+    env?: string;
+    /**
+     * 加载后是否自动播放
+     * @default true
+     */
+    autoplay?: boolean;
+    /**
+     * 合成播放完成后是否需要再使用，是的话生命周期结束后不会 `dispose`
+     * @default false
+     */
+    reusable?: boolean;
+    /**
+     * 播放速度，当速度为负数时，合成倒播
+     */
+    speed?: number;
+}
+/**
+ * 接受用于加载的数据类型
+ */
+export type SceneURLType = {
+    url: string;
+};
+export type SceneType = string | Scene | SceneURLType | Record<string, any>;
+export type SceneWithOptionsType = {
+    options: SceneLoadOptions;
+};
+export type SceneLoadType = SceneType | SceneWithOptionsType;
+export declare function isSceneJSON(scene: any): scene is Scene;
+export declare function isSceneURL(scene: any): scene is Scene;
+export declare function isSceneWithOptions(scene: any): scene is SceneWithOptionsType;

package/dist/shader/index.d.ts

@@ -4,23 +4,12 @@ export { default as compatibleVert } from './compatible.vert.glsl';
 export { default as itemFrameFrag } from './item-frame.frag.glsl';
 export { default as integrate } from './integrate.glsl';
 export { default as itemVert } from './item.vert.glsl';
-export { default as itemDefine } from './item.define.glsl';
 export { default as itemFrag } from './item.frag.glsl';
 export { default as particleFrag } from './particle.frag.glsl';
 export { default as particleVert } from './particle.vert.glsl';
 export { default as trailVert } from './trail.vert.glsl';
 export { default as value } from './value.glsl';
 export { default as valueDefine } from './value-define.glsl';
-export { default as copyFrag } from './adjust/copy.frag.glsl';
-export { default as alphaFrameFrag } from './adjust/alpha-frame.frag.glsl';
-export { default as alphaMaskFrag } from './adjust/alpha-mask.frag.glsl';
-export { default as cameraMoveFrag } from './adjust/camera-move.frag.glsl';
-export { default as cameraMoveVert } from './adjust/camera-move.vert.glsl';
-export { default as delayFrag } from './adjust/delay.frag.glsl';
-export { default as distortionFrag } from './adjust/distortion.frag.glsl';
-export { default as distortionVert } from './adjust/distortion.vert.glsl';
-export { default as bloomMixVert } from './adjust/bloom-mix.frag.glsl';
-export { default as bloomThresholdVert } from './adjust/bloom-threshold.frag.glsl';
 export { default as screenMeshVert } from './post-processing/screen-mesh.vert.glsl';
 export { default as colorGradingFrag } from './post-processing/color-grading.frag.glsl';
 export { default as gaussianDownFrag } from './post-processing/gaussian-down.frag.glsl';

package/dist/shape/sphere.d.ts

@@ -8,8 +8,5 @@ export declare class Sphere implements Shape {
     generate(opt: ShapeGeneratorOptions): ShapeParticle;
 }
 export declare class Hemisphere extends Sphere {
-    arc: number;
-    radius: number;
-    arcMode: number;
     getHorizontalAngle(): number;
 }

package/dist/template-image.d.ts

@@ -0,0 +1,10 @@
+import type { TemplateContent } from '@galacean/effects-specification';
+export declare function getBackgroundImage(template: TemplateContent, variables?: Record<string, number | string | string[]>): string | number | string[] | undefined;
+/**
+ * @param url
+ * @param template
+ * @param variables
+ * @param options
+ * @returns
+ */
+export declare function combineImageTemplate(url: string | HTMLImageElement, template?: TemplateContent, variables?: Record<string, number | string>): Promise<HTMLImageElement>;

package/dist/texture/texture.d.ts

@@ -31,6 +31,12 @@ export declare abstract class Texture extends EffectsObject {
      * 创建一个新的 Texture 对象。
      */
     static create: (engine: Engine, options?: TextureSourceOptions) => Texture;
+    /**
+     * 通过 URL 创建 Texture 对象。
+     * @param url - 要创建的 Texture URL
+     * @since 2.0.0
+     */
+    static fromImage(url: string, engine: Engine): Promise<Texture>;
     /**
      * 通过数据创建 Texture 对象。
      * @param data - 要创建的 Texture 数据

package/dist/vfx-item.d.ts

@@ -1,10 +1,10 @@
 import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import * as spec from '@galacean/effects-specification';
+import type { VFXItemData } from './asset-loader';
 import { RendererComponent } from './components';
 import type { Component } from './components/component';
 import { ItemBehaviour } from './components/component';
 import type { Composition } from './composition';
-import { type VFXItemData } from './asset-loader';
 import { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
 import type { BoundingBoxData, CameraController, HitTestBoxParams, HitTestCustomParams, HitTestSphereParams, HitTestTriangleParams, InteractComponent, ParticleSystem, SpriteComponent } from './plugins';
@@ -77,7 +77,7 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
      * 元素 id 唯一
      */
     id: string;
-    oldId: number;
+    oldId: string;
     /**
      * 元素创建的数据图层/粒子/模型等
      */
@@ -258,7 +258,6 @@ export declare class VFXItem<T extends VFXItemContent> extends EffectsObject imp
 }
 export declare namespace Item {
     function is<T extends spec.Item>(item: spec.Item, type: spec.ItemType): item is T;
-    function isFilter(item: spec.Item): item is spec.FilterItem;
     function isComposition(item: spec.Item): item is spec.CompositionItem;
     function isParticle(item: spec.Item): item is spec.ParticleItem;
     function isNull(item: spec.Item): item is spec.NullItem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.10",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -42,15 +42,15 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-specification": "1.0.1",
-    "@galacean/effects-math": "1.0.1",
+    "@galacean/effects-specification": "2.0.0-alpha.9",
+    "@galacean/effects-math": "1.1.0-alpha.0",
     "uuid": "9.0.1"
   },
   "scripts": {
     "prebuild": "pnpm clean",
     "build": "pnpm build:declaration && pnpm build:module",
     "build:module": "rollup -c",
-    "build:declaration": "tsc -d --declarationDir dist --emitDeclarationOnly",
+    "build:declaration": "tsc -d --emitDeclarationOnly",
     "clean": "rimraf dist && rimraf '*+(.tsbuildinfo)'"
   }
 }

package/dist/template-image/index.d.ts

@@ -1,67 +0,0 @@
-import type { TemplateContentV1, TemplateContentV2 } from '@galacean/effects-specification';
-export * from './qcanvas-viewer';
-export * from './qtext';
-export * from './template-v1';
-export declare const DEFAULT_FONTS: string[];
-export interface TextLayout {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
-export interface TemplateOptions {
-    templateScale?: number;
-    canvas?: HTMLCanvasElement;
-    textLayouts?: TextLayout[];
-    debug?: boolean;
-    borderColor?: string;
-    borderWidth?: number;
-    flipY?: boolean;
-    scaleX?: number;
-    scaleY?: number;
-    toData?: boolean;
-}
-declare class CanvasPool {
-    readonly elements: HTMLCanvasElement[];
-    constructor();
-    dispose(): void;
-    getCanvas(): HTMLCanvasElement;
-    saveCanvas(cvs: HTMLCanvasElement): void;
-}
-export declare const canvasPool: CanvasPool;
-export declare function getDefaultTemplateCanvasPool(): CanvasPool;
-export declare function getBackgroundImage(template: TemplateContentV2, variables?: Record<string, number | string | string[]>): string | number | string[] | undefined;
-/**
- * @param {string|HTMLImageElement} url
- * @param {TemplateContentV2} [template]
- * @param {Record<string, number | string>} [variables]
- * @param {TemplateOptions} [opts]
- * @param {boolean} [flipY]
- * @returns
- */
-export declare function combineImageTemplate2(url: string | HTMLImageElement, template?: TemplateContentV2, variables?: Record<string, number | string>, opts?: TemplateOptions, flipY?: boolean): Promise<HTMLCanvasElement>;
-/**
- * @internal
- * @deprecated since 2.0.0 - use `combineImageTemplate2` instead
- */
-export declare function combineImageTemplate2Async(url: string | HTMLImageElement, template?: TemplateContentV2, variables?: Record<string, number | string>, opts?: TemplateOptions, flipY?: boolean): Promise<HTMLCanvasElement | ImageData>;
-/**
- * @param url
- * @param template
- * @param variables
- * @param opts
- * @param flipY
- * @returns
- */
-export declare function combineImageTemplate(url: string | HTMLImageElement, template: TemplateContentV1 | TemplateContentV2, variables: Record<string, number | string>, opts?: {
-    templateScale?: number;
-    canvas?: HTMLCanvasElement;
-}, flipY?: boolean): Promise<HTMLCanvasElement>;
-/**
- * @internal
- * @deprecated since 2.0.0 - use `combineImageTemplate` instead
- */
-export declare function combineImageTemplateAsync(url: string | HTMLImageElement, template: TemplateContentV1 | TemplateContentV2, variables: Record<string, number | string>, opts?: {
-    templateScale?: number;
-    canvas?: HTMLCanvasElement;
-}, flipY?: boolean): Promise<HTMLCanvasElement | HTMLImageElement | ImageData>;

package/dist/template-image/qcanvas-viewer.d.ts

@@ -1,21 +0,0 @@
-import type { QText } from './qtext';
-declare class QCanvasViewer {
-    width: number;
-    height: number;
-    background: HTMLImageElement;
-    scaleX: number;
-    scaleY: number;
-    renderCanvas: HTMLCanvasElement;
-    renderContext: CanvasRenderingContext2D;
-    textList: QText[];
-    devicePixelRatio: number;
-    flipY: boolean;
-    constructor(canvas: string | HTMLCanvasElement, width: number, height: number, scaleX?: number, scaleY?: number, flipY?: boolean);
-    initDimension(width: number, height: number, scaleX?: number, scaleY?: number): void;
-    clearText(): void;
-    clearCanvasWithContext(ctx: CanvasRenderingContext2D): void;
-    clearCanvas(): void;
-    addObject(text: QText): void;
-    render(): void;
-}
-export { QCanvasViewer };

package/dist/template-image/qtext.d.ts

@@ -1,96 +0,0 @@
-import type { QCanvasViewer } from './qcanvas-viewer';
-import type { IFontMetrics } from './text-metrics';
-declare enum QTextWrapMode {
-    Default = 0,
-    Clip = 1,
-    Ellipsis = 2
-}
-interface QTextOptions {
-    left?: number;
-    top?: number;
-    maxWidth?: number;
-    fontFamily?: string;
-    fontSize?: number;
-    fontWeight?: string;
-    align?: string;
-    verticalAlign?: string;
-    padding?: number;
-    letterSpacing?: number;
-    wrap?: QTextWrapMode;
-    color?: string;
-    fontStyle?: string;
-    angle?: number;
-    name?: string;
-}
-interface QChar {
-    left: number;
-    top: number;
-    char: string;
-    width: number;
-    heigh: number;
-    font: string;
-    fontSize: number;
-    isEllipsis: boolean;
-    scale: number;
-    index: number;
-}
-declare class QText {
-    left: number;
-    top: number;
-    width?: number;
-    height?: number;
-    text: string;
-    name: string;
-    fontSize: number;
-    fontFamily: string;
-    color: string;
-    letterSpacing: number;
-    maxLineWidth: number;
-    wrap: QTextWrapMode;
-    fontStyle: 'normal' | 'italic' | 'oblique' | 'initial' | 'inherit';
-    textAlign: 'center' | 'end' | 'left' | 'right' | 'start';
-    textBaseline: 'alphabetic' | 'bottom' | 'hanging' | 'ideographic' | 'middle' | 'top';
-    scaleX: number;
-    scaleY: number;
-    angle: number;
-    active: boolean;
-    padding: number;
-    fontWeight: string;
-    chars: QChar[];
-    borderColor: string;
-    borderWidth: number;
-    fontProperties: IFontMetrics;
-    fontVariant: string;
-    private viewer;
-    private originX;
-    private originY;
-    private ellipsis;
-    constructor(text: string, options: QTextOptions);
-    update(): void;
-    render(): void;
-    init(viewer: QCanvasViewer): void;
-    getLayout(): {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    private updateDimension;
-    private configTextStyle;
-    private getFontDesc;
-    private configTextLayout;
-    private setRenderTransform;
-    private renderText;
-    private drawCharsInTextBox;
-    private addEllipsisToChars;
-    private createCharsFromText;
-    private addOffsetToChars;
-    private clipCharsWithTextBox;
-    private cloneChars;
-    private replaceCharWithEllipsis;
-    private findEllipsisPositionAndReplaceCharsFromLeft;
-    private findEllipsisPositionAndReplaceCharsFromRight;
-    private drawCharsFromLeft;
-    private drawBorders;
-}
-export { QText, QTextOptions, QTextWrapMode };

package/dist/template-image/template-v1.d.ts

@@ -1,27 +0,0 @@
-import type { TemplateContentV1 } from '@galacean/effects-specification';
-export declare function requestAsync(url: string, opt?: {
-    responseType?: XMLHttpRequestResponseType;
-    method?: string;
-    data?: Document | XMLHttpRequestBodyInit | null;
-}): Promise<unknown>;
-/**
- *
- * @param url
- * @param template
- * @param variables
- * @param opts
- * @param flipY
- * @returns
- */
-export declare function combineImageTemplate1(url: string | HTMLImageElement, template: TemplateContentV1, variables: Record<string, number | string | HTMLImageElement>, opts?: {
-    templateScale?: number;
-    canvas?: HTMLCanvasElement;
-}, flipY?: boolean): Promise<HTMLCanvasElement>;
-/**
- * @internal
- * @deprecated since 2.0.0 - use `combineImageTemplate1` instead
- */
-export declare function combineImageTemplate1Async(url: string | HTMLImageElement, template: TemplateContentV1, variables: Record<string, number | string | HTMLImageElement>, opts?: {
-    templateScale?: number;
-    canvas?: HTMLCanvasElement;
-}, flipY?: boolean): Promise<HTMLCanvasElement>;

package/dist/template-image/text-metrics.d.ts

@@ -1,18 +0,0 @@
-export interface IFontMetrics {
-    ascent: number;
-    descent: number;
-    fontSize: number;
-}
-export declare class TextMetrics {
-    static _fonts: {
-        [font: string]: IFontMetrics;
-    };
-    static METRICS_STRING: string;
-    static BASELINE_SYMBOL: string;
-    static BASELINE_MULTIPLIER: number;
-    static HEIGHT_MULTIPLIER: number;
-    private static __canvas;
-    private static __context;
-    static measureFont(font: string): IFontMetrics;
-    static get _canvas(): HTMLCanvasElement;
-}