@soonspacejs/plugin-navigation 2.13.7 → 2.13.9

package/README.md

@@ -1,113 +1,113 @@
-# @soonspacejs/plugin-navigation
-
-> navigation plugin for SoonSpace.js
-
-## 导航功能列表：
-
-- 导航相机 ✅
-
-  - 跟随模型 ✅
-  - 相机位置偏移 ✅
-  - 相机角度偏移 ✅
-  - 反向朝向 ✅
-  - 自动恢复朝向 ✅
-  - 是否锁定相机朝向 ✅
-    - 相机朝向不受控制器影响 ✅
-    - 仍可以反向 ✅
-  - 相机朝向 ✅
-    - 相对朝向 ✅
-      - 相对朝向会跟随目标旋转 ✅
-    - 绝对朝向 ✅
-      - 绝对朝向不会跟随目标旋转 ✅
-    - 朝向目标 ✅
-      - 默认为导航主体 ✅
-      - 固定点 ✅
-      - 固定模型 ✅
-      - 固定方向 ✅
-    - 陀螺仪朝向 ✅
-  - 视角 ✅
-    - 第一人称 ✅
-    - 第三人称 ✅
-    - 俯视角 ✅
-    - 左视角 ✅
-
-- 小地图
-
-  - 小地图相机 ✅
-  - 地图 dom 节点生成
-  - 地图尺寸缩放
-    - 适应最短边
-    - 适应最长边
-    - 固定尺寸
-
-- 路径导航
-  - 多路径整合
-  - 基本配置
-    - 导航结束时是否返回起点
-    - 路径动画配置
-      - 是否循环播放
-      - 每段路径结束时是否自动开始下一段路径
-    - 导航主体
-      - 设置模型
-      - 静止时执行的模型动画（将来）
-      - 运行时执行的模型动画（将来）
-  - 操作
-    - 开始导航
-    - 重新开始
-    - 播放
-    - 暂停
-    - 停止
-    - 变速
-    - 反向
-    - 进度调节
-    - 结束导航
-  - 回调
-    - 一段路径结束时
-    - 导航开始时回调
-    - 导航完全执行完毕时回调（finished）
-    - 导航结束时回调（completed）
-    - 整体进度
-    - 单段路径进度
-    - 距离信息
-      - 距离起点
-      - 距离当前路径起点
-      - 距离终点
-      - 距离当前路径终点
-      - 距离下个节点
-    - 当前位置
-    - 当前朝向
-    - 前方转弯方向
-
-<<<<<<< HEAD
-## 代码 usage
-
-```typescript
-import NavigatorPlugin from "@soonspacejs/plugin-navigator";
-
-const { NavigatorControl } = ssp.registerPlugin(
-	NavigatorPlugin,
-	"navigator-plugin"
-);
-
-const shortestPath1 = ssp.getShortest(/* ... */);
-const shortestPath2 = ssp.getShortest(/* ... */);
-
-const navigator = new NavigatorControl({
-	camera: {
-		opposite: true,
-		offset: new Vector3(),
-	},
-	paths: [],
-	onStart() {
-		console.log("start");
-	},
-});
-
-navigator.flyToStart();
-
-navigator.start();
-```
-
-=======
->>>>>>> c8d957be8672383fdc0971cbcf1b0f8ea061d2d1
-Document: [http://www.xwbuilders.com:8800/plugin/navigation.html](http://www.xwbuilders.com:8800/plugin/navigation.html)
+# @soonspacejs/plugin-navigation
+
+> navigation plugin for SoonSpace.js
+
+## 导航功能列表：
+
+- 导航相机 ✅
+
+  - 跟随模型 ✅
+  - 相机位置偏移 ✅
+  - 相机角度偏移 ✅
+  - 反向朝向 ✅
+  - 自动恢复朝向 ✅
+  - 是否锁定相机朝向 ✅
+    - 相机朝向不受控制器影响 ✅
+    - 仍可以反向 ✅
+  - 相机朝向 ✅
+    - 相对朝向 ✅
+      - 相对朝向会跟随目标旋转 ✅
+    - 绝对朝向 ✅
+      - 绝对朝向不会跟随目标旋转 ✅
+    - 朝向目标 ✅
+      - 默认为导航主体 ✅
+      - 固定点 ✅
+      - 固定模型 ✅
+      - 固定方向 ✅
+    - 陀螺仪朝向 ✅
+  - 视角 ✅
+    - 第一人称 ✅
+    - 第三人称 ✅
+    - 俯视角 ✅
+    - 左视角 ✅
+
+- 小地图
+
+  - 小地图相机 ✅
+  - 地图 dom 节点生成
+  - 地图尺寸缩放
+    - 适应最短边
+    - 适应最长边
+    - 固定尺寸
+
+- 路径导航
+  - 多路径整合
+  - 基本配置
+    - 导航结束时是否返回起点
+    - 路径动画配置
+      - 是否循环播放
+      - 每段路径结束时是否自动开始下一段路径
+    - 导航主体
+      - 设置模型
+      - 静止时执行的模型动画（将来）
+      - 运行时执行的模型动画（将来）
+  - 操作
+    - 开始导航
+    - 重新开始
+    - 播放
+    - 暂停
+    - 停止
+    - 变速
+    - 反向
+    - 进度调节
+    - 结束导航
+  - 回调
+    - 一段路径结束时
+    - 导航开始时回调
+    - 导航完全执行完毕时回调（finished）
+    - 导航结束时回调（completed）
+    - 整体进度
+    - 单段路径进度
+    - 距离信息
+      - 距离起点
+      - 距离当前路径起点
+      - 距离终点
+      - 距离当前路径终点
+      - 距离下个节点
+    - 当前位置
+    - 当前朝向
+    - 前方转弯方向
+
+<<<<<<< HEAD
+## 代码 usage
+
+```typescript
+import NavigatorPlugin from "@soonspacejs/plugin-navigator";
+
+const { NavigatorControl } = ssp.registerPlugin(
+	NavigatorPlugin,
+	"navigator-plugin"
+);
+
+const shortestPath1 = ssp.getShortest(/* ... */);
+const shortestPath2 = ssp.getShortest(/* ... */);
+
+const navigator = new NavigatorControl({
+	camera: {
+		opposite: true,
+		offset: new Vector3(),
+	},
+	paths: [],
+	onStart() {
+		console.log("start");
+	},
+});
+
+navigator.flyToStart();
+
+navigator.start();
+```
+
+=======
+>>>>>>> c8d957be8672383fdc0971cbcf1b0f8ea061d2d1
+Document: [http://www.xwbuilders.com:8800/plugin/navigation.html](http://www.xwbuilders.com:8800/plugin/navigation.html)

package/dist/azimuth/index.d.ts

@@ -0,0 +1,4 @@
+import { Azimuth } from '@three3d/tools';
+export { Azimuth, AzimuthOptions, CourseAzimuthMap, AzimuthDefine, AzimuthInfo, CourseInfo, AngleRange, AzimuthList, AzimuthMap, } from '@three3d/tools';
+declare const azimuth: Azimuth;
+export { azimuth, };

package/dist/camera/index.d.ts

@@ -0,0 +1,5 @@
+export * from './map-camera';
+export * from './navigate-camera';
+export * from './ssp-camera';
+export * from './utils';
+export * from './types';

package/dist/camera/map-camera.d.ts

@@ -0,0 +1,14 @@
+import { OrthographicCamera } from 'three';
+import SoonSpace from 'soonspacejs';
+import { SoonSpaceCamera } from './ssp-camera';
+export declare class MapCamera extends SoonSpaceCamera<OrthographicCamera> {
+    readonly ssp: SoonSpace;
+    protected resizeObserver: ResizeObserver;
+    _zoom: number;
+    get zoom(): number;
+    set zoom(value: number);
+    constructor(ssp: SoonSpace);
+    resizeCamera(): void;
+    protected onEnter(): void;
+    protected onQuit(): void;
+}

package/dist/camera/navigate-camera.d.ts

@@ -0,0 +1,202 @@
+import SoonSpace from 'soonspacejs';
+import { Camera, Euler, Object3D, Quaternion, Vector3 } from 'three';
+import { GyroListener } from '../utils/gyro';
+import { SoonSpaceCamera } from './ssp-camera';
+import { CameraOppositeType, EulerArray, FixEuler, FixVector, NAVIGATE_ORIENTATION_TYPE, NAVIGATE_VISION_TYPE, NavigateOrientationTarget } from './types';
+/**
+ * 相机控制回调
+ *
+ * camera 当前相机
+ *
+ * target 跟踪的目标
+ */
+export type ControlCallback = (camera: Camera, target: Object3D, event?: MouseEvent | TouchEvent) => void;
+export interface NavigateCameraOptions {
+    disabledAnimate: boolean;
+    fixedOrientation: boolean;
+    autoRestoreOrientation: boolean | number;
+    oppositeCamera: boolean;
+    oppositeType: CameraOppositeType;
+    orientationTarget: NavigateOrientationTarget;
+    vision: NAVIGATE_VISION_TYPE;
+    orientationType: NAVIGATE_ORIENTATION_TYPE;
+    distanceToTarget: number;
+    rotationToTarget: Vector3;
+    isFixRotationRelativeTarget: boolean;
+    targetRotationFix: FixEuler;
+    isFixPositionRelativeTarget: boolean;
+    targetPositionFix: FixVector;
+    enableGyro: boolean;
+    gyroX: boolean;
+    gyroY: boolean;
+    gyroZ: boolean;
+    gyroAbsolute: boolean;
+    onControlStart: null | ControlCallback;
+    onControlRender: null | ControlCallback;
+    onControlEnd: null | ControlCallback;
+}
+/** 导航相机 */
+export declare class NavigateCamera extends SoonSpaceCamera<Camera> {
+    readonly ssp: SoonSpace;
+    initOptions: Readonly<NavigateCameraOptions>;
+    cameraKey: string;
+    private _events;
+    get position(): Vector3;
+    get rotation(): Euler;
+    get quaternion(): Quaternion;
+    private _lookAt;
+    private _restoreTimer;
+    private _positionTween;
+    private autoFollowRender;
+    /** 相机位置记录用的对象，用于恢复相机位置和朝向使用 */
+    protected _cameraPlaceholder: Object3D<import("three").Object3DEventMap>;
+    /** 取消飞向动画 */
+    disabledAnimate: boolean;
+    /** 第三人称相机距离跟踪目标距离 */
+    distanceToTarget: number;
+    /** 第三人称相机相对模型视角 */
+    rotationToTarget: Vector3;
+    /** 相机反转 */
+    oppositeCamera: boolean;
+    /** 相机反转类型, 默认为 Y 轴对称 */
+    oppositeType: CameraOppositeType;
+    /** 是否相对模型修正角度 */
+    isFixRotationRelativeTarget: boolean;
+    /**
+       * 目标角度修正
+       *
+       * 支持传入 getter 函数
+       */
+    targetRotationFix: FixEuler;
+    /** 是否相对模型修正偏移 */
+    isFixPositionRelativeTarget: boolean;
+    /**
+       * 目标位置修正
+       *
+       * 支持传入 getter 函数
+       */
+    targetPositionFix: FixVector;
+    /**
+       * 自动恢复朝向
+       *
+       * boolean 是否恢复朝向
+       *
+       * number 间隔多少秒后恢复朝向
+       */
+    autoRestoreOrientation: boolean | number;
+    /** 当控制器控制相机时允许外部自定义控制，控制开始时触发 */
+    onControlStart: null | ControlCallback;
+    /** 当控制器控制相机时允许外部自定义控制，控制进行时回调 */
+    onControlRender: null | ControlCallback;
+    /** 当控制器控制相机时允许外部自定义控制，控制结束时回调 */
+    onControlEnd: null | ControlCallback;
+    /** 陀螺仪 */
+    protected _gyroListener: GyroListener;
+    protected _enableGyro: boolean;
+    /** 开启 */
+    get enableGyro(): boolean;
+    set enableGyro(value: boolean);
+    /** 是否应用陀螺仪 X 轴，默认不启动 */
+    get gyroX(): boolean;
+    set gyroX(value: boolean);
+    /** 是否应用陀螺仪 Y 轴，默认启动 */
+    get gyroY(): boolean;
+    set gyroY(value: boolean);
+    /** 是否应用陀螺仪 Z 轴，默认不启动 */
+    get gyroZ(): boolean;
+    set gyroZ(value: boolean);
+    /** 陀螺仪是否使用绝对值，默认使用 */
+    get gyroAbsolute(): boolean;
+    set gyroAbsolute(value: boolean);
+    /** 陀螺仪的旋转欧拉角 */
+    protected _gyroRotation: Euler;
+    get targetRotationAfterFix(): EulerArray;
+    get targetPositionAfterFix(): import("./types").VectorArray;
+    get realDistanceToTarget(): number;
+    get realRotationToTarget(): Vector3;
+    protected _orientationType: NAVIGATE_ORIENTATION_TYPE;
+    /** 绝对朝向的缓存值 */
+    private _fixedOrientationRotation;
+    /**
+       * 	相机朝向类型
+       *
+       *  NAVIGATE_ORIENTATION_TYPE.RELATIVE_ORIENTATION 相对朝向
+       *
+       *  NAVIGATE_ORIENTATION_TYPE.FIXED_ORIENTATION 绝对朝向
+       *
+       *  NAVIGATE_ORIENTATION_TYPE.GYRO_ORIENTATION 陀螺仪朝向
+       */
+    get orientationType(): NAVIGATE_ORIENTATION_TYPE;
+    set orientationType(value: NAVIGATE_ORIENTATION_TYPE);
+    protected _orientationTarget: NavigateOrientationTarget;
+    /**
+       * 相机朝向目标
+       *
+       * “main” 朝向跟踪目标
+       *
+       * Vector3 朝向点
+       *
+       * Object3D 朝向目标对象
+       *
+       * Euler 固定朝向
+       */
+    get orientationTarget(): NavigateOrientationTarget;
+    set orientationTarget(value: NavigateOrientationTarget);
+    protected _vision: NAVIGATE_VISION_TYPE;
+    /**
+       * 视角配置
+       *
+       * NAVIGATE_VISION_TYPE.FIRST_VISION 第一人称
+       *
+       * NAVIGATE_VISION_TYPE.THIRD_VISION 第三人称
+       *
+       * NAVIGATE_VISION_TYPE.UP_VISION 俯视图
+       *
+       * NAVIGATE_VISION_TYPE.LEFT_VISION 左视图
+       *
+       * 默认为第三人称
+       */
+    get vision(): NAVIGATE_VISION_TYPE;
+    set vision(value: NAVIGATE_VISION_TYPE);
+    protected _followTarget: Object3D;
+    /** 相机跟随目标 */
+    get followTarget(): Object3D;
+    set followTarget(value: Object3D);
+    /** 相机跟踪点（相对跟随目标以及偏移参数获取的点） */
+    get followPosition(): Vector3;
+    /** 跟踪目标的方向（相对跟随目标以及偏移参数获取的朝向） */
+    get followRotation(): Euler;
+    protected _fixedOrientation: boolean;
+    /** 固定朝向，朝向不受控制器影响 */
+    get fixedOrientation(): boolean;
+    set fixedOrientation(value: boolean);
+    constructor(ssp: SoonSpace, camera?: Camera, options?: Partial<NavigateCameraOptions>);
+    protected initGyroListener(): void;
+    /** 控制器操作时处理 */
+    protected setCameraOrientationOnControl(): void;
+    /** 更新相机占位符的方位 */
+    protected updateCameraPlaceholder(): void;
+    /** 设置相机的方位 */
+    protected setCameraOrientationOnRender(): void;
+    /** 获取相机点相对跟踪点的欧拉角 */
+    protected getRenderCameraOrientation(): Euler;
+    /** 获取相机落点（相对跟踪点的方向归一化 * 距离） */
+    protected getRenderCameraPosition(): Vector3;
+    protected onRender(): void;
+    /** 初始化事件 */
+    protected initEvents(): void;
+    /** 清除事件 */
+    protected clearEvents(): void;
+    protected onEnter(): void;
+    protected onQuit(): void;
+    /** 参数重置 */
+    resetOptions(): void;
+    /** 设置参数 */
+    setOptions(options: Partial<NavigateCameraOptions>): void;
+    /**
+       * 设置相机，若导航相机正在使用中，则会立即切换为设置的相机
+       */
+    setCamera(camera: Camera): this;
+    /** 重置相机坐标 */
+    restoreOrientation(): void;
+}

package/dist/camera/ssp-camera.d.ts

@@ -0,0 +1,13 @@
+import { Camera } from 'three';
+import SoonSpace from 'soonspacejs';
+export declare abstract class SoonSpaceCamera<C extends Camera = Camera> {
+    readonly ssp: SoonSpace;
+    nativeCamera: C;
+    protected _isActive: boolean;
+    constructor(ssp: SoonSpace, nativeCamera: C);
+    active(): void;
+    private _onBeforeEnter;
+    private _onBeforeQuit;
+    protected onEnter(): void;
+    protected onQuit(): void;
+}

package/dist/camera/types.d.ts

@@ -0,0 +1,26 @@
+import { Euler, EulerOrder, Object3D, Vector3 } from 'three';
+export type NavigateOrientationTarget = 'main' | Vector3 | Euler | Object3D;
+export declare enum NAVIGATE_VISION_TYPE {
+    FIRST_VISION = "first",
+    THIRD_VISION = "third",
+    UP_VISION = "up",
+    LEFT_VISION = "left"
+}
+export declare enum NAVIGATE_ORIENTATION_TYPE {
+    RELATIVE_ORIENTATION = "relative",
+    FIXED_ORIENTATION = "fixed",
+    GYRO_ORIENTATION = "gyro"
+}
+export type CameraOppositeType = {
+    x: boolean;
+    y: boolean;
+    z: boolean;
+};
+export type Object3DLike = {
+    position: Vector3;
+    rotation: Euler;
+} & Record<PropertyKey, any>;
+export type VectorArray = [number, number, number];
+export type EulerArray = [number, number, number, EulerOrder?];
+export type FixVector = VectorArray | ((target?: Object3DLike) => VectorArray);
+export type FixEuler = EulerArray | ((target?: Object3DLike) => EulerArray);

package/dist/camera/utils.d.ts

@@ -0,0 +1,11 @@
+import { Euler, Vector3 } from 'three';
+import { FixEuler, FixVector, Object3DLike } from './types';
+export declare function Vector3ToEuler(v: Vector3): Euler;
+export declare function eulerToVector3(e: Euler): Vector3;
+/**
+ * 欧拉角归一化
+ * @param e 欧拉角
+ */
+export declare function normalizeEuler(e: Euler): Vector3;
+export declare function getFixVector(v: FixVector, target?: Object3DLike): import("./types").VectorArray;
+export declare function getFixEuler(e: FixEuler, target?: Object3DLike): import("./types").EulerArray;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './camera';
+export * from './navigator';
+export * from './utils';
+export * from './azimuth';