@realsee/five 5.0.0-alpha.92 → 5.0.0-alpha.93

package/five/index.d.ts

@@ -1227,11 +1227,11 @@ export declare interface ImageOptions {
      * @returns 转化后地址
      */
     transform?: (url: string, options: ImageURLOptions) => string;
-    /** 图片尺寸参数 */
+    /** 图片尺寸参数 尽量使用 2 的幂次 如 512 1024 2048 */
     size?: number;
     /** 图片质量参数(0-100) */
     quality?: number;
-    /** 图片格式参数（jpg, png） */
+    /** 图片格式参数 */
     format?: "jpg" | "png" | "heif" | "webp" | "avif";
 }
 
@@ -1266,10 +1266,41 @@ export declare interface Intersection {
     distance: number;
 }
 
+export declare class IntersectMesh extends THREE_2.Object3D implements IntersectMeshInterface {
+    private ringMesh;
+    constructor();
+    dispose(): void;
+}
+
+/**
+ * 地面提示点位接口
+ */
 export declare interface IntersectMeshInterface extends THREE_2.Object3D {
     dispose(): void;
 }
 
+export declare class LegacyPanoCircleMesh extends THREE_2.Object3D implements PanoCircleMeshInterface {
+    needsRender: boolean;
+    current: boolean;
+    loading: boolean;
+    disabled: boolean;
+    progress: number;
+    opacity: number;
+    private centerMesh;
+    private loadingMesh;
+    private progressMotion;
+    private opacityMotion;
+    private stopInterval?;
+    constructor();
+    setLoading(shown: boolean): void;
+    setDisabled(disabled: boolean): void;
+    setProgress(progress: number): void;
+    setOpacity(opacity: number): void;
+    setCurrent(current: boolean): void;
+    updateTime(time: number, deltaTime: number): void;
+    dispose(): void;
+}
+
 export declare type LooseWork = {
     bvh?: boolean;
     modelAsync?: boolean;
@@ -1578,6 +1609,37 @@ export declare class NetworkSubscribe extends Subscribe<{
 
 export declare type NetworkType = "XMLHttpRequest" | "Script" | "Image" | "Link";
 
+export declare class PanoCircleMesh extends THREE_2.Object3D implements PanoCircleMeshInterface {
+    needsRender: boolean;
+    private loadingMesh;
+    private disableMesh;
+    private centerMesh;
+    private ringMesh;
+    private progressMesh;
+    private ringRotateMotion;
+    private tapMotion;
+    private progressMotion;
+    private progressOpacityMotion;
+    private opacityMotion;
+    progress: number;
+    opacity: number;
+    current: boolean;
+    loading: boolean;
+    disabled: boolean;
+    constructor();
+    setProgress(progress: number): void;
+    setOpacity(opacity: number): void;
+    setCurrent(current: boolean): void;
+    setLoading(loading: boolean): void;
+    setDisabled(disabled: boolean): void;
+    tap(): Promise<void>;
+    updateTime(time: number, deltaTime: number): void;
+    dispose(): void;
+}
+
+/**
+ * 地面提示点位接口
+ */
 export declare interface PanoCircleMeshInterface extends THREE_2.Object3D {
     needsRender: boolean;
     /** 当前高亮 */
@@ -1585,14 +1647,16 @@ export declare interface PanoCircleMeshInterface extends THREE_2.Object3D {
     /** 是否当前高亮 */
     setCurrent(current: boolean): void;
     loading: boolean;
-    setLoading(shown: boolean): void;
+    setLoading(loading: boolean): void;
     disabled: boolean;
     setDisabled(disabled: boolean): void;
     progress: number;
     setProgress(progress: number): void;
     opacity: number;
     setOpacity(opacity: number): void;
-    updateTime(time: number, deltaTime: number): void;
+    updateTime?(time: number, deltaTime: number): void;
+    /** 点击交互 */
+    tap?(): Promise<void>;
     dispose(): void;
 }
 
@@ -1879,11 +1943,11 @@ export declare interface TextureOptions {
      * @returns 转化后地址
      */
     transform?: (url: string, options: ImageURLOptions) => string;
-    /** 图片尺寸参数 */
+    /** 图片尺寸参数 尽量使用 2 的幂次 如 256 512 1024 */
     size?: number;
     /** 图片质量参数(0-100) */
     quality?: number;
-    /** 图片格式参数（jpg, png） */
+    /** 图片格式参数 */
     format?: "jpg" | "png" | "heif" | "webp" | "avif";
     /** 针对 textureOptions 是否自动通过模型贴图的数量计算需要的模型贴图的尺寸 默认 true */
     autoResize?: boolean;
@@ -1902,32 +1966,50 @@ export declare interface VRPanoramaControllerCustomInitArgs extends Omit<Panoram
 }
 
 export declare class Work {
+    /** 名称 */
     name: string;
+    /** 编号 */
     workCode: string;
+    /** 允许访问的安全域名 */
     allowHosts: string[];
+    /** 过期时间 */
     expire: Date;
+    /** 初始化参数 */
     initial: WorkInitial;
+    /** 模型参数 */
     model?: WorkModel;
+    /** 全景点位信息 */
     observers: WorkObserver[];
+    /** 数据签发人 */
     issuer: string;
+    /** 原始数据 */
     raw: any;
     constructor();
     toJSON(): any;
 }
 
 export declare interface WorkCubeImage {
+    /** 全景图 up */
     up: string;
+    /** 全景图 down */
     down: string;
+    /** 全景图 right */
     right: string;
+    /** 全景图 left */
     left: string;
+    /** 全景图 front */
     front: string;
+    /** 全景图 back */
     back: string;
 }
 
 /** 全景图 */
 export declare interface WorkImage extends WorkCubeImage {
+    /** 深度图 */
     depth?: string;
+    /** 光照强度图 */
     luminance?: WorkCubeImage;
+    /** 瓦片信息 */
     tiles?: WorkTile[];
 }
 
@@ -1937,24 +2019,39 @@ export declare interface WorkInitial extends Omit<State, "offset"> {
 
 /** 模型数据 */
 export declare interface WorkModel {
+    /** 模型文件地址 at3d / domez */
     file: string;
+    /** 模型贴图文件地址 */
     textures: string[];
+    /** 模型贴图文件地址的父目录 */
     textureBase: string;
+    /** 是否开启 bvh 碰撞树，开启会大大加快射线碰撞的执行效率 */
     bvh: boolean;
 }
 
 /** 每个点位的数据 */
 export declare interface WorkObserver {
+    /** 点位序号 */
     panoIndex: number;
+    /** 点位是否激活可用 */
     active: boolean;
+    /** 点位是否可加载 */
     loadable: boolean;
+    /** 点位全景图 */
     images: WorkImage;
+    /** 点位视频 */
     video?: WorkVideo;
+    /** 可以看到的相关点位序号 */
     visibleNodes: number[];
+    /** 可以连通的相关点位序号 */
     accessibleNodes: number[];
+    /** 点位和模型的旋转对齐关系四元数 */
     quaternion: THREE_2.Quaternion;
+    /** 点位和模型的地面位置坐标关系 */
     standingPosition: THREE_2.Vector3;
+    /** 点位和模型的观察点坐标关系 */
     position: THREE_2.Vector3;
+    /** 点位所在楼层 */
     floorIndex: number;
 }
 
@@ -1971,8 +2068,11 @@ export declare interface WorkTile {
 
 /** 全景视频贴片 */
 export declare interface WorkVideo {
+    /** 视频源 url */
     source: string;
+    /** 视频源变化矩阵 */
     matrix: THREE_2.Matrix4;
+    /** 视频源长宽尺寸 */
     size: THREE_2.Vector2;
 }