@soonspacejs/plugin-navigation 2.6.30 → 2.6.31

package/README.md

@@ -78,4 +78,36 @@
     - 当前朝向
     - 前方转弯方向
 
+<<<<<<< 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/camera/index.d.ts

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

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

@@ -1,4 +1,4 @@
-import SoonSpace from 'soonspacejs/types/index';
+import SoonSpace, { ControlsOptions } from 'soonspacejs/types/index';
 import { Camera, Euler, Object3D, Vector3 } from 'three';
 import { GyroListener } from '../utils/gyro';
 import { SoonSpaceCamera } from './ssp-camera';
@@ -10,7 +10,7 @@ import { CameraOppositeType, EulerArray, FixEuler, FixVector, NAVIGATE_ORIENTATI
  *
  * target 跟踪的目标
  */
-export type ControlCallback = (camera: Camera, target: Object3D) => void;
+export type ControlCallback = (camera: Camera, target: Object3D, event?: MouseEvent | TouchEvent) => void;
 export interface NavigateCameraOptions {
     disabledAnimate: boolean;
     fixedOrientation: boolean;
@@ -62,26 +62,26 @@ export declare class NavigateCamera extends SoonSpaceCamera<Camera> {
     /** 相机反转类型, 默认为 Y 轴对称 */
     oppositeType: CameraOppositeType;
     /**
-       * 目标角度修正
-       *
-       * 支持传入 getter 函数
-       */
+     * 目标角度修正
+     *
+     * 支持传入 getter 函数
+     */
     targetRotationFix: FixEuler;
     /** 是否相对模型修正偏移 */
     isFixPositionRelativeTarget: boolean;
     /**
-       * 目标位置修正
-       *
-       * 支持传入 getter 函数
-       */
+     * 目标位置修正
+     *
+     * 支持传入 getter 函数
+     */
     targetPositionFix: FixVector;
     /**
-       * 自动恢复朝向
-       *
-       * boolean 是否恢复朝向
-       *
-       * number 间隔多少秒后恢复朝向
-       */
+     * 自动恢复朝向
+     *
+     * boolean 是否恢复朝向
+     *
+     * number 间隔多少秒后恢复朝向
+     */
     autoRestoreOrientation: boolean | number;
     /** 当控制器控制相机时允许外部自定义控制，控制开始时触发 */
     onControlStart: null | ControlCallback;
@@ -117,44 +117,44 @@ export declare class NavigateCamera extends SoonSpaceCamera<Camera> {
     /** 绝对朝向的缓存值 */
     private _fixedOrientationRotation;
     /**
-       * 	相机朝向类型
-       *
-       *  NAVIGATE_ORIENTATION_TYPE.RELATIVE_ORIENTATION 相对朝向
-       *
-       *  NAVIGATE_ORIENTATION_TYPE.FIXED_ORIENTATION 绝对朝向
-       *
-       *  NAVIGATE_ORIENTATION_TYPE.GYRO_ORIENTATION 陀螺仪朝向
-       */
+     * 	相机朝向类型
+     *
+     *  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 固定朝向
-       */
+     * 相机朝向目标
+     *
+     * “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 左视图
-       *
-       * 默认为第三人称
-       */
+     * 视角配置
+     *
+     * 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;
@@ -169,7 +169,7 @@ export declare class NavigateCamera extends SoonSpaceCamera<Camera> {
     /** 固定朝向，朝向不受控制器影响 */
     get fixedOrientation(): boolean;
     set fixedOrientation(value: boolean);
-    constructor(ssp: SoonSpace, camera?: Camera, options?: NavigateCameraOptions);
+    constructor(ssp: SoonSpace, camera?: Camera, options?: Partial<NavigateCameraOptions>, controls?: Partial<ControlsOptions>);
     protected initGyroListener(): void;
     /** 控制器操作时处理 */
     protected setCameraOrientationOnControl(): void;
@@ -189,8 +189,8 @@ export declare class NavigateCamera extends SoonSpaceCamera<Camera> {
     /** 设置参数 */
     setOptions(options: Partial<NavigateCameraOptions>): void;
     /**
-       * 设置相机，若导航相机正在使用中，则会立即切换为设置的相机
-       */
+     * 设置相机，若导航相机正在使用中，则会立即切换为设置的相机
+     */
     setCamera(camera: Camera): this;
     /** 重置相机坐标 */
     restoreOrientation(): void;

package/dist/camera/utils.d.ts

@@ -1,5 +1,6 @@
 import { Euler, Vector3 } from 'three';
 import { FixEuler, FixVector, Object3DLike } from './types';
+import SoonSpace from 'soonspacejs/types/index';
 export declare function Vector3ToEuler(v: Vector3): Euler;
 export declare function eulerToVector3(e: Euler): Vector3;
 /**
@@ -9,3 +10,8 @@ export declare function eulerToVector3(e: Euler): Vector3;
 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;
+export declare function initTouchToRotateCamera(ssp: SoonSpace): {
+    touchStart: (event: TouchEvent) => void;
+    touchMove: (event: TouchEvent) => void;
+    touchEnd: () => void;
+};