@realsee/five 6.3.0-alpha.2 → 6.3.0-alpha.20

package/five/index.d.ts

@@ -27,19 +27,28 @@ export declare interface AnimationFrame {
     order: number;
 }
 
+export declare interface AnimationFrameContext {
+    requestAnimationFrame(...args: any[]): any;
+    cancelAnimationFrame(requestId: any): void;
+}
+
 export declare class AnimationFrameLoop {
     private frames;
-    private time;
-    private stoped;
-    private context?;
+    private loopType;
+    private isAnimating;
+    private context;
     private requestId;
+    private loop;
     private static sharedInstance?;
     static get shared(): AnimationFrameLoop;
     static getFrameTime(): number;
     constructor();
-    private loop;
-    setContext(context: any): void;
-    getContext(): any;
+    start(): void;
+    stop(): void;
+    setContext(context: AnimationFrameContext | null): void;
+    getContext<T extends AnimationFrameContext>(): T | null;
+    setLoopType(type: AnimationFrameLoopType): void;
+    getLoopType(): AnimationFrameLoopType;
     private requestAnimationFrame;
     private cancelAnimationFrame;
     private remove;
@@ -52,9 +61,11 @@ export declare class AnimationFrameLoop {
      * @returns 移除动画循环函数
      */
     add(callback: AnimationFrame["callback"], once?: boolean, delay?: number, order?: number): () => void;
-    disponse(): void;
+    clear(): void;
 }
 
+export declare type AnimationFrameLoopType = 'raf' | 'sto';
+
 export declare interface BaseEvent {
     type: string;
     timeStamp: number;
@@ -145,7 +156,7 @@ export declare class Camera extends THREE_2.Camera {
     get perspectiveProjectionMatrixInverse(): THREE_2.Matrix4;
     get orthographicProjectionMatrix(): THREE_2.Matrix4;
     get orthographicProjectionMatrixInverse(): THREE_2.Matrix4;
-    updateTime(time: number, _deltaTime: number): void;
+    updateTime(time: number): void;
     get isPerspectiveCamera(): boolean;
     get isOrthographicCamera(): boolean;
     copy(source: this, recursive?: boolean): this;
@@ -257,6 +268,33 @@ export declare class CullingVolume {
     computeVisibilityWithPlaneMask(boundingVolume: BoundingVolume, parentPlaneMask: number): number;
 }
 
+export declare class CustomShader {
+    uniforms: {
+        [key: string]: THREE_2.Uniform;
+    };
+    defines: {
+        [key: string]: any;
+    };
+    type: CustomShaderInitArgs['type'];
+    vertex: VertexShaderChunks;
+    fragment: FragmentShaderChunks;
+    constructor(initArgs: CustomShaderInitArgs);
+    getHash(): string;
+    onBeforeCompile(shader: THREE_2.Shader, renderer: THREE_2.WebGLRenderer): void;
+}
+
+export declare interface CustomShaderInitArgs {
+    type: Array<'none' | 'basic' | 'phong' | 'pointcloud'>;
+    vertex?: Partial<VertexShaderChunks>;
+    fragment?: Partial<FragmentShaderChunks>;
+    uniforms?: {
+        [key: string]: any;
+    };
+    defines?: {
+        [key: string]: any;
+    };
+}
+
 /**
  * URL 地址的转换
  * @param source - url 原地址
@@ -968,6 +1006,10 @@ export declare interface FiveInitArgs {
      * 着色器精度. 可以是 "highp", "mediump" 或者 "lowp". 如果设备支持
      */
     precision?: 'highp' | 'mediump' | 'lowp';
+    /**
+     * 性能参数
+     */
+    powerPreference?: 'high-performance' | 'low-power' | 'default';
     /**
      * 是否使用webgl2渲染执行环境, 默认值 false
      */
@@ -1015,7 +1057,7 @@ export declare interface FiveLoadOptions {
     textureOptions?: TextureOptions;
     "3d-tiles"?: {
         /** 调试模式 */
-        debug?: boolean;
+        debug?: 'root-bounding-volume' | 'selected-bounding-volume' | 'none';
         /** 显示图层 */
         showLayers?: boolean | string[];
         /** 可观测区域 */
@@ -1095,6 +1137,13 @@ export declare interface FloorplanControllerCustomInitArgs {
     intersectMeshCreator?: () => IntersectMeshInterface;
 }
 
+export declare interface FragmentShaderChunks {
+    mainBefore: string;
+    mainStart: string;
+    mainModelColor: string;
+    mainEnd: string;
+}
+
 export declare interface GestureEvent extends StateEvent {
     target: EventTarget | null;
     pointerType: 'touch' | 'pen' | 'mouse' | 'kinect';
@@ -1185,7 +1234,7 @@ export declare interface ImageURLOptions {
 }
 
 export declare class InternalWebGLRenderer extends THREE_2.WebGLRenderer {
-    constructor({ preserveDrawingBuffer, premultipliedAlpha, stencil, backgroundColor, backgroundAlpha, pixelRatio, antialias, webgl2, logarithmicDepthBuffer, precision, }: {
+    constructor({ preserveDrawingBuffer, premultipliedAlpha, stencil, backgroundColor, backgroundAlpha, pixelRatio, antialias, webgl2, logarithmicDepthBuffer, precision, powerPreference, }: {
         preserveDrawingBuffer?: boolean;
         premultipliedAlpha?: boolean;
         stencil?: boolean;
@@ -1196,6 +1245,7 @@ export declare class InternalWebGLRenderer extends THREE_2.WebGLRenderer {
         webgl2?: boolean;
         logarithmicDepthBuffer?: boolean;
         precision?: 'highp' | 'mediump' | 'lowp';
+        powerPreference?: 'high-performance' | 'low-power' | 'default';
     });
 }
 
@@ -1647,40 +1697,45 @@ export declare type LegacyEventType = {
     network(source: string, type: NetworkType, state: NetworkState, detail: string): void;
 };
 
-export declare function loadAt3d(url: string, options: {
+export declare function loadAt3d(url: string, options?: {
     textureOptions?: TextureOptions;
     textureBaseUri?: string;
     textureArray?: string[];
-    fetcher: Fetcher;
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
-export declare function loadB3dm(url: string, options: {
-    upAxis: 'X' | 'Y' | 'Z';
-    fetcher: Fetcher;
+export declare function loadB3dm(url: string, options?: {
+    upAxis?: 'X' | 'Y' | 'Z';
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
-export declare function loadDome(url: string, options: {
-    textureOptions: TextureOptions;
+export declare function loadDome(url: string, options?: {
+    textureOptions?: TextureOptions;
     textureBaseUri?: string;
-    fetcher: Fetcher;
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
-export declare function loadDomez(url: string, options: {
-    textureOptions: TextureOptions;
+export declare function loadDomez(url: string, options?: {
+    textureOptions?: TextureOptions;
     textureBaseUri?: string;
-    fetcher: Fetcher;
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
-export declare function loadGlb(url: string, options: {
-    upAxis: 'Y' | 'Z';
-    fetcher: Fetcher;
+export declare function loadFbx(url: string, options?: {
+    materialType?: 'basic' | 'phong';
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
-export declare function loadPbm(url: string, options: {
+export declare function loadGlb(url: string, options?: {
+    upAxis?: 'Y' | 'Z';
+    fetcher?: Fetcher;
+}): Promise<ParsedResultType>;
+
+export declare function loadPbm(url: string, options?: {
     textureOptions?: TextureOptions;
     textureBaseUri?: string;
     textureArray?: string[];
-    fetcher: Fetcher;
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
 export declare function loadPly<Type extends 'geometry' | 'mesh' | 'points' | 'line' | 'pbmPointCloud', ResultType = {
@@ -1689,15 +1744,15 @@ export declare function loadPly<Type extends 'geometry' | 'mesh' | 'points' | 'l
     'points': THREE_2.Points<THREE_2.BufferGeometry, THREE_2.PointsMaterial>;
     'line': THREE_2.Line<THREE_2.BufferGeometry, THREE_2.LineBasicMaterial>;
     'pbmPointCloud': PBMPointCloud;
-}[Type]>(url: string, options: {
+}[Type]>(url: string, options?: {
     propertyNameMapping?: Record<string, string>;
     customPropertyMapping?: Record<string, string[]>;
     type?: Type;
-    fetcher: Fetcher;
+    fetcher?: Fetcher;
 }): Promise<ParsedResultType<ResultType>>;
 
-export declare function loadPnts(url: string, options: {
-    fetcher: Fetcher;
+export declare function loadPnts(url: string, options?: {
+    fetcher?: Fetcher;
     computeBoundingBox?: boolean;
 }): Promise<ParsedResultType>;
 
@@ -1930,6 +1985,8 @@ export declare class Model extends THREE_2.Object3D {
      */
     get clippers(): PBMParameters['clippers'];
     set clippers(clippers: PBMParameters['clippers']);
+    get customShaders(): PBMParameters['customShaders'];
+    set customShaders(customShaders: PBMParameters['customShaders']);
     /**
      * 获取模型边界线
      * @param sphere - 获取区域
@@ -1953,7 +2010,7 @@ export declare class Model extends THREE_2.Object3D {
         textureOptions?: TextureOptions;
         "3d-tiles"?: {
             /** 调试模式 */
-            debug?: boolean;
+            debug?: 'root-bounding-volume' | 'selected-bounding-volume' | 'none';
             /** 显示图层 */
             showLayers?: boolean | string[];
             /** 可观测区域 */
@@ -1998,7 +2055,7 @@ export declare interface ModelEvent extends BaseEvent {
     error: Error | null;
 }
 
-export declare type ModelMaterialValues = Omit<PBMParameters, 'clippers' | 'shownFloorIndex' | 'brightness'>;
+export declare type ModelMaterialValues = Omit<PBMParameters, 'clippers' | 'shownFloorIndex' | 'brightness' | 'customShaders'>;
 
 export declare type Models = Model[] & {
     needsRender: boolean;
@@ -2163,6 +2220,10 @@ export declare interface NetworkOptions {
 
 export declare type NetworkProgressCallback = (percent: number) => void;
 
+export declare class NetworkProxyError extends Error {
+    constructor(source: string, type: NetworkType, reason: string);
+}
+
 export declare interface NetworkResourceEvent extends BaseEvent {
     source: string;
     requestType: NetworkType;
@@ -2413,7 +2474,7 @@ export declare interface PanoTextureEvent extends BaseEvent {
 }
 
 export declare type ParsedResultType<Scene = THREE_2.Object3D> = {
-    type: 'none' | 'b3dm' | 'pnts' | 'at3d' | 'pbm' | 'dome' | 'domez' | 'glb' | 'ply';
+    type: 'none' | 'b3dm' | 'pnts' | 'at3d' | 'pbm' | 'dome' | 'domez' | 'glb' | 'ply' | 'obj' | 'fbx';
     byteLength: number;
     uri: string;
     scene: Scene;
@@ -2472,7 +2533,7 @@ export declare class PBMGroup extends THREE_2.Group {
 /** PBM 对象 */
 export declare class PBMMesh extends THREE_2.Mesh<THREE_2.BufferGeometry, PBMMeshMaterial[]> {
     constructor(geometry: THREE_2.BufferGeometry, materials: PBMMeshMaterial[]);
-    update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
+    update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model, tile?: Tile): void;
 }
 
 /** PBM 材质 */
@@ -2505,6 +2566,14 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     displacementScale: number;
     displacementBias: number;
     shininess: number;
+    /** 自定义材质*/
+    customShaders: CustomShader[];
+    /** 上一次的customShader*/
+    customShaderHash: string;
+    /** 上一次的customShaderUniforms*/
+    customShaderUniforms: Record<string, THREE_2.Uniform | undefined>;
+    /** 上一次的customShaderDefines*/
+    customShaderDefines: Record<string, any>;
     /** 起始点 */
     pano0: PBMParameters['pano0'];
     /** 结束点 */
@@ -2543,8 +2612,6 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     pointScale: PBMParameters['pointScale'];
     /** 点云背面绘制方式*/
     pointBack: PBMParameters['pointBack'];
-    /** 点云出现动画时间 */
-    pointAppearAnimationDuration: PBMParameters['pointAppearAnimationDuration'];
     /** 点云像素最小值*/
     pointMinPixel: PBMParameters['pointMinPixel'];
     /** 点云像素最大值*/
@@ -2557,13 +2624,12 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     colorBrightness: number;
     /** 所属楼层*/
     floor: number;
-    /** 点云平整度*/
-    evennessPlane: PBMParameters['evennessPlane'];
     constructor(shaderType?: 'none' | 'basic' | 'phong', parameters?: Partial<PBMParameters>);
     onBeforeCompile(shader: THREE_2.Shader, renderer: THREE_2.WebGLRenderer): void;
-    refreshUniforms(renderer: THREE_2.WebGLRenderer): void;
+    refreshUniforms(renderer?: THREE_2.WebGLRenderer): void;
     update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
     copy(source: PBMMeshMaterial): this;
+    clone(): any;
 }
 
 export declare interface PBMPanoPicture {
@@ -2579,6 +2645,8 @@ export declare interface PBMPanoPicture {
 
 /** PBM 材质参数 */
 export declare interface PBMParameters {
+    /** 自定义材质*/
+    customShaders: CustomShader[];
     /** 起始点 */
     pano0: PBMPanoPicture | null;
     /** 结束点 */
@@ -2617,8 +2685,6 @@ export declare interface PBMParameters {
     pointBack: 'VISIBLE' | 'HIDDEN' | 'DARK';
     /** 点云基础大小*/
     pointScale: number;
-    /** 点云出现动画时间 */
-    pointAppearAnimationDuration: number;
     /** 点云最小尺寸*/
     pointMinPixel: number;
     /** 点云最大尺寸*/
@@ -2629,22 +2695,24 @@ export declare interface PBMParameters {
     colorBrightness: number;
     /** 高程着色材质*/
     gradientTexture: THREE_2.Texture | null;
-    /** 点云平整度*/
-    evennessPlane: {
-        depth: number;
-        points: THREE_2.Vector3[];
-    };
 }
 
 /** PBM 对象 */
 export declare class PBMPointCloud extends THREE_2.Points<THREE_2.BufferGeometry, PBMPointCloudMaterial> {
-    private pointRange;
-    private motion;
+    private appearMotion;
     constructor(geometry: THREE_2.BufferGeometry, materials: PBMPointCloudMaterial);
-    update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
+    update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model, tile?: Tile): void;
 }
 
 export declare class PBMPointCloudMaterial extends THREE_2.ShaderMaterial implements PBMParameters {
+    /** 自定义材质*/
+    customShaders: CustomShader[];
+    /** 上一次的customShader*/
+    customShaderHash: string;
+    /** 上一次的customShaderUniforms*/
+    customShaderUniforms: Record<string, THREE_2.Uniform | undefined>;
+    /** 上一次的customShaderDefines*/
+    customShaderDefines: Record<string, any>;
     /** 更新版本 */
     syncModelVersion?: string;
     /** 起始点 */
@@ -2683,8 +2751,6 @@ export declare class PBMPointCloudMaterial extends THREE_2.ShaderMaterial implem
     pointScale: PBMParameters['pointScale'];
     /** 点云背面绘制方式*/
     pointBack: PBMParameters['pointBack'];
-    /** 点云出现动画时间 */
-    pointAppearAnimationDuration: PBMParameters['pointAppearAnimationDuration'];
     /** 点云像素最小值*/
     pointMinPixel: PBMParameters['pointMinPixel'];
     /** 点云像素最大值*/
@@ -2697,11 +2763,6 @@ export declare class PBMPointCloudMaterial extends THREE_2.ShaderMaterial implem
     colorSaturation: number;
     /** HSV亮度调整值*/
     colorBrightness: number;
-    /** 点云平整度*/
-    evennessPlane: {
-        depth: number;
-        points: THREE_2.Vector3[];
-    };
     constructor(parameters?: Partial<PBMParameters>);
     onBeforeCompile(shader: THREE_2.Shader, renderer: THREE_2.WebGLRenderer): void;
     update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
@@ -2902,10 +2963,11 @@ export declare class Subscribe<T extends SubscribeEventMap> {
     /**
      * 等待事件
      * @param name - 事件类型
+     * @param filter - 事件类型
      * @returns 触发事件的数据
      * @template K - 预设的监听事件名称
      */
-    waitUnitl<K extends keyof T>(name: K): Promise<Parameters<T[K]>>;
+    waitUntil<K extends keyof T>(name: K, filter?: (...args: Parameters<T[K]>) => boolean | void): Promise<Parameters<T[K]>>;
 }
 
 export declare type SubscribeEventMap = {
@@ -3022,6 +3084,8 @@ export declare class Tile {
         boundingVolume?: BoundingVolume;
         data?: TileContentData;
         loadState: 'LOADING' | 'UNLOADED' | 'READY' | 'FAILED';
+        loadStateUpdateTime: number;
+        loadfailRetryDelay: number;
         byteLength: number;
     } | null;
     level: number;
@@ -3083,7 +3147,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     static DEFAULT_MAX_REQUESTS: number;
     static DEFAULT_REQUEST_ORDER: TileRequestOrder;
     modelIndex: number;
-    debug: boolean;
+    debug: 'root-bounding-volume' | 'selected-bounding-volume' | 'none';
     type: 'point_cloud' | 'mesh';
     upAxis: string;
     model: Model;
@@ -3202,7 +3266,7 @@ export declare type TileCacheOptions = {
 };
 
 export declare type TileContentData = {
-    type: 'none' | 'b3dm' | 'pnts' | 'at3d' | 'pbm' | 'dome' | 'domez' | 'glb' | 'ply';
+    type: ParsedResultType['type'];
     byteLength: number;
     uri: string;
     object: TileNode;
@@ -3287,7 +3351,7 @@ export declare class TileNode extends THREE_2.Object3D {
     constructor(name: string, contentObject: THREE_2.Object3D, disposer?: () => void);
     generateBvhTree(): Promise<this>;
     intersectRaycaster(raycaster: THREE_2.Raycaster, sortByDistance?: boolean, target?: Intersection[]): Intersection[];
-    update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
+    update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model, tile: Tile): void;
     dispose(): void;
     clone(): this;
 }
@@ -3337,6 +3401,8 @@ export declare class Tileset {
     referer: string;
     hasMixedContent: boolean;
     frameNumber: number;
+    minLevelOfDetail: number;
+    maxLevelOfDetail: number;
     properties: Record<string, any>;
     options: TilesetOptions;
     root: Tile;
@@ -3421,6 +3487,7 @@ export declare interface TilesetHeader {
         numFloors?: number;
         numTotalPoints?: number;
         numTrajectories?: number;
+        pntsOrder?: "RANDOM" | "UNSORTED";
         coordinate?: {
             version: number;
             base_keyframe: number;
@@ -3431,6 +3498,10 @@ export declare interface TilesetHeader {
             pose_ecef_to_enu: number[];
             pose_enu_to_ecef: number[];
         };
+        taskParameters?: {
+            homo_point_density?: string;
+            point_homogenization?: string;
+        };
     };
 }
 
@@ -3463,6 +3534,8 @@ export declare class Trajectory {
         color: THREE_2.Color;
         data?: TrajectoryContentData;
         loadState: 'LOADING' | 'UNLOADED' | 'READY' | 'FAILED';
+        loadStateUpdateTime: number;
+        loadfailRetryDelay: number;
         byteLength: number;
     };
     constructor(index: number, header: TrajectoryHeader, tileset: Tileset);
@@ -3490,6 +3563,12 @@ export declare class TrajectoryNode extends THREE_2.Object3D {
     dispose(): void;
 }
 
+export declare interface VertexShaderChunks {
+    mainBefore: string;
+    mainStart: string;
+    mainEnd: string;
+}
+
 export declare enum VolumePlaneIntersect {
     Outside = -1,
     Intersecting = 0,