@soonspacejs/plugin-first-person-controls 2.11.13 → 2.11.15

package/README.md

@@ -1,5 +1,5 @@
-# @soonspacejs/plugin-transform-controls
-
-> Transform-controls plugin for SoonSpace.js
-
-Document: [http://www.xwbuilders.com:8800/plugin/first-person-controls.html](http://www.xwbuilders.com:8800/plugin/first-person-controls.html)
+# @soonspacejs/plugin-transform-controls
+
+> Transform-controls plugin for SoonSpace.js
+
+Document: [http://www.xwbuilders.com:8800/plugin/first-person-controls.html](http://www.xwbuilders.com:8800/plugin/first-person-controls.html)

package/dist/index.d.ts

@@ -0,0 +1,213 @@
+import { Vector3, Vector2, Intersection, Sphere, Object3D, Box3, Camera } from 'three';
+import SoonSpace, { Position, Rotation } from 'soonspacejs';
+export type ClashCheckAxis = 'front' | 'back' | 'left' | 'right' | 'up' | 'down';
+/**
+ * 碰撞对象过滤器
+ * @remarks
+ * 会在遍历对象时逐个调用该方法
+ *
+ * @param obj - Object3D 对象
+ * @returns true：表示检测该对象的碰撞；false | null | undefined | void：表示不检测该对象的碰撞；
+ */
+export type ClashFilter = (obj: Object3D) => boolean | null | undefined | void;
+export interface StartOptions {
+    position?: Position | null;
+    rotation?: Rotation | null;
+    moveSpeed?: number;
+    eyeHeight?: number;
+    kneeHeight?: number;
+    jumpHeight?: number;
+    enableClash?: boolean;
+    enableGravity?: boolean;
+    /**
+     * 模型对象的搜索半径的系数
+     * @remarks
+     * 搜索半径是 clashCheckDistance 的多少倍
+     */
+    searchRadiusFactor?: number;
+    /**
+     * 碰撞距离
+     */
+    clashDistance?: number;
+    /**
+     * 碰撞检测距离
+     */
+    clashCheckDistance?: number;
+    /**
+     * 重力速度
+     */
+    gravitySpeed?: number;
+    /**
+     * 重力搜索系数
+     * @remarks
+     * 重力搜索系数 表示 向下搜索多少个 eyeHeight 的深度
+     */
+    gravitySearchFactor?: number;
+    /**
+     * 碰撞对象过滤器
+     * @remarks
+     * 会在遍历对象时逐个调用该方法
+     *
+     * @param obj - Object3D 对象
+     * @returns true：表示检测该对象的碰撞；false | null | undefined | void：表示不检测该对象的碰撞；
+     */
+    clashFilter?: ClashFilter;
+    /**
+     * 碰撞检测的层级
+     */
+    clashLayers?: number[];
+    /**
+     * 反向旋转
+     */
+    reverseRotate?: boolean | null;
+    /**
+     * 是否开启旋转
+     */
+    rotate?: boolean | null;
+    /**
+     * 旋转速度
+     */
+    rotateSpeed?: number;
+    /**
+    /**
+     * 是否开启水平方向的旋转
+     */
+    horizontalRotate?: boolean | null;
+    /**
+     * 是否开启垂直方向旋转
+     */
+    verticalRotate?: boolean | null;
+    /**
+     * 开启双击前进
+     */
+    dblClickForward?: boolean;
+}
+export default class FirstPersonControlsPlugin {
+    ssp: SoonSpace;
+    viewport: SoonSpace['viewport'];
+    controls: SoonSpace['controls'];
+    protected camera: Camera;
+    enabled: boolean;
+    keyCodeMap: {
+        moveForward: string[];
+        moveBackward: string[];
+        moveLeft: string[];
+        moveRight: string[];
+        moveUp: string[];
+        moveDown: string[];
+        rotateUp: string[];
+        rotateDown: string[];
+        rotateLeft: string[];
+        rotateRight: string[];
+        jump: string[];
+    };
+    private state;
+    /**
+     * 移动速度
+     */
+    moveSpeed: number;
+    /**
+     * 重力速度
+     */
+    gravitySpeed: number;
+    jumpOffset: number;
+    /**
+     * 碰撞检测距离
+     */
+    clashCheckDistance: number;
+    /**
+     * 碰撞距离
+     */
+    clashDistance: number;
+    eyeHeight: number;
+    kneeHeight: number;
+    jumpHeight: number;
+    enableClash: boolean;
+    enableGravity: boolean;
+    /**
+     * 反向旋转
+     */
+    reverseRotate: boolean;
+    _rotate: boolean;
+    /**
+     * 是否能旋转
+     */
+    get rotate(): boolean;
+    set rotate(value: boolean);
+    /**
+     * 旋转速度
+     */
+    rotateSpeed: number;
+    /**
+     * 是否开启水平方向的旋转
+     */
+    horizontalRotate: boolean;
+    /**
+     * 是否开启垂直方向旋转
+     */
+    verticalRotate: boolean;
+    /**
+     * 开启双击前进
+     */
+    dblClickForward: boolean;
+    readonly movement: Vector2;
+    /**
+     * 碰撞对象过滤器
+     * @remarks
+     * 会在遍历对象时逐个调用该方法
+     *
+     * @param obj - Object3D 对象
+     * @returns true：表示检测该对象的碰撞；false | null | undefined | void：表示不检测该对象的碰撞；
+     */
+    clashFilter?: ClashFilter;
+    /**
+     * 碰撞检测的层级
+     */
+    clashLayers?: number[];
+    /**
+     *
+     * @param ssp
+     * @param camera - 自定义的摄像机，默认会自动生成一个新的摄像机
+     */
+    constructor(ssp: SoonSpace);
+    onKeyDown(event: KeyboardEvent): void;
+    onKeyUp(event: KeyboardEvent): void;
+    private _dblVector;
+    private _dblDeltaVector;
+    onDblClick(event: MouseEvent): void;
+    private _pointerId;
+    onPointerDown(event: PointerEvent): void;
+    /**
+     * events handler for pointer movement
+     */
+    onPointerMove(event: PointerEvent): void;
+    onPointerUp(event: PointerEvent): void;
+    clearClashCache(): void;
+    lastDirection: Vector3;
+    onClashCheck(origin: Vector3, direction: Vector3): boolean;
+    /**
+     * 模型对象的搜索半径的系数
+     * @remarks
+     * 搜索半径是 clashCheckDistance 的多少倍
+     */
+    searchRadiusFactor: number;
+    checkedSphere: Sphere;
+    getCheckedObjects(origin: Vector3): Object3D<import("three").Object3DEventMap>[];
+    /**
+     * 重力搜索系数
+     * @remarks
+     * 重力搜索系数 表示 向下搜索多少个 eyeHeight 的深度
+     */
+    gravitySearchFactor: number;
+    gravityCheckedObjects: Object3D[] | null;
+    gravityCheckedBox: Box3;
+    getGravityCheckedObjects(origin: Vector3, dropY: number): Object3D<import("three").Object3DEventMap>[];
+    gravityClashCheck(origin: Vector3, dropY: number): Intersection<Object3D<import("three").Object3DEventMap>>;
+    setOptions(options: StartOptions): void;
+    start(options: StartOptions): void;
+    stop(): void;
+    gravityInterObject?: Intersection | null;
+    kneeInterObject?: Intersection | null;
+    eyeInterObject?: Intersection | null;
+    update(): void;
+}

package/dist/tools.d.ts

@@ -0,0 +1,9 @@
+import { Box3, Object3D, Sphere, Layers } from 'three';
+/**
+ * 判断包围合 与 对象的包围盒是否相交
+ */
+export declare function boundingIsIntersected(target: Box3 | Sphere, obj: Object3D): boolean;
+export declare function setLayers(layer: Layers, layerNums: number[]): void;
+export declare const EPSILON = 0.00001;
+export declare function approxZero(number: number, error?: number): boolean;
+export declare function approxEquals(a: number, b: number, error?: number): boolean;

package/doc/changelog.md

@@ -1,28 +1,28 @@
-# 2022年9月13日
-## 原来的问题
-原来存在以下问题
-+ 在无操作下仍然消耗大量计算资源
-+ 操作时卡顿更严重
-+ 只能对上、下、左、右、前、后 几个固定方向进行碰撞检测，无法对任意方向进行碰撞检测
-+ 在卡顿较严重的情况下，平移会一下子跳很远
-
-## 优化
-现在做了以下优化
-_以下关于帧率的测试是在 个人性能较差一点的 Mac 笔该本上进行的测试，仅作参考_
-+ 在无操作下不消耗资源，使其从原来的 18左右 率率优化到 508 左右的帧率，提高到了3倍
-+ 在旋转操作时，使其从原来的 10 多帧率，优化到了 30 - 40 帧，提高到了2倍多
-+ 在平移操作时，优化到了 30 - 40 多帧（由于原来的卡顿较严重，暂时测不出原来的帧率）
-
-## 新增特性
-现在增加了以下特性
-+ 可以对任意方向进行碰撞检测，不只是上、下、左、右、前、后 几个固定方向
-+ 即使在卡顿较严重的情况下，平移也不会一下子跳很远
-+ 自定义碰撞检测范围、重力检测范围 等，用以实现根据具体场景来个性化优化性能
-
-
-## 优化手段
-+ 合并运算：原来需要多次运算才能达到的目的，现在使用数学的方法，合并成了一次运算
-+ 缩小碰撞检测范围
-+ 优化碰撞检测逻辑
-+ 缩小重力检测范围
+# 2022年9月13日
+## 原来的问题
+原来存在以下问题
++ 在无操作下仍然消耗大量计算资源
++ 操作时卡顿更严重
++ 只能对上、下、左、右、前、后 几个固定方向进行碰撞检测，无法对任意方向进行碰撞检测
++ 在卡顿较严重的情况下，平移会一下子跳很远
+
+## 优化
+现在做了以下优化
+_以下关于帧率的测试是在 个人性能较差一点的 Mac 笔该本上进行的测试，仅作参考_
++ 在无操作下不消耗资源，使其从原来的 18左右 率率优化到 508 左右的帧率，提高到了3倍
++ 在旋转操作时，使其从原来的 10 多帧率，优化到了 30 - 40 帧，提高到了2倍多
++ 在平移操作时，优化到了 30 - 40 多帧（由于原来的卡顿较严重，暂时测不出原来的帧率）
+
+## 新增特性
+现在增加了以下特性
++ 可以对任意方向进行碰撞检测，不只是上、下、左、右、前、后 几个固定方向
++ 即使在卡顿较严重的情况下，平移也不会一下子跳很远
++ 自定义碰撞检测范围、重力检测范围 等，用以实现根据具体场景来个性化优化性能
+
+
+## 优化手段
++ 合并运算：原来需要多次运算才能达到的目的，现在使用数学的方法，合并成了一次运算
++ 缩小碰撞检测范围
++ 优化碰撞检测逻辑
++ 缩小重力检测范围
 + 优化重力检测逻辑

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@soonspacejs/plugin-first-person-controls",
   "pluginName": "FirstPersonControlsPlugin",
-  "version": "2.11.13",
+  "version": "2.11.15",
   "description": "FirstPersonControls plugin for SoonSpace.js",
   "main": "dist/index.esm.js",
   "module": "dist/index.esm.js",
@@ -13,8 +13,8 @@
   ],
   "author": "xunwei",
   "license": "UNLICENSED",
-  "gitHead": "0ecdef9d6546f8cd0e7f8ea38e7eb84fda951e4b",
+  "gitHead": "428102fac08e80d838003505c5d52575335f2f90",
   "peerDependencies": {
-    "soonspacejs": "2.11.13"
+    "soonspacejs": "2.11.15"
   }
 }