@realsee/five 6.4.0-alpha.30 → 6.4.0-alpha.32

package/five/index.d.ts

@@ -134,6 +134,7 @@ export declare class Camera extends THREE_2.Camera {
     autoNearFar: boolean;
     needsRender: boolean;
     refineModel: boolean;
+    environment: THREE_2.Texture | null;
     private lastValues;
     constructor(fov: number, aspect?: number, near?: number, far?: number, perspToOrtho?: THREE_2.Vector2, resolution?: THREE_2.Vector2, pixelRatio?: number);
     get orthoDistance(): number;
@@ -295,7 +296,7 @@ export declare class CustomShader {
 }
 
 export declare interface CustomShaderInitArgs {
-    type: Array<'none' | 'basic' | 'phong' | 'pointcloud'>;
+    type: Array<'none' | 'basic' | 'phong' | 'standard' | 'pointcloud'>;
     vertex?: Partial<VertexShaderChunks>;
     fragment?: Partial<FragmentShaderChunks>;
     uniforms?: {
@@ -316,6 +317,33 @@ export declare function defaultImageURLTransform(source: string, options: ImageU
 
 export declare const defaultPbmParameters: PBMParameters;
 
+export declare class Draco {
+    decoderPath: string;
+    private decoderPending;
+    private decoderConfig;
+    private workerLimit;
+    private workerNextTaskID;
+    private workerSourceURL;
+    private workerPool;
+    constructor();
+    setDecoderPath(decoderPath: string): void;
+    setDecoderConfig(config: any): this;
+    setWorkerLimit(workerLimit: number): this;
+    decodeDracoFile(buffer: ArrayBuffer, callback: (geometry: THREE_2.BufferGeometry) => void, attributeIDs: Record<string, string>, attributeTypes: Record<string, any>): void;
+    decodeGeometry(buffer: ArrayBuffer, taskConfig?: {
+        attributeIDs: Record<string, string>;
+        attributeTypes: Record<string, any>;
+        useUniqueIDs: boolean;
+    }): Promise<THREE_2.BufferGeometry>;
+    _createGeometry(geometryData: any): THREE_2.BufferGeometry;
+    _initDecoder(): Promise<void>;
+    _getWorker(taskID: number, taskCost: number): Promise<Worker>;
+    _releaseTask(worker: Worker, taskID: number): void;
+    dispose(): this;
+}
+
+export declare const draco: Draco;
+
 /**
  * Five 事件列表
  * @description
@@ -1068,34 +1096,27 @@ export declare interface FiveLoadOptions {
     duration?: number;
     /** 切换运动全景图效果 */
     effect?: MovePanoEffect;
-    /** 全景图游走模式下的特定参数 */
-    panorama?: ControllerCustomInitTypes["Panorama"];
-    /** 模型游走模式下的特定参数 */
-    model?: ControllerCustomInitTypes["Model"];
-    /** 模型查看模式下的特定参数 */
-    floorplan?: ControllerCustomInitTypes["Floorplan"];
-    /** 户型图模式下的特定参数 */
-    topview?: ControllerCustomInitTypes["Topview"];
-    /** 地图模式下的特定参数 */
-    mapview?: ControllerCustomInitTypes["Mapview"];
-    /** VR眼镜模式下的特定参数 */
-    vrPanorama?: ControllerCustomInitTypes["VRPanorama"];
-    /** XR眼镜模式下的特定参数 */
-    xrPanorama?: ControllerCustomInitTypes["XRPanorama"];
+    model?: {
+        light?: boolean;
+        /**
+         * 模型贴图的配置参数
+         * @description
+         * 可以动态对配置在 `work` 数据中的模型贴图在 runtime 做 url 调整。
+         * 平衡加载时间和图片质量
+         */
+        textureOptions?: TextureOptions;
+        /** 模型 3d-tile 参数 */
+        "3d-tiles"?: Tile3dOptions;
+    };
     /**
-     * 全景图的配置参数
-     * @description
-     * 可以动态对配置在 `work` 数据中的全景图片在 runtime 做 url 调整。
-     * 平衡加载时间和图片质量
+     * @deprecated
+     * 请通过 model.textureOptions 设置
      */
-    imageOptions?: ImageOptions;
+    textureOptions?: TextureOptions;
     /**
-     * 模型贴图的配置参数
-     * @description
-     * 可以动态对配置在 `work` 数据中的模型贴图在 runtime 做 url 调整。
-     * 平衡加载时间和图片质量
+     * @deprecated
+     * 请通过 model.textureOptions 设置
      */
-    textureOptions?: TextureOptions;
     "3d-tiles"?: Tile3dOptions;
 }
 
@@ -1197,13 +1218,13 @@ export declare interface ImageOptions {
      */
     transform?: (url: string, options: ImageURLOptions) => string;
     /** 图片尺寸参数 尽量使用 2 的幂次 如 512 1024 2048 */
-    size?: number;
+    size?: ImageURLOptions['size'];
     /** 图片质量参数(0-100) */
-    quality?: number;
+    quality?: ImageURLOptions['quality'];
     /** 图片格式参数 */
-    format?: "jpg" | "png" | "heif" | "webp" | "avif";
+    format?: ImageURLOptions['format'];
     /** 锐化参数 海外不支持 */
-    sharpen?: number;
+    sharpen?: ImageURLOptions['sharpen'];
     mappings?: ImageURLMappings;
 }
 
@@ -1232,7 +1253,7 @@ export declare interface ImageURLOptions {
     /** 图片质量参数(0-100) */
     quality?: number;
     /** 图片格式参数 */
-    format?: "jpg" | "png" | "heif" | "webp" | "avif";
+    format?: "jpg" | "jpeg" | "png" | "heif" | "heic" | "webp" | "avif";
     /** 图片裁切 */
     cut?: [x: number, y: number, width: number, height: number];
     /** 锐化参数 海外不支持 */
@@ -1285,6 +1306,25 @@ export declare interface IntersectMeshInterface extends THREE_2.Object3D {
 
 export declare function isPanoId(id: any): id is PanoId;
 
+export declare class KTX2 {
+    transcoderPath: string;
+    private workerPool;
+    private transcoderBinary;
+    private transcoderPending;
+    private workerSourceURL;
+    private workerConfig;
+    constructor();
+    setTranscoderPath(transcoderPath: string): void;
+    detectSupport(renderer: THREE_2.WebGLRenderer): this;
+    init(): Promise<void>;
+    parse(buffer: ArrayBuffer): Promise<THREE_2.CompressedTexture>;
+    _createTextureFrom(transcodeResult: any): Promise<THREE_2.CompressedTexture>;
+    _createTexture(buffers: ArrayBuffer[]): Promise<THREE_2.CompressedTexture>;
+    dispose(): this;
+}
+
+export declare const ktx2: KTX2;
+
 /**
  * 过时的事件列表
  */
@@ -1706,6 +1746,7 @@ export declare type LegacyEventType = {
 };
 
 export declare function loadAt3d(url: string, options?: {
+    light?: boolean;
     textureOptions?: TextureOptions;
     textureBaseUri?: string;
     textureArray?: string[];
@@ -1714,46 +1755,51 @@ export declare function loadAt3d(url: string, options?: {
 
 export declare function loadB3dm(url: string, options?: {
     upAxis?: 'Y' | 'Z';
+    light?: boolean;
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
 export declare function loadDome(url: string, options?: {
+    light?: boolean;
     textureOptions?: TextureOptions;
     textureBaseUri?: string;
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
 export declare function loadDomez(url: string, options?: {
+    light?: boolean;
     textureOptions?: TextureOptions;
     textureBaseUri?: string;
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
 export declare function loadFbx(url: string, options?: {
-    materialType?: 'basic' | 'phong';
+    light?: boolean;
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
 export declare function loadGltf(url: string, options?: {
     upAxis?: 'Y' | 'Z';
+    light?: boolean;
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
 export declare function loadPbm(url: string, options?: {
+    light?: boolean;
     textureOptions?: TextureOptions;
     textureBaseUri?: string;
     textureArray?: string[];
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
-export declare function loadPly<Type extends 'geometry' | 'mesh' | 'points' | 'line' | 'pbmPointCloud', ResultType = {
+export declare function loadPly<Type extends 'geometry' | 'line' | 'pbmMesh' | 'pbmPointCloud', ResultType = {
     'geometry': THREE_2.BufferGeometry;
-    'mesh': THREE_2.Mesh<THREE_2.BufferGeometry, THREE_2.MeshBasicMaterial>;
-    'points': THREE_2.Points<THREE_2.BufferGeometry, THREE_2.PointsMaterial>;
-    'line': THREE_2.Line<THREE_2.BufferGeometry, THREE_2.LineBasicMaterial>;
+    'line': THREE_2.Line<THREE_2.BufferGeometry>;
+    'pbmMesh': PBMMesh;
     'pbmPointCloud': PBMPointCloud;
 }[Type]>(url: string, options?: {
     upAxis?: 'Y' | 'Z';
+    light?: boolean;
     propertyNameMapping?: Record<string, string>;
     customPropertyMapping?: Record<string, {
         itemType: 'float32' | 'uint32' | 'int32' | 'uint16' | 'int16' | 'uint8' | 'int8';
@@ -1771,7 +1817,7 @@ export declare function loadPnts(url: string, options?: {
 
 export declare function loadX3p(url: string, options?: {
     color?: THREE_2.Color;
-    materialType?: 'basic' | 'phong';
+    light?: boolean;
     fetcher?: Fetcher;
 }): Promise<ParsedResultType>;
 
@@ -2035,6 +2081,7 @@ export declare class Model extends THREE_2.Object3D {
      * @param options - 图片参数
      */
     load(work: Work, options?: {
+        light?: boolean;
         textureOptions?: TextureOptions;
         "3d-tiles"?: Tile3dOptions;
     }): Promise<void>;
@@ -2480,6 +2527,7 @@ export declare type ParsedResultType<Scene = THREE_2.Object3D> = {
     type: 'unknown' | 'b3dm' | 'pnts' | 'at3d' | 'pbm' | 'dome' | 'domez' | 'gltf' | 'ply' | 'obj' | 'fbx' | 'x3p';
     upAxis: 'Z';
     byteLength: number;
+    memoryUsage: number;
     uri: string;
     scene: Scene;
     textures: THREE_2.Texture[];
@@ -2542,11 +2590,12 @@ export declare class PBMMesh extends THREE_2.Mesh<THREE_2.BufferGeometry, PBMMes
 
 /** PBM 材质 */
 export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements PBMParameters {
-    shaderType: 'none' | 'basic' | 'phong';
+    shaderType: 'none' | 'basic' | 'phong' | 'standard';
     /** 更新版本 */
     syncModelVersion?: string;
     /** 内置参数 */
     color: THREE_2.Color;
+    colorAlpha: number;
     map: THREE_2.Texture | null;
     lightMap: THREE_2.Texture | null;
     lightMapIntensity: number;
@@ -2554,8 +2603,15 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     aoMapIntensity: number;
     specularMap: THREE_2.Texture | null;
     specular: THREE_2.Color;
+    roughnessMap: THREE_2.Texture | null;
+    roughness: number;
+    metalnessMap: THREE_2.Texture | null;
+    metalness: number;
     alphaMap: THREE_2.Texture | null;
+    alphaMode: 'OPAQUE' | 'MASK' | 'BLEND';
+    combine: THREE_2.Combine;
     envMap: THREE_2.Texture | THREE_2.CubeTexture | null;
+    envMapIntensity: number;
     reflectivity: number;
     refractionRatio: number;
     emissiveMap: THREE_2.Texture | null;
@@ -2626,9 +2682,15 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     colorSaturation: number;
     /** HSV亮度调整值*/
     colorBrightness: number;
+    /** outline增益*/
+    outlineGain: number;
+    /** distance增益 */
+    distanceGain: number;
+    /** 半透明叠加渲染*/
+    useAddBlend: boolean;
     /** 所属楼层*/
-    floor: number;
-    constructor(shaderType?: 'none' | 'basic' | 'phong', parameters?: Partial<PBMParameters>);
+    floorIndex: number;
+    constructor(shaderType?: 'none' | 'basic' | 'phong' | 'standard', parameters?: Partial<PBMParameters>);
     onBeforeCompile(shader: THREE_2.Shader, renderer: THREE_2.WebGLRenderer): void;
     refreshUniforms(renderer?: THREE_2.WebGLRenderer): void;
     update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
@@ -2697,6 +2759,12 @@ export declare interface PBMParameters {
     colorSaturation: number;
     /** 亮度调整值*/
     colorBrightness: number;
+    /** 半透明叠加渲染*/
+    useAddBlend: boolean;
+    /** outline增益*/
+    outlineGain: number;
+    /** distance增益*/
+    distanceGain: number;
     /** 高程着色材质*/
     gradientTexture: THREE_2.Texture | null;
 }
@@ -2762,11 +2830,17 @@ export declare class PBMPointCloudMaterial extends THREE_2.ShaderMaterial implem
     /** 高程彩色图*/
     gradientTexture: PBMParameters['gradientTexture'];
     /** 所属楼层*/
-    floor: number;
+    floorIndex: number;
     /** 饱HSV和度调整值*/
     colorSaturation: number;
     /** HSV亮度调整值*/
     colorBrightness: number;
+    /** outline增益*/
+    outlineGain: number;
+    /** distance增益*/
+    distanceGain: number;
+    /** 半透明叠加渲染*/
+    useAddBlend: boolean;
     constructor(parameters?: Partial<PBMParameters>);
     onBeforeCompile(shader: THREE_2.Shader, renderer: THREE_2.WebGLRenderer): void;
     update(renderer: THREE_2.WebGLRenderer, camera: Camera, model: Model): void;
@@ -3092,6 +3166,7 @@ export declare class Tile {
         loadStateUpdateTime: number;
         loadfailRetryDelay: number;
         byteLength: number;
+        memoryUsage: number;
     } | null;
     level: number;
     levelOfContent: number;
@@ -3136,6 +3211,7 @@ export declare class Tile {
     get hasEmptyContent(): boolean;
     get contentReady(): boolean;
     get contentByteLength(): number;
+    get contentMemoryUsage(): number;
     getScreenSpaceError(frameState: TilesetFrameState, distanceToCamera: number, useParentGeometricError: boolean): number;
     getPriority(): number;
 }
@@ -3151,6 +3227,10 @@ export declare interface Tile3dLayerOptions {
     minLevelOfDetail?: number;
     /** 模型显示最大细化层级 */
     maxLevelOfDetail?: number;
+    /** 模型显示最小细化误差 */
+    minGeometricError?: number;
+    /** 模型显示最大细化误差 */
+    maxGeometricError?: number;
     /** 模型越层级加载 */
     skipLevelOfDetail?: boolean;
     /** 模型是否最密 */
@@ -3170,8 +3250,11 @@ export declare interface Tile3dLayerOptions {
 }
 
 export declare class Tile3DModel extends THREE_2.Object3D {
+    static DEFAULT_PANORAMA_MIN_GEOMETRIC_ERROR: number;
     static DEFAULT_MIN_LEVEL_OF_DETAIL: number;
     static DEFAULT_MAX_LEVEL_OF_DETAIL: number;
+    static DEFAULT_MIN_GEOMETRIC_ERROR: number;
+    static DEFAULT_MAX_GEOMETRIC_ERROR: number;
     static DEFAULT_MAX_MEMORY_USAGE: number;
     static DEFAULT_MAX_SCREEN_SPACE_ERROR: number;
     static DEFAULT_SKIP_LEVEL_OF_DETAIL: boolean;
@@ -3184,6 +3267,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     modelsLoaded: any;
     debug: 'root-bounding-volume' | 'selected-bounding-volume' | 'none';
     type: 'point_cloud' | 'mesh';
+    light: boolean;
     upAxis: string;
     model: Model;
     viewLayer?: ModelViewLayer;
@@ -3201,7 +3285,9 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     tileset: Tileset;
     minLevelOfDetail: number;
     maxLevelOfDetail: number;
-    panoramaMaxLevelOfDetail: number;
+    maxGeometricError: number;
+    minGeometricError: number;
+    panoramaMinGeometricError: number;
     boundingBox: THREE_2.Box3;
     needsRefined: boolean;
     refined: boolean;
@@ -3243,6 +3329,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
     set loadAll(value: boolean);
     get maxScreenSpaceError(): number;
     set maxScreenSpaceError(value: number);
+    get currentScreenSpaceError(): number;
     get trajectories(): Trajectory[];
     localToEnu(vector: THREE_2.Vector3): THREE_2.Vector3;
     enuToLocal(vector: THREE_2.Vector3): THREE_2.Vector3;
@@ -3270,6 +3357,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
 /** Advanced loader options */
 export declare interface Tile3DModelLoaderOptions {
     name: string;
+    light: boolean;
     type: 'point_cloud' | 'mesh';
     upAxis: string;
     url: string;
@@ -3312,6 +3400,7 @@ export declare type TileCacheOptions = {
 export declare type TileContentData = {
     type: ParsedResultType['type'];
     byteLength: number;
+    memoryUsage: number;
     uri: string;
     object: TileNode;
 };
@@ -3421,6 +3510,8 @@ export declare type TileRequestSchedulerOptions = {
 
 export declare class Tileset {
     static DEFAULT_MAX_MEMORY_USAGE: number;
+    static DEFAULT_MEMORY_OVERFLOW: number;
+    static DEFAULT_MEMORY_ADJUSTED_SCREEN_SPACE_ERROR: boolean;
     static DEFAULT_MAX_SCREEN_SPACE_ERROR: number;
     static DEFAULT_SKIP_LEVEL_OF_DETAIL: boolean;
     static DEFAULT_MOST_DETAIL: boolean;
@@ -3448,6 +3539,8 @@ export declare class Tileset {
     frameNumber: number;
     minLevelOfDetail: number;
     maxLevelOfDetail: number;
+    minGeometricError: number;
+    maxGeometricError: number;
     properties: Record<string, any>;
     options: TilesetOptions;
     root: Tile;
@@ -3456,13 +3549,19 @@ export declare class Tileset {
     transformIsIdentity: boolean;
     geometricError: number;
     cache: TileCache;
+    currentScreenSpaceError: number;
     requestScheduler: TileRequestScheduler;
+    private memoryUsageInBytes;
     private normalTraverser;
     private skipTraverser;
     private mostDetailTraverser;
-    private memoryUsageInBytes;
     maxMemoryUsage: number;
+    memoryOverflow: number;
+    memoryAdjustedScreenSpaceError: boolean;
     maxScreenSpaceError: number;
+    dynamicScreenSpaceErrorDensity: number;
+    dynamicScreenSpaceErrorFactor: number;
+    dynamicScreenSpaceErrorHeightFalloff: number;
     skipLevelOfDetail: boolean;
     mostDetail: boolean;
     loadSiblings: boolean;
@@ -3479,6 +3578,7 @@ export declare class Tileset {
     pointLength: number;
     floorLength: number;
     constructor(id: string, header: TilesetHeader, options: TilesetOptions);
+    private adjustScreenSpaceError;
     private get traverser();
     /** Release resources */
     reset(): void;
@@ -3490,11 +3590,10 @@ export declare type TilesetFrameState = {
     time: number;
     camera: {
         type: "PerspectiveCamera" | "OrthographicCamera";
-        near: number;
-        far: number;
         position: THREE.Vector3;
         direction: THREE.Vector3;
         up: THREE.Vector3;
+        projectionMatrix: THREE.Matrix4;
         visible: boolean;
         refine: boolean;
     };
@@ -3504,6 +3603,8 @@ export declare type TilesetFrameState = {
     sseDenominator: number;
     minLevelOfDetail: number;
     maxLevelOfDetail: number;
+    minGeometricError: number;
+    maxGeometricError: number;
 };
 
 export declare interface TilesetHeader {
@@ -3597,12 +3698,14 @@ export declare class Trajectory {
         loadStateUpdateTime: number;
         loadfailRetryDelay: number;
         byteLength: number;
+        memoryUsage: number;
     };
     constructor(index: number, header: TrajectoryHeader, tileset: Tileset);
 }
 
 export declare type TrajectoryContentData = {
     byteLength: number;
+    memoryUsage: number;
     uri: string;
     object: TrajectoryNode;
     positionArray: ArrayLike<number>;