@soonspacejs/plugin-pathfinding 2.7.0 → 2.7.1

package/dist/helper/nav-mesh-helper.d.ts

@@ -0,0 +1,18 @@
+import { NavMesh } from '@recast-navigation/core';
+import { Material, Mesh } from 'three';
+export type NavMeshHelperParams = {
+    navMesh: NavMesh;
+    navMeshMaterial?: Material;
+};
+export declare class NavMeshHelper {
+    navMesh: Mesh;
+    navMeshMaterial: Material;
+    recastNavMesh: NavMesh;
+    constructor({ navMesh, navMeshMaterial, }: NavMeshHelperParams);
+    /**
+     * Update the three debug nav mesh.
+     *
+     * This should be called after updating the nav mesh.
+     */
+    updateNavMesh(): void;
+}

package/dist/index.d.ts

@@ -1,98 +1,28 @@
-import { Mesh, Object3D, Vector3 } from 'three';
+import { Mesh, Object3D } from 'three';
+import { NavMesh, NavMeshConfig, NavMeshQuery } from '@recast-navigation/core';
 import SoonSpace from 'soonspacejs';
 import { IVector3 } from 'soonspacejs/types/Interface';
-export interface INavMeshOptions {
-    /**
-     * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
-     */
-    cs?: number;
-    /**
-     * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
-     */
-    ch?: number;
-    /**
-     * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
-     */
-    walkableSlopeAngle?: number;
-    /**
-     * Minimum floor to 'ceiling' height that will still allow the floor area to
-     * be considered walkable. [Limit: >= 3] [Units: vx]
-     */
-    walkableHeight?: number;
-    /**
-     * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
-     */
-    walkableClimb?: number;
-    /**
-     * The distance to erode/shrink the walkable area of the heightfield away from
-     * obstructions.  [Limit: >=0] [Units: vx]
-     */
-    walkableRadius?: number;
-    /**
-     * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
-     */
-    maxEdgeLen?: number;
-    /**
-     * The maximum distance a simplified contour's border edges should deviate
-     * the original raw contour. [Limit: >=0] [Units: vx]
-     */
-    maxSimplificationError?: number;
-    /**
-     * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
-     */
-    minRegionArea?: number;
-    /**
-     * Any regions with a span count smaller than this value will, if possible,
-     * be merged with larger regions. [Limit: >=0] [Units: vx]
-     */
-    mergeRegionArea?: number;
-    /**
-     * The maximum number of vertices allowed for polygons generated during the
-     * contour to polygon conversion process. [Limit: >= 3]
-     */
-    maxVertsPerPoly?: number;
-    /**
-     * Sets the sampling distance to use when generating the detail mesh.
-     * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
-     */
-    detailSampleDist?: number;
-    /**
-     * The maximum distance the detail mesh surface should deviate from heightfield
-     * data. (For height detail only.) [Limit: >=0] [Units: wu]
-     */
-    detailSampleMaxError?: number;
-    /**
-     * If using obstacles, the navmesh must be subdivided internaly by tiles.
-     * This member defines the tile cube side length in world units.
-     * If no obstacles are needed, leave it undefined or 0.
-     */
-    tileSize?: number;
-    /**
-     * The size of the non-navigable border around the heightfield.
-     */
-    borderSize?: number;
-}
 declare class PathfindingPlugin {
     readonly ssp: SoonSpace;
-    navMesh: Record<any, any> | null;
-    private _tempVec1;
-    private _tempVec2;
+    navMesh: NavMesh | null;
+    navMeshQuery: NavMeshQuery | null;
+    debugNavMesh: Mesh | null;
     constructor(ssp: SoonSpace);
-    createNavMesh(objects?: Object3D[], options?: INavMeshOptions): void;
+    createNavMesh(objects?: Object3D[], options?: Partial<NavMeshConfig>): void;
     createDebugNavMesh(): Mesh | null;
     /**
-     * Get a navigation mesh constrained position, closest to the parameter position
-     * @param position world position
-     * @returns the closest point to position constrained by the navigation mesh
+     * Returns the closest point on the NavMesh to the given position.
+     * @param position
+     * @returns
      */
-    getClosestPoint(position: IVector3): Vector3 | null;
+    getClosestPoint(position: IVector3): IVector3 | null;
     /**
-     * Compute a navigation path from start to end. Returns an empty array if no path can be computed
-     * @param start world position
-     * @param end world position
-     * @returns array containing world position composing the path
+     * Finds a path from the start position to the end position.
+     * @param start
+     * @param end
+     * @returns
      */
-    computePath(start: IVector3, end: IVector3): Vector3[] | null;
+    computePath(start: IVector3, end: IVector3): IVector3[] | null;
     dispose(): void;
 }
 export default PathfindingPlugin;