@aibee/owlly 1.0.25

package/lib/src/owlly/controller/panorama-controller.d.ts

@@ -0,0 +1,441 @@
+import { NS_THREE } from '../stage/externals';
+import { Controller } from './controller';
+import { PanoramaGroup } from '../element/panorama-group';
+import { View } from '../view/view';
+import { Element } from '../element/element';
+import { Panorama } from '../element/panorama';
+/**
+ * 在升级至瓦片后, 停止使用该控制器
+ */
+declare class PanoramaController extends Controller {
+    private orbitControl;
+    private mouseDownHandler;
+    private mouseMoveHandler;
+    private mouseUpHandler;
+    private mouseWheelHandler;
+    private touchStartHandler;
+    private touchMoveHandler;
+    private touchEndHandler;
+    private touches;
+    private isAnimating;
+    private translatePromise;
+    private panoramaGroups;
+    private currentPanoramaGroup;
+    private pid2GroupMap;
+    private modelMaterial;
+    private instantTranslationMaterial;
+    private raycaster;
+    private elements;
+    private view;
+    private renderFrame;
+    private static RotateSpeed;
+    private static DirectionVectorScalar;
+    private moveOnClick;
+    private hidePanoramas;
+    private showModel;
+    private fovRange;
+    private onScreenDetectRadius;
+    private rotationLocks;
+    private captureMove;
+    rotateSpeed: number;
+    private panoramaGroupChanged;
+    private cancelAnimation;
+    /**
+     * 获得模型顶点着色器
+     * @ignore
+     * @returns {string} 顶点着色器代码
+     */
+    static getModelVS(): string;
+    static getInstantTranslationVS(): string;
+    /**
+     * 获得模型片源着色器
+     * @ignore
+     * @returns {string} 片源着色器代码
+     */
+    static getModelFS(): string;
+    static debugModelVS(): string;
+    static debugModelFS(): string;
+    dispose(): Promise<void>;
+    /**
+     *
+     * @param view 绑定的View
+     * @param panoramaGroups 全景图组数组，至少需要有一个元素
+     * @param showModel 可选，是否一开始就显示模型
+     * @example
+     * ``` typescript
+     * panoCtl = new PanoramaController(view, panoMgr);
+     * panoCtl.setMouseClickEnabled(true);
+     * stage.bindController(panoCtl);
+     * panoCtl.lookFromPanorama(0, new Vector3(-1, 0, 0));
+     */
+    constructor(view: View, panoramaGroups?: PanoramaGroup | PanoramaGroup[], showModel?: boolean);
+    setViewConfiguration(hidePanoramas: boolean, showModel: boolean): Promise<void>;
+    bindElement(element: Element | Element[]): void;
+    unbindElement(element: Element | Element[]): void;
+    /**
+     * 添加全景图组
+     * @param panoramaGroups 新增加的全景图组（单个或数组）
+     * @parama showModel 可选，是否一开始就显示模型
+     */
+    addPanoramaGroups(panoramaGroups: PanoramaGroup | PanoramaGroup[], showModel?: boolean): void;
+    removePanoramaGroup(panoramaGroup: PanoramaGroup): boolean;
+    protected renderThisFrame(): void;
+    private static getModelMeshInElement;
+    private static getModelMesh;
+    bindView(view: View): void;
+    unbind(): Promise<void>;
+    /**
+     * @ignore
+     */
+    update(): boolean;
+    /**
+     * 设置是否启用该控制器
+     * @param value 开关值
+     */
+    setEnabled(value: boolean): void;
+    /**
+     * 设置键盘控制启用
+     * @param value 是否启用键盘控制
+     */
+    setKeysEnabled(value: boolean): void;
+    /**
+     * 使能/禁用 鼠标点击
+     * @param value 使能还是禁用
+     */
+    setMouseClickEnabled(enable: boolean): boolean;
+    setTouchEnabled(enable: boolean): boolean;
+    /**
+     * 设置是否启用惯性
+     * @param value 开关值
+     */
+    setDampingEnabled(value: boolean): void;
+    /**
+     * 设置是否启用旋转功能
+     * @param value 开关值
+     */
+    setRotateEnabled(value: boolean): void;
+    /**
+     * 设置是否启用平移功能
+     * @param value 开关值
+     */
+    setPanEnabled(value: boolean): void;
+    /**
+     * 设置是否启用缩放功能
+     * @param value 开关值
+     */
+    setZoomEnabled(value: boolean): void;
+    /**
+     * 设置缩放
+     * @param zoom 缩放比例值
+     */
+    setZoom(zoom: number): void;
+    /**
+     * 设置FOV, 不可以超过setFOVRange所设置的范围.
+     * @param fov 垂直方向视场角
+     */
+    setFOV(fov: number): void;
+    /**
+     * 设置FOV范围, 默认为[60, 90]
+     * @param min 垂直方向视场角最小值
+     * @param max 垂直方向视场角最大值
+     */
+    setFOVRange(min: number, max: number): void;
+    /**
+     * 设置惯性阻尼
+     * @param value 衰减值
+     */
+    setDampingFactor(value: number): void;
+    /**
+     * 设置位移速度
+     * @param value 位移速度
+     */
+    setPanSpeed(value: number): void;
+    /**
+     * 设置旋转速度
+     * @param value 旋转速度
+     */
+    /**
+     * 设置触摸操作模式
+     * @param touches 触摸配置
+     */
+    setTouchControls(touches: {
+        ONE: NS_THREE.TOUCH;
+        TWO: NS_THREE.TOUCH;
+    }): void;
+    /**
+     * 设置鼠标操作模式
+     * @param mouseButtons 鼠标按键配置
+     */
+    setMouseControls(mouseButtons: {
+        LEFT: NS_THREE.MOUSE;
+        MIDDLE: NS_THREE.MOUSE;
+        RIGHT: NS_THREE.MOUSE;
+    }): void;
+    /**
+     * 设置控制中心点
+     * @param x 世界坐标X
+     * @param y 世界坐标Y
+     * @param z 世界坐标Z
+     */
+    setTarget(x: number, y: number, z: number): void;
+    /**
+     * 设置摄像机观察方向和位置
+     * @param position 摄像机所在位置
+     * @param lookAt 观察目标点，同时也是[[OrbitControls]]的旋转中心
+     */
+    setCameraPose(position: [number, number, number], lookAt: [number, number, number], useLookAt?: boolean): void;
+    private getPanoramaOfPID;
+    private preloadCubeTexturesOfPIDs;
+    /**
+     * 设置摄像机按指定视线方向看向目标位置
+     * @param target 目标位置
+     * @param sightDirection 可选，视线方向，不设置则默认以摄像机当前方向
+     */
+    setCameraLookAt(target: NS_THREE.Vector3, sightDirection?: NS_THREE.Vector3): void;
+    /**
+     * 仅显示指定全景图，但不操作摄像机
+     * @param pid 全景点PID
+     * @parama showModel 可选，是否一开始就显示模型
+     * @param preInitPanoramasStrategy 可选，预创建全景对象的顺序策略，详见[PanoramaGroup]的【initializePanoramasIfNecessary]方法说明
+     */
+    showPanorama(pid: number, options?: {
+        lookDirection?: NS_THREE.Vector3;
+        target?: NS_THREE.Vector3;
+        showModel?: boolean;
+        preInitPanoramasStrategy?: 'all' | number | number[];
+    }): Promise<Panorama | undefined>;
+    /**
+     * 从指定全景图中心以指定视线方向观看
+     * @param pid 全景图PID
+     * @param lookDirection 视线方向
+     * @parama showModel 可选，是否一开始就显示模型
+     * @param preInitPanoramasStrategy 可选，预创建全景对象的顺序策略，详见[PanoramaGroup]的【initializePanoramasIfNecessary]方法说明
+     */
+    lookFromPanorama(pid: number, lookDirection?: NS_THREE.Vector3, showModel?: boolean, preInitPanoramasStrategy?: 'all' | number | number[]): Promise<void>;
+    /**
+     * 从指定全景图中心看向指定位置
+     * @param pid 全景图PID
+     * @param target 目标位置
+     * @parama showModel 可选，是否一开始就显示模型
+     * @param preInitPanoramasStrategy 可选，预创建全景对象的顺序策略，详见[PanoramaGroup]的【initializePanoramasIfNecessary]方法说明
+     */
+    lookFromPanoramaTo(pid: number, target: NS_THREE.Vector3, showModel?: boolean, preInitPanoramasStrategy?: 'all' | number | number[]): Promise<void>;
+    static createModelUniforms(): {
+        [uniform: string]: NS_THREE.IUniform;
+    };
+    private static createInstantTranslationUniforms;
+    private getModelMaterial;
+    private getInstantTranslationMaterial;
+    /**
+     * @ignore
+     * @param visible
+     */
+    setModelAppearance(modelElement: NS_THREE.Object3D, visible: boolean, meshMaterial?: NS_THREE.Material | NS_THREE.Material[], modelMesh?: NS_THREE.Mesh): void;
+    /**
+     * 配置controller是否开启点击移动
+     * @param value 是否开启点击移动
+     */
+    setMoveOnClickEnabled(value: boolean): void;
+    /**
+     * 移动到指定的全景点处
+     * @param toPID 目标全景点ID
+     * @param interval 可选，过渡所用时长
+     * @param easing 可选，插值函数
+     * @param fadeInOut 可选，是否使用淡出淡入变换
+     * @param toDirection 可选，到达目的点时要转到的视线方向，
+     *    若不设置则默认以从起始点到目的点的连线为最终视线方向
+     * @param lookAtTarget 可选，到达目的点时视线看向的位置，优先于toDirection
+     * @param fov 可选，视场角度数
+     * @param rotateDelays 可选，旋转时的延迟时间
+     */
+    moveToPanorama(toPID: number, params?: {
+        toDirection?: NS_THREE.Vector3;
+        lookAtTarget?: NS_THREE.Vector3;
+        interval?: number;
+        fov?: number;
+        fadeInOut?: boolean;
+        easing?: {
+            (k: number): number;
+        };
+        showModel?: boolean;
+        rotateDelays?: number | number[];
+    }): Promise<void>;
+    /**
+     * 移动到指定的全景点处
+     * 此方法与[[moveToPanorama]]的不同点在于通过Promise机制实现同步阻塞，
+     * 在前一个Translation未完成时发起的Translation会自动被阻塞到前一个完成时再执行
+     * @param toPID 目标全景点ID
+     * @param interval 可选，过渡所用时长
+     * @param easing 可选，插值函数
+     * @param fadeInOut 可选，是否使用淡出淡入变换
+     * @param toDirection 可选，到达目的点时要转到的视线方向，
+     *  若不设置则默认以从起始点到目的点的连线为最终视线方向
+     * @param lookAtTarget 可选，到达目的点时视线看向的位置，优先于toDirection
+     * @param fov 可选，视场角度数
+     * @param rotateDelays 可选，旋转时的延迟时间
+     */
+    moveToPanoramaSync(toPID: number, params?: {
+        toDirection?: NS_THREE.Vector3;
+        lookAtTarget?: NS_THREE.Vector3;
+        interval?: number;
+        fov?: number;
+        fadeInOut?: boolean;
+        easing?: {
+            (k: number): number;
+        };
+        showModel?: boolean;
+        rotateDelays?: number | number[];
+    }): Promise<void>;
+    /**
+     * 摄像机按指定路径运动，并在全景点之间产生渐入渐出效果
+     * @param pathPIDs 目标全景点序列
+     * @param queueIfBusy 可选，指示当当前有动画在进行中时，是把此次动作排队还是直接放弃
+     * @param showModel 可选 是否在移动完成后也保持模型显示（用于遮挡路径）
+     * @param intervals 可选，若为数组则依次是每一段路径所花费的时间间隔，若是一个数则全都用该时间间隔
+     * @param fovs 可选，若为数组则依次是每一段路径结束时的视场角，若是一个数则全都用该视场角
+     * @param toDirections 可选，若为数组则依次是每一段路径结束点的视线方向，若是单一Vector3对象则全用此视线方向
+     * @param lookAtTargets 可选，若为数组则依次是每一段路径所看向的位置，若是单一Vector3对象则始终看向此位置
+     * toDirections与lookAtTargets最多只能有一个，如果同时传入了则只以lookAtTargets为准
+     * @param rotateDelays 可选，旋转时的延迟时间
+     * @param easings 可选，若为数组则依次是每一段路径的动画插值函数，
+     * 若是单一{(k: number): number}对象则全用此插值函数
+     * @example
+     * ``` typescript
+     * panoCtl = new PanoramaController(view, panoMgr, floorModel);
+     * panoCtl.setMouseClickEnabled(true);
+     * stage.bindController(panoCtl);
+     * panoCtl.lookFromPanorama(0, new Vector3(-1, 0, 0));
+     * panoCtl.moveInPath([0, 68, 69, 68, 0], {
+     *    queueIfBusy: true,
+     *    intervals: [200, 1000, 2000, 1000, 3000],
+     *    toDirections: [
+     *      new Vector3(-1, 0, 0),
+     *      new Vector3(-0.8, 0.6, 0),
+     *      new Vector3(-0.6, 0.8, 0),
+     *      new Vector3(0, 0.8, 0),
+     *      new Vector3(0.6, 0, 0),
+     *    ],
+     * });
+     */
+    moveInPath(path: number[], params?: {
+        queueIfBusy?: boolean;
+        showModel?: boolean;
+        toDirections?: NS_THREE.Vector3 | NS_THREE.Vector3[];
+        lookAtTargets?: NS_THREE.Vector3 | NS_THREE.Vector3[];
+        intervals?: number | number[];
+        fovs?: number | number[];
+        fadeInOuts?: boolean | boolean[];
+        easings?: {
+            (k: number): number;
+        } | {
+            (k: number): number;
+        }[];
+        freeRotation?: boolean;
+        rotateDelays?: number | number[];
+    }): Promise<void>;
+    /**
+     * 摄像机按指定路径运动
+     * @param pathPoints 摄像机运动的路径上每一段目的点的Vector3坐标数组
+     * @param queueIfBusy 可选，指示当当前有动画在进行中时，是把此次动作排队还是直接放弃
+     * @param intervals 可选，若为数组则依次是每一段路径所花费的时间间隔，若是一个数则全都用该时间间隔
+     * @param fovs 可选，若为数组则依次是每一段路径结束时的视场角，若是一个数则全都用该视场角
+     * @param toDirections 可选，若为数组则依次是每一段路径结束点的视线方向，若是单一Vector3对象则全用此视线方向
+     * @param lookAtTargets 可选，若为数组则依次是每一段路径所看向的位置，若是单一Vector3对象则始终看向此位置
+     * toDirections与lookAtTargets最多只能有一个，如果同时传入了则只以lookAtTargets为准
+     * @param easings 可选，若为数组则依次是每一段路径的动画插值函数，
+     * 若是单一{(k: number): number}对象则全用此插值函数
+     * @param rotateDelays 可选，旋转时的延迟时间
+     * @param progressTransforms 可选，转换progress的映射函数，从0~1之间的小数映射到另一个0~1之间的小数
+     * @param beforeAllMoves 整个路径移动即将开始前的回调
+     * @param onOneMoveStart 每段路径移动开始时的回调
+     * @param onOneMoveUpdate 每段路径移动进行中的进度回调
+     * @param onOneMoveComplete 每段路径移动结束时的回调
+     * @param afterAllMoves 整个路径移动结束时的回调
+     * @example
+     * ``` typescript
+     * panoCtl.moveCameraInPath(points, {
+     *  queueIfBusy: false,
+     *  intervals: [200, 1000, 2000, 1000, 3000],
+     *    toDirections: [
+     *      new Vector3(-1, 0, 0),
+     *      new Vector3(-0.8, 0.6, 0),
+     *      new Vector3(-0.6, 0.8, 0),
+     *      new Vector3(0, 0.8, 0),
+     *      new Vector3(0.6, 0, 0),
+     *    ],
+     *  });
+     */
+    moveCameraInPath(pathPoints: NS_THREE.Vector3[], params?: {
+        queueIfBusy?: boolean;
+        toDirections?: NS_THREE.Vector3 | NS_THREE.Vector3[];
+        lookAtTargets?: NS_THREE.Vector3 | NS_THREE.Vector3[];
+        intervals?: number | number[];
+        fovs?: number | number[];
+        easings?: {
+            (k: number): number;
+        } | {
+            (k: number): number;
+        }[];
+        progressTransforms?: {
+            (progress: number): number;
+        } | {
+            (progress: number): number;
+        }[];
+        rotateDelays?: number | number[];
+        beforeAllMoves?: {
+            (): Promise<void>;
+        };
+        onOneMoveStart?: {
+            (index: number, target0: NS_THREE.Vector3, eye0: NS_THREE.Vector3, target1: NS_THREE.Vector3, eye1: NS_THREE.Vector3): Promise<boolean>;
+        };
+        onOneMoveUpdate?: {
+            (index: number, progress0: number, progress: number): void;
+        };
+        onOneMoveComplete?: {
+            (index: number): void;
+        };
+        afterAllMoves?: {
+            (): Promise<void>;
+        };
+        freeRotation?: boolean;
+    }): Promise<void>;
+    unlockRotation(): void;
+    unlockPolarAngle(): void;
+    lockPolarAngle(range: number): void;
+    unlockAzimuthalAngle(): void;
+    lockAzimuthalAngle(range: number): void;
+    /**
+     * 获取当前纵向转动角度
+     */
+    getPolarAngle(): number;
+    /**
+     * 获取当前横向转动角度
+     */
+    getAzimuthalAngle(): number;
+    setCaptureMove(capture: boolean): void;
+    setOnScreenDetectRadius(radius: number): void;
+    /**
+     * 设置纵向转动范围, 最低为0, 最高为Math.PI
+     * @param min 纵向转动范围最小值
+     * @param max 纵向转动范围最大值
+     */
+    setPolarAngleRange(min: number, max: number): void;
+    /**
+     * 设置横向转动范围, 最低为-Math.PI, 最高为Math.PI
+     * @param min 横向转动范围最小值
+     * @param max 横向转动范围最大值
+     */
+    setAzimuthAngleRange(min: number, max: number): void;
+    /**
+     * 设置相机的横向旋转
+     * @param radius 目标弧度
+     */
+    setAzimuthAngle(radius: number): void;
+    /**
+     * 设置相机的纵向旋转
+     * @param radius 目标弧度
+     */
+    setPolarAngle(radius: number): void;
+    stopMoving(): void;
+}
+export { PanoramaController };