@recast-navigation/core 0.0.5 → 0.0.7

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

@@ -0,0 +1,44 @@
+import type R from '@recast-navigation/wasm';
+export declare type NavMeshCreateParams = {
+    verts: number[];
+    vertCount: number;
+    polys: number[];
+    polyFlags: number[];
+    polyAreas: number[];
+    polyCount: number;
+    nvp: number;
+    detailMeshes: number[];
+    detailVerts: number[];
+    detailVertsCount: number;
+    detailTris: number[];
+    detailTriCount: number;
+    offMeshConVerts: number[];
+    offMeshConRad: number[];
+    offMeshConFlags: number[];
+    offMeshConAreas: number[];
+    offMeshConDir: number[];
+    offMeshConUserID: number[];
+    offMeshConCount: number;
+    userId: number;
+    tileX: number;
+    tileY: number;
+    tileLayer: number;
+    bmin: number[];
+    bmax: number[];
+    walkableHeight: number;
+    walkableRadius: number;
+    walkableClimb: number;
+    cs: number;
+    ch: number;
+    buildBvTree: boolean;
+};
+export declare type CreateNavMeshDataResult = {
+    success: boolean;
+    navMeshData: readonly number[];
+    navMeshDataSize: number;
+};
+export declare class NavMeshBuilder {
+    raw: R.NavMeshBuilder;
+    constructor();
+    createNavMeshData(params: NavMeshCreateParams): CreateNavMeshDataResult;
+}

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

@@ -0,0 +1,12 @@
+import type R from '@recast-navigation/wasm';
+import { NavMesh } from './nav-mesh';
+import { TileCache } from './tile-cache';
+export declare class NavMeshExporter {
+    raw: R.NavMeshExporter;
+    constructor();
+    /**
+     * Returns a NavMesh export that can be used later. The NavMesh must be built before retrieving the data
+     * @returns data the Uint8Array that can be saved and reused
+     */
+    export(navMesh: NavMesh, tileCache?: TileCache): Uint8Array;
+}

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

@@ -0,0 +1,116 @@
+import type R from '@recast-navigation/wasm';
+import { NavMesh } from './nav-mesh';
+import { TileCache } from './tile-cache';
+export declare type NavMeshConfig = {
+    /**
+     * The size of the non-navigable border around the heightfield.
+     * [Limit: >=0] [Units: vx]
+     * @default 0
+     */
+    borderSize: number;
+    /**
+     * The width/height size of tile's on the xz-plane.
+     * [Limit: >= 0] [Units: vx]
+     *
+     * If tileSize is provided, a tiled navmesh will be created.
+     * If tileSize is not provided, or is set to zero, a solo navmesh will be created.
+     *
+     * To use obstacles, a tiled navmesh must be generated.
+     * @default 0
+     */
+    tileSize: number;
+    /**
+     * The xz-plane cell size to use for fields.
+     * [Limit: > 0] [Units: wu]
+     * @default 0.2
+     */
+    cs: number;
+    /**
+     * The y-axis cell size to use for fields.
+     * Limit: > 0] [Units: wu]
+     * @default 0.2
+     */
+    ch: number;
+    /**
+     * The maximum slope that is considered walkable.
+     * [Limits: 0 <= value < 90] [Units: Degrees]
+     * @default 60
+     */
+    walkableSlopeAngle: number;
+    /**
+     * Minimum floor to 'ceiling' height that will still allow the floor area to be considered walkable.
+     * [Limit: >= 3] [Units: vx]
+     * @default 2
+     */
+    walkableHeight: number;
+    /**
+     * Maximum ledge height that is considered to still be traversable.
+     * [Limit: >=0] [Units: vx]
+     * @default 2
+     */
+    walkableClimb: number;
+    /**
+     * The distance to erode/shrink the walkable area of the heightfield away from obstructions.
+     * [Limit: >=0] [Units: vx]
+     * @default 0.5
+     */
+    walkableRadius: number;
+    /**
+     * The maximum allowed length for contour edges along the border of the mesh.
+     * [Limit: >=0] [Units: vx]
+     * @default 12
+     */
+    maxEdgeLen: number;
+    /**
+     * The maximum distance a simplfied contour's border edges should deviate the original raw contour.
+     * [Limit: >=0] [Units: vx]
+     * @default 1.3
+     */
+    maxSimplificationError: number;
+    /**
+     * The minimum number of cells allowed to form isolated island areas.
+     * [Limit: >=0] [Units: vx]
+     * @default 8
+     */
+    minRegionArea: number;
+    /**
+     * Any regions with a span count smaller than this value will, if possible, be merged with larger regions.
+     * [Limit: >=0] [Units: vx]
+     * @default 20
+     */
+    mergeRegionArea: number;
+    /**
+     * The maximum number of vertices allowed for polygons generated during the be merged with larger regions.
+     * [Limit: >=0] [Units: vx]
+     * @default 6
+     */
+    maxVertsPerPoly: number;
+    /**
+     * Sets the sampling distance to use when generating the detail mesh. (For height detail only.)
+     * [Limits: 0 or >= 0.9] [Units: wu]
+     * @default 6
+     */
+    detailSampleDist: number;
+    /**
+     * The maximum distance the detail mesh surface should deviate from heightfield data. (For height detail only.)
+     * [Limit: >=0] [Units: wu]
+     * @default 1
+     */
+    detailSampleMaxError: number;
+};
+export declare type NavMeshGeneratorResult = {
+    success: boolean;
+    navMesh: NavMesh;
+    tileCache: TileCache;
+};
+export declare class NavMeshGenerator {
+    raw: R.NavMeshGenerator;
+    constructor();
+    /**
+     * Builds a NavMesh from the given positions and indices.
+     * @param positions a flat array of positions
+     * @param indices a flat array of indices
+     * @param navMeshConfig optional configuration for the NavMesh
+     */
+    generate(positions: ArrayLike<number>, indices: ArrayLike<number>, navMeshConfig?: Partial<NavMeshConfig>): NavMeshGeneratorResult;
+}

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

@@ -0,0 +1,16 @@
+import type R from '@recast-navigation/wasm';
+import { NavMesh } from './nav-mesh';
+import { TileCache } from './tile-cache';
+export declare type NavMeshImporterResult = {
+    navMesh: NavMesh;
+    tileCache: TileCache;
+};
+export declare class NavMeshImporter {
+    raw: R.NavMeshImporter;
+    constructor();
+    /**
+     * Build the navmesh from a previously saved state using getNavMeshExport
+     * @param data the Uint8Array returned by `getNavMeshExport`
+     */
+    import(data: Uint8Array): NavMeshImporterResult;
+}

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

@@ -0,0 +1,46 @@
+import type R from '@recast-navigation/wasm';
+import { NavMesh } from './nav-mesh';
+import { NavPath, Vector3 } from './utils';
+export declare type NavMeshQueryParams = {
+    navMesh: NavMesh;
+    /**
+     * @default 2048
+     */
+    maxNodes?: number;
+};
+export declare class NavMeshQuery {
+    raw: R.NavMeshQuery;
+    constructor({ navMesh, maxNodes }: NavMeshQueryParams);
+    /**
+     * Returns the closest point on the NavMesh to the given position.
+     */
+    getClosestPoint(position: Vector3): Vector3;
+    /**
+     * Returns a random point on the NavMesh within the given radius of the given position.
+     */
+    getRandomPointAround(position: Vector3, radius: number): Vector3;
+    /**
+     * Compute the final position from a segment made of destination-position
+     */
+    moveAlong(position: Vector3, destination: Vector3): Vector3;
+    /**
+     * Finds a path from the start position to the end position.
+     *g
+     * @returns an array of Vector3 positions that make up the path, or an empty array if no path was found.
+     */
+    computePath(start: Vector3, end: Vector3): NavPath;
+    /**
+     * Gets the Bounding box extent specified by setDefaultQueryExtent
+     */
+    getDefaultQueryExtent(): Vector3;
+    /**
+     * Sets the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
+     * The queries will try to find a solution within those bounds.
+     * The default is (1,1,1)
+     */
+    setDefaultQueryExtent(extent: Vector3): void;
+    /**
+     * Destroys the NavMeshQuery instance
+     */
+    destroy(): void;
+}

package/dist/nav-mesh.d.ts

@@ -1,99 +1,48 @@
 import type R from '@recast-navigation/wasm';
-import { Crowd } from './crowd';
 import { DebugNavMesh } from './debug-nav-mesh';
-import type { BoxObstacle, CylinderObstacle, Obstacle, ObstacleRef } from './obstacle';
-import type { NavPath, Vector3 } from './utils';
-export declare type NavMeshConfig = {
-    /**
-     * @default 0
-     */
-    borderSize: number;
-    /**
-     * @default 0
-     */
-    tileSize: number;
-    /**
-     * @default 0.2
-     */
-    cs: number;
-    /**
-     * @default 0.2
-     */
-    ch: number;
-    /**
-     * @default 60
-     */
-    walkableSlopeAngle: number;
-    /**
-     * @default 2
-     */
-    walkableHeight: number;
-    /**
-     * @default 2
-     */
-    walkableClimb: number;
-    /**
-     * @default 0.5
-     */
-    walkableRadius: number;
-    /**
-     * @default 12
-     */
-    maxEdgeLen: number;
-    /**
-     * @default 1.3
-     */
-    maxSimplificationError: number;
-    /**
-     * @default 8
-     */
-    minRegionArea: number;
+export declare type NavMeshParams = {
+    orig: number[];
+    tileWidth: number;
+    tileHeight: number;
+    maxTiles: number;
+    maxPolys: number;
+};
+export declare type NavMeshAddTileResult = {
+    status: number;
+    tileRef: number;
+};
+export declare class NavMesh {
+    raw: R.NavMesh;
+    constructor(raw?: R.NavMesh);
     /**
-     * @default 20
+     * Initializes the NavMesh for use with a single tile.
+     * @param data the nav mesh data
+     * @param dataSize the size of the nav mesh data
+     * @param flags the flags to use when building the nav mesh
+     * @returns the status of the operation
      */
-    mergeRegionArea: number;
+    initSolo(data: ReadonlyArray<number>, dataSize: number, flags: number): boolean;
     /**
-     * @default 6
+     * Initializes the NavMesh for use with multiple tiles.
+     * @param params parameters for the NavMesh
+     * @returns the status of the operation
      */
-    maxVertsPerPoly: number;
+    initTiled(params: NavMeshParams): boolean;
     /**
-     * @default 6
+     * Adds a tile to the NavMesh.
+     * @param data the nav mesh data
+     * @param dataSize the size of the nav mesh data
+     * @param flags the flags to use when building the nav mesh
+     * @param lastRef
+     * @returns the status of the operation and the reference of the added tile
      */
-    detailSampleDist: number;
+    addTile(data: number[], dataSize: number, flags: number, lastRef: number): NavMeshAddTileResult;
     /**
-     * @default 1
+     * Destroys the NavMesh.
      */
-    detailSampleMaxError: number;
-};
-export declare class NavMesh {
-    raw: R.NavMesh;
-    obstacles: Map<ObstacleRef, Obstacle>;
-    constructor();
-    update(): void;
     destroy(): void;
-    build(positions: ArrayLike<number>, indices: ArrayLike<number>, navMeshConfig?: Partial<NavMeshConfig>): void;
-    /**
-     * Build the navmesh from a previously saved state using getNavMeshData
-     * @param data the Uint8Array returned by `getNavMeshData`
-     */
-    buildFromNavMeshData(data: Uint8Array): void;
     /**
-     * Returns the NavMesh data that can be used later. The NavMesh must be built before retrieving the data
-     * @returns data the Uint8Array that can be saved and reused
+     * Returns a DebugNavMesh that can be used to visualize the NavMesh.
      */
-    getNavMeshData(): Uint8Array;
     getDebugNavMesh(): DebugNavMesh;
-    getClosestPoint(position: Vector3): Vector3;
-    getRandomPointAround(position: Vector3, radius: number): Vector3;
-    moveAlong(position: Vector3, destination: Vector3): Vector3;
-    computePath(start: Vector3, end: Vector3): NavPath;
-    getDefaultQueryExtent(): Vector3;
-    setDefaultQueryExtent(extent: Vector3): void;
-    addCylinderObstacle(position: Vector3, radius: number, height: number): CylinderObstacle;
-    addBoxObstacle(position: Vector3, extent: Vector3, angle: number): BoxObstacle;
-    removeObstacle(obstacle: Obstacle | ObstacleRef): void;
-    createCrowd(config: {
-        maxAgents: number;
-        maxAgentRadius: number;
-    }): Crowd;
 }

package/dist/tile-cache.d.ts

@@ -0,0 +1,48 @@
+import type R from '@recast-navigation/wasm';
+import { NavMesh } from './nav-mesh';
+import { BoxObstacle, CylinderObstacle, Obstacle, ObstacleRef } from './obstacle';
+import { Vector3 } from './utils';
+export declare type TileCacheParams = {
+    orig: ReadonlyArray<number>;
+    cs: number;
+    ch: number;
+    width: number;
+    height: number;
+    walkableHeight: number;
+    walkableRadius: number;
+    walkableClimb: number;
+    maxSimplificationError: number;
+    maxTiles: number;
+    maxObstacles: number;
+};
+export declare type TileCacheUpdateResult = {
+    status: number;
+    upToDate: boolean;
+};
+export declare class TileCache {
+    raw: R.TileCache;
+    obstacles: Map<ObstacleRef, Obstacle>;
+    constructor(raw?: R.TileCache);
+    /**
+     * Initialises the TileCache
+     * @param params
+     */
+    init(params: TileCacheParams): void;
+    /**
+     * Updates the tile cache by rebuilding tiles touched by unfinished obstacle requests.
+     * This should be called after adding or removing obstacles.
+     */
+    update(navMesh: NavMesh): TileCacheUpdateResult;
+    /**
+     * Creates a cylinder obstacle and adds it to the navigation mesh.
+     */
+    addCylinderObstacle(position: Vector3, radius: number, height: number): CylinderObstacle;
+    /**
+     * Creates a box obstacle and adds it to the navigation mesh.
+     */
+    addBoxObstacle(position: Vector3, extent: Vector3, angle: number): BoxObstacle;
+    /**
+     * Removes an obstacle from the navigation mesh.
+     */
+    removeObstacle(obstacle: Obstacle | ObstacleRef): void;
+}

package/dist/{raw.d.ts → wasm.d.ts}

@@ -1,5 +1,5 @@
 import Recast from '@recast-navigation/wasm';
-export declare const Raw: {
+export declare const Wasm: {
     Recast: typeof Recast;
 };
 export declare const init: () => Promise<void>;

package/package.json

@@ -6,7 +6,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.0.5",
+  "version": "0.0.7",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.18.6",
-    "@recast-navigation/wasm": "0.0.5",
+    "@recast-navigation/wasm": "0.0.7",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-terser": "^0.4.0",