@galacean/effects 0.0.1-alpha.0

package/dist/player.d.ts

@@ -0,0 +1,337 @@
+import type { Disposable, JSONValue, LostHandler, RestoreHandler, SceneLoadOptions, Scene, GPUCapability } from '@galacean/effects-core';
+import { Ticker, Composition, Renderer, spec } from '@galacean/effects-core';
+/**
+ * `onItemClicked` 点击回调函数的传入参数
+ */
+export interface ItemClickedData {
+    name: string;
+    player: Player;
+    id: string;
+    hitPositions: spec.vec3[];
+    compositionId: number;
+}
+/**
+ * player 创建的构造参数
+ */
+export interface PlayerConfig {
+    /**
+     * 播放器的容器，会在容器中创建 canvas，container 和 canvas 必传一个
+     */
+    container?: HTMLElement | null;
+    /**
+     * 指定 canvas 进行播放
+     */
+    canvas?: HTMLCanvasElement;
+    /**
+     * 画布比例，尽量使用默认值，如果不够清晰，可以写2，但是可能产生渲染卡顿
+     */
+    pixelRatio?: number | 'auto';
+    /**
+     * 播放器是否可交互
+     */
+    interactive?: boolean;
+    /**
+     * canvas 是否透明，如果不透明可以略微提升性能
+     * @default true
+     */
+    transparentBackground?: boolean;
+    /**
+     * 渲染帧数
+     * @default 60
+     */
+    fps?: number;
+    /**
+     * 是否停止计时器，否手动渲染
+     * @default false
+     */
+    manualRender?: boolean;
+    /**
+     * 播放合成的环境
+     * @default '' - 编辑器中为 'editor'
+     */
+    env?: string;
+    /**
+     * 指定 WebGL 创建的上下文类型，`debug-disable` 表示不创建
+     */
+    renderFramework?: 'webgl' | 'webgl2' | 'debug-disable';
+    /**
+     * player 的 name
+     */
+    name?: string;
+    renderOptions?: {
+        /**
+         * 播放器是否需要截图（对应 WebGL 的 preserveDrawingBuffer 参数）
+         */
+        willCaptureImage?: boolean;
+        /**
+         * 图片预乘 Alpha
+         * @default false
+         */
+        premultiplyAlpha?: boolean;
+    };
+    /**
+     * 是否通知 container touchend / mouseup 事件, 默认不通知
+     */
+    notifyTouch?: boolean;
+    /**
+     * 当 WebGL context lost 时候发出的回调，这个时候播放器已经自动被销毁，业务需要做兜底逻辑
+     */
+    onWebGLContextLost?: (event: Event) => void;
+    /**
+     * 当 WebGL context restore 时候发出的回调，这个时候播放器已经自动恢复，业务可视情况做逻辑处理
+     */
+    onWebGLContextRestored?: () => void;
+    /**
+     * 播放器被元素暂停的回调
+     */
+    onPausedByItem?: (data: {
+        name: string;
+        player: Player;
+    }) => void;
+    /**
+     * 交互元素被点击的回调
+     */
+    onItemClicked?: (data: ItemClickedData) => void;
+    /**
+     * 交互元素发送 message 的回调
+     */
+    onMessageItem?: (data: {
+        name: string;
+        phrase: number;
+    }) => void;
+    /**
+     * 播放器更新的回调
+     */
+    onPlayableUpdate?: (data: {
+        playing: boolean;
+        time?: number;
+        player: Player;
+    }) => void;
+    /**
+     * 渲染出错时候的回调
+     * @param - err
+     */
+    onRenderError?: (err: Error) => void;
+    /**
+     * 每帧渲染调用后的回调，WebGL2 上下文生效
+     * @param time - GPU 渲染使用的时间，秒
+     */
+    reportGPUTime?: (time: number) => void;
+    [key: string]: any;
+}
+/**
+ * `player.config` 传入的合成播放配置参数，目前仅支持速度
+ */
+export interface PlayerConfiguration {
+    speed?: number;
+    compositionName?: string;
+}
+export type SceneType = string | JSONValue | Scene;
+export type SceneWithOptionsType = {
+    scene: SceneType;
+    options: SceneLoadOptions;
+};
+export type SceneLoadType = SceneType | SceneWithOptionsType;
+/**
+ * Galacean Effects 播放器
+ */
+export declare class Player implements Disposable, LostHandler, RestoreHandler {
+    readonly env: string;
+    readonly pixelRatio: number;
+    readonly canvas: HTMLCanvasElement;
+    readonly name: string;
+    readonly gpuCapability: GPUCapability;
+    readonly container: HTMLElement | null;
+    /**
+     * 当前播放的合成对象数组，请不要修改内容
+     */
+    protected compositions: Composition[];
+    /**
+     * 播放器的渲染对象
+     */
+    readonly renderer: Renderer;
+    /**
+     * 计时器
+     * 手动渲染 `manualRender=true` 时不创建计时器
+     */
+    readonly ticker: Ticker;
+    private readonly event;
+    private readonly handleWebGLContextLost?;
+    private readonly handleWebGLContextRestored?;
+    private readonly handleMessageItem?;
+    private readonly handlePlayerPause?;
+    private readonly reportGPUTime?;
+    private readonly handleItemClicked?;
+    private readonly handlePlayableUpdate?;
+    private readonly handleRenderError?;
+    private displayAspect;
+    private displayScale;
+    private forceRenderNextFrame;
+    private forwardingTime;
+    private resumePending;
+    private offscreenMode;
+    private disposed;
+    private assetManager;
+    private speed;
+    /**
+     * 播放器的构造函数
+     * @param config
+     */
+    constructor(config: PlayerConfig);
+    /**
+     * 设置 player 的播放速度，
+     * @param speed - 播放速度
+     */
+    setSpeed(speed: number): void;
+    getSpeed(): number;
+    /**
+     * 根据名称查找对应的合成，可能找不到
+     * @param name - 目标合成名称
+     */
+    getCompositionByName(name: string): Composition | undefined;
+    /**
+     * 获取当前播放的所有合成, 请不要修改返回数组的内容
+     */
+    getCompositions(): Composition[];
+    /**
+     * 是否有合成在播放
+     */
+    get hasPlayable(): boolean;
+    /**
+     * 播放器是否已暂停
+     */
+    get paused(): boolean;
+    /**
+     * 获取播放器是否可交互
+     */
+    get interactive(): boolean;
+    /**
+     * 设置播放器是否可交互
+     */
+    set interactive(enable: boolean);
+    /**
+     * 加载动画资源
+     * @param scene - 一个或一组 URL 或者通过 URL 请求的 JSONObject 或者 Scene 对象
+     * @param options - 加载可选参数
+     * @returns
+     */
+    loadScene(scene: SceneLoadType, options?: SceneLoadOptions): Promise<Composition>;
+    loadScene(scene: SceneLoadType[], options?: SceneLoadOptions): Promise<Composition[]>;
+    private createComposition;
+    /**
+     * 播放通过 player 加载好的全部合成
+     */
+    play(): void;
+    /**
+     * 跳转全部合成到指定时间后播放
+     * @param time - 指定时间
+     */
+    gotoAndPlay(time: number): void;
+    /**
+     * 跳转全部合成带指定时间并停留
+     * @param time - 指定时间
+     */
+    gotoAndStop(time: number): void;
+    /**
+     * 顺序播放一组还未开始播放的合成
+     * @param - compositions 要播放的合成数组
+     */
+    playSequence(compositions: Composition[]): void;
+    /**
+     * 暂停播放器
+     * @param options
+     * @param options.offloadTexture - 是否卸载贴图纹理，减少内存
+     * @returns
+     */
+    pause(options?: {
+        offloadTexture?: boolean;
+    }): true | undefined;
+    /**
+     * 恢复播放器
+     * > 如果暂停时卸载了纹理贴图，此函数将自动请求网络重新加载纹理
+     * @returns
+     */
+    resume(): Promise<void>;
+    /**
+     * player 在定时器每帧的回调
+     * @param dt - 时间差，毫秒
+     */
+    tick(dt: number): void;
+    private doTick;
+    /**
+     * 调整画布的宽高比
+     * @param aspect
+     * @param scale
+     */
+    resizeToAspect(aspect: number, scale?: number): void;
+    /**
+     * 将播放器重新和父容器大小对齐
+     */
+    resize(): void;
+    /**
+     * 修改播放器的配置
+     * @param config - 播放配置，当前仅支持修改合成播放速度
+     */
+    config(config: PlayerConfiguration): void;
+    /**
+     * 快进/快退指定时间间隔
+     * @param composition - 要快进的合成
+     * @param timeInSeconds - 需要快进/快退的时间长度（秒），可正可负
+     */
+    forwardCompositionTime(composition: Composition, timeInSeconds: number): void;
+    /**
+     * 清空 canvas 的画面
+     * @param immediate - 如果立即清理，当前画面将会消失，如果 player 还有合成在渲染，可能出现闪烁
+     */
+    clearCanvas(immediate?: boolean): void;
+    /**
+     * @internal
+     * @deprecated since 2.0.0
+     * @param id
+     * @param options
+     */
+    destroyItem(id: string, options?: {}): void;
+    /**
+     * 播放器在 `webglcontextlost` 时执行的操作
+     * @param e - Event
+     */
+    lost: (e: Event) => void;
+    /**
+     * 播放器在 `webglcontextrestored` 时执行的操作
+     * @returns
+     */
+    restore: () => Promise<void>;
+    /**
+     * 销毁播放器
+     * @param keepCanvas - 是否保留 canvas 画面，默认不保留，canvas 不能再被使用
+     */
+    dispose(keepCanvas?: boolean): void;
+    private renderFrame;
+    private handleResume;
+    private offloadTexture;
+    private handleClick;
+    private getTargetSize;
+}
+export declare function isSceneWithOptions(scene: any): scene is SceneWithOptionsType;
+/**
+ * 禁止/允许创建新的播放器，已创建的不受影响
+ * @param disable - 是否禁止
+ */
+export declare function disableAllPlayer(disable: boolean): void;
+/**
+ * 判断指定的 canvas 是否有播放器正在使用
+ * @param canvas - 指定的 canvas
+ * @returns
+ */
+export declare function isCanvasUsedByPlayer(canvas: HTMLCanvasElement): boolean;
+/**
+ * 获取 canvas 对应的播放器
+ * @param canvas - 指定的 canvas
+ * @returns
+ */
+export declare function getPlayerByCanvas(canvas: HTMLCanvasElement): Player | undefined;
+/**
+ * 获取使用中的播放器
+ * @returns
+ */
+export declare function getActivePlayers(): Player[];

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare function isDowngradeIOS(): boolean;