@aibee/owlly 1.0.25 → 1.0.29

package/lib/owlly/element/panorama-group.d.ts

@@ -0,0 +1,241 @@
+import { NS_THREE } from '../stage/externals';
+import { Element, ElementFrameContext } from './element';
+import { Panorama, PanoramaViewConfiguration } from './panorama';
+import { View } from '../view/view';
+import { GroundParameters } from './floor-model';
+/** 全景点位显示模式
+ * 点位的显示/隐藏状态通过[setIndicatorVisibility]方法设置，
+ * 但是最终是否显示、以何外观显示，则是结合PanoramaGroup在当前View的显示模式来决定
+ * @param AlwaysHide 不论显示/隐藏的设置如何，都不显示
+ * @param AlwaysShow 不论显示/隐藏的设置如何，都不显示。该模式主要用于俯视全局视图用
+ * @param Editing 编辑模式，隐藏/显示状态的点位用不同的外观显示
+ * @param Show 按显示/隐葳的状态设置决定是否显示
+*/
+declare enum IndicatorDisplayMode {
+    AlwaysHide = 0,
+    AlwaysShow = 1,
+    Editing = 2,
+    Show = 3
+}
+/**
+ * 全景图组显示状态配置
+ */
+interface PanoramaGroupViewConfiguration {
+    targetView: View;
+    hidden?: boolean;
+    /** 可视范围半径，会根据此数值来决定预加载哪些全景图以及显示哪些点位 */
+    visibleRadius?: number;
+    /** 全景点位显示模式 */
+    indicatorDisplayMode?: IndicatorDisplayMode;
+    /** 是否显示模型包围盒，用于全景漫游时 */
+    showBoundBox?: boolean;
+}
+interface PanoramaData {
+    pid: number;
+    seqID: number;
+    textureURLs: string[];
+    neighbourPanoramaIDs: number[];
+    highTextureURLs?: string[];
+    useLowTextureURLsOnly?: boolean;
+    tiledTextureURLRoot?: string;
+    position?: NS_THREE.Vector3;
+    quaternion?: NS_THREE.Quaternion;
+    legacyMode?: boolean;
+}
+/**
+ * 全景图组
+ * @noInheritDoc
+ */
+declare class PanoramaGroup extends Element {
+    private initialized;
+    private needUpdate;
+    modelElement: NS_THREE.Object3D | null;
+    private groundParams?;
+    boundBox: NS_THREE.Mesh | null;
+    currentPanoramaID: number;
+    panoramaDatas: Map<number, PanoramaData>;
+    private panoramaMap;
+    private indicatorMeshPrototype;
+    private indicatorMaterials;
+    private indicatorShaderUniforms;
+    private invisibleIndicatorShaderUniforms;
+    private indicatorMap;
+    private inSightIndicators;
+    private indicatorVisibilityMap;
+    private indicatorHiddenMap;
+    private indicatorPositionMap;
+    private indicatorImageURL;
+    private indicatorWidth;
+    private indicatorHeight;
+    private panoramaCreatingTasks;
+    group: NS_THREE.Group;
+    private viewConfigurations;
+    private eventListeners;
+    maxWorldDistance: number;
+    static DefaultVisibleRadius: number;
+    static IndicatorRadius: number;
+    static IndicatorOffsetZ: number;
+    private globalScale;
+    /**
+     * @param modelElement 模型对象，通常应该是FloorModel
+     * @param groundParams 地面参数对象，若有则在计算地面高度时忽略modelElement，优先使用它
+     * @param indicatorImageURL 显示状态全景点地面标识的图片URL
+     * @param invisibleIndicatorImageURL 编辑模式下隐藏状态全景点地面标识的图片URL
+     * @param indicatorWidth 全景点地面标识宽度
+     * @param indicatorHeight 全景点地面标识高度
+     * @example
+     * ``` typescript
+     * panoMgr = new PanoramaGroup(panoramaDataList, 2, {
+     *  floorModel,
+     *  groundParams,
+     * });
+     * stage.bindElement(panoMgr);
+     */
+    constructor(panoramaDataList: PanoramaData[], options: {
+        modelElement?: NS_THREE.Object3D;
+        groundParams?: GroundParameters;
+        indicatorImageURL?: string;
+        invisibleIndicatorImageURL?: string;
+        indicatorWidth?: number;
+        indicatorHeight?: number;
+        indicatorPositionMap?: Map<number, NS_THREE.Vector3>;
+        globalScale?: number;
+    }, initializeAllPanoramas?: boolean);
+    dispose(exceptForCubeTextureOfPID?: number): void;
+    /**
+     * @ignore
+     */
+    update(): ElementFrameContext;
+    /**
+     * 绑定模型Element对象（用于创建天空包围盒供全景切换时使用）
+     * @param modelElement 模型Element对象
+     */
+    bindModelElement(modelElement?: NS_THREE.Object3D): void;
+    static getBoundBox(rootObj: NS_THREE.Object3D | null): NS_THREE.Mesh | null;
+    private getModelBoundBox;
+    setBoundBoxAppearance(material: NS_THREE.Material): void;
+    private setBoundBoxVisible;
+    /**
+     * 加载指定全景图并加入场景（显示要通过PanoramaController）
+     * @param panorama 要加载的全景图
+     */
+    presentPanorama(panorama: Panorama, hdTiles: number[][], ldTiles: number[][]): Promise<void>;
+    /**
+     * 加载指定PID的全景图并加入场景（显示要通过PanoramaController）
+     * @param pid 要加载的全景图ID
+     */
+    presentPanoramaOfPID(pid: number, hdTiles: number[][], ldTiles: number[][]): Promise<void>;
+    /**
+     * 获取一组全景点的立方体贴图，若没命中则异步加载
+     * @param pids 全景点ID数组
+     * @param waitForReadyCount 指定函数必须在pids中的前多少个全景点立方体贴图获取到以后才能返回
+     * 比如在即将显示一个全景点时，指定必须等指定全景点的立方体贴图获取到后才能返回，而其周围全景点可以同时预加载但不用等
+     */
+    preloadCubeTexturesOfPIDs(pids: number[], waitForReadyCount: number): Promise<NS_THREE.CubeTexture[]>;
+    private visibleRadiusOfView;
+    private allPanoramas;
+    getAllPanoramas(): Promise<(Panorama | undefined)[]>;
+    panoramaIDsAround(centerPID: number, view?: View): number[] | null;
+    /**
+     * 设置当前位于的全景点位。将加载指定全景点并预加载其相邻全景点
+     * @param {number} currentPID 全景点位ID
+     */
+    presentPanoramaAround(currentPID: number, hdTiles: number[][], ldTiles: number[][], view?: View): Promise<void>;
+    /** @ignore */
+    private getPIDPositionMap;
+    getIndicatorPosition(pid: number): NS_THREE.Vector3 | undefined;
+    /**
+     * 显示指定全景点位标签
+     * @param pidPositionMap 从PID映射到全景点位位置的Map
+     */
+    presentPanoramaIndicators(pidPositionMap: Map<number, NS_THREE.Vector3>): void;
+    updateIndicatorsPositions(): Promise<void>;
+    /**
+     * 显示指定全景点及其相邻全景点上的标签
+     * @param pid “中心”全景点ID，一般指摄像机当前所在的全景点PID
+     */
+    presentPanoramaIndicatorsAround(pid: number, view?: View): Promise<void>;
+    getIndicatorVisibility(pid: number): boolean;
+    /**
+     * 设置指定全景点位的显示/隐藏状态
+     * @param visibility 显示/隐藏状态
+     * @param pid 可选，可以是全景图点位PID数组，也可以是单个PID,
+     * 若不设置则应用到本PanoramaGroup的所有全景点位上
+     */
+    setIndicatorVisibility(visibility: boolean, pid?: number | number[]): void;
+    setIndicatorHidden(hidden: boolean, pid?: number | number[]): void;
+    /**
+     * 与全景点标志作相交测试
+     * 若有任一个全景点标志与射线相交则返回最近一个的相应PID
+     * 若没有则返回-1
+     * @param rayOrigin 射线起点
+     * @param rayDirection 射线方向
+     */
+    intersectIndicators(rayOrigin: NS_THREE.Vector3, rayDirection: NS_THREE.Vector3): number;
+    intersectIndicatorsOnScreen(screenPosition: NS_THREE.Vector2, radius: number, { screenWidth, screenHeight }: {
+        screenWidth: number;
+        screenHeight: number;
+    }, camera: NS_THREE.Camera): number;
+    /**
+     * 添加全景点
+     * @param {Panorama} pano 全景图对象
+     */
+    putPanorama(pano: Panorama): void;
+    /**
+     * 指定预构建全景对象的顺序策略
+     * @param preInitStrategy 多义参数，表示具体的创建顺序
+     * 当为'all'时，直接按构造函数中panoramaDataList的顺序创建全部全景对象
+     * 当为一个整数值时，表示一个全景PID，将按全景点邻接关系以广度优先搜索的顺序创建全景对象
+     * 当为一个整数数组时，以数组指定的PID顺序依次创建
+     */
+    initializePanoramasIfNecessary(preInitStrategy: 'all' | number | number[]): Promise<(Panorama | undefined)[]>;
+    /**
+     * 获得指定ID的全景点对象
+     * @param pid 全景点ID
+     */
+    getPanoramaByPID(pid: number): Promise<Panorama | undefined>;
+    /**
+     * 立刻获得指定ID的全景点对象
+     * @param pid 全景点ID
+     */
+    getPanoramaByPIDInstant(pid: number): Panorama | null;
+    /**
+     * @ignore
+     * @param rayDirection
+     */
+    getNeghbourPanoClosestToRay(rayDirection: NS_THREE.Vector3): number;
+    updateIndicatorGeometry(): void;
+    /**
+     * 改变地面全景点标识的尺寸
+     * @param width 宽度
+     * @param height 高度
+     */
+    setIndicatorSize(width: number, height: number): void;
+    setIndicatorImageURL(url: string): void;
+    /**
+     * 查询当前设置的地面全景点标识尺寸
+     * @returns number数组，依次是width, height
+     */
+    getIndicatorSize(): number[];
+    setIndicatorMeshPrototype(mesh: NS_THREE.Mesh): void;
+    /**
+     * 设定全景点位标签的原型对象，每个全景点位的标签会以该原型对象为母本clone出来
+     * @param prototypeObject 点位标签原型Object3D对象
+     * @param mode 点位的展示模式
+     * @param visibility 点位的显隐状态设置
+     */
+    setIndicatorMaterial(material: NS_THREE.Material, mode: IndicatorDisplayMode, visibility: boolean): void;
+    getIndicatorMaterial(mode: IndicatorDisplayMode, visibility: boolean): NS_THREE.Material | undefined;
+    /**
+     * 配置全景图组在不同view中的显示状态
+     * @param configuration 全景图组配置，见[[PanoramaGroupViewConfiguration]]
+     */
+    addGroupViewConfiguration(configuration: PanoramaGroupViewConfiguration): void;
+    /**
+     * 配置组中所有全景图在不同view中的显示状态
+     * @param configuration 全景图显示配置
+     */
+    addViewConfiguration(configuration: PanoramaViewConfiguration): Promise<void>;
+    setMaxWorldDistance(distance: number): void;
+}
+export { PanoramaGroup, IndicatorDisplayMode, PanoramaGroupViewConfiguration, PanoramaData, };