recast-navigation 0.0.6 → 0.1.0

package/README.md

@@ -40,9 +40,9 @@ await init();
 ### Creating a NavMesh
 
 ```ts
-import { NavMesh } from 'recast-navigation';
+import { NavMeshGenerator } from 'recast-navigation';
 
-const navMesh = new NavMesh();
+const navMeshGenerator = new NavMeshGenerator();
 
 const positions = [
   /* flat array of positions */
@@ -57,52 +57,64 @@ const navMeshConfig = {
   /* ... */
 };
 
-navMesh.build(positions, indices, navMeshConfig);
+const { navMesh } = navMeshGenerator.generate(
+  positions,
+  indices,
+  navMeshConfig
+);
 ```
 
 ### Querying a NavMesh
 
 ```ts
-const navMesh = new NavMesh();
+import { NavMeshQuery } from 'recast-navigation';
 
-/* initialize the NavMesh */
-// ...
+const navMeshQuery = new NavMeshQuery({ navMesh });
 
 /* get the closest point on the NavMesh to the given position */
 const position = { x: 0, y: 0, z: 0 };
-navMesh.getClosestPoint(position);
+navMeshQuery.getClosestPoint(position);
 
 /* get a random point around the given position */
 const radius = 0.5;
-navMesh.getRandomPointAround(position, radius);
+navMeshQuery.getRandomPointAround(position, radius);
 ```
 
 ### Adding Obstacles to a NavMesh
 
 Recast Navigation supports creating Box and Cylinder obstacles.
 
-Note that in order to use obstacles, you must specify a `tileSize` in the `NavMeshConfig`.
+Note that in order to use obstacles, you must create a tiled NavMesh. You can do this by specifying a `tileSize` in the `NavMeshConfig`.
 
 ```ts
+/* create a tiled NavMesh */
+const { navMesh, tileCache } = navMeshGenerator.generate(positions, indices, {
+  /* ... */
+  tileSize: 16,
+});
+
 /* add a Box obstacle to the NavMesh */
 const position = { x: 0, y: 0, z: 0 };
 const extent = { x: 1, y: 1, z: 1 };
 const angle = 0;
-const boxObstacle = navMesh.addBoxObstacle(position, extent, angle);
+const boxObstacle = tileCache.addBoxObstacle(position, extent, angle);
 
 /* add a Cylinder obstacle to the NavMesh */
 const radius = 1;
 const height = 1;
-const cylinderObstacle = navMesh.addCylinderObstacle(
+const cylinderObstacle = tileCache.addCylinderObstacle(
   position,
   radius,
   height,
   angle
 );
 
+/* update the NavMesh to reflect obstacle changes */
+tileCache.update(navMesh);
+
 /* remove the obstacles from the NavMesh */
-navMesh.removeObstacle(boxObstacle);
-navMesh.removeObstacle(cylinderObstacle);
+tileCache.removeObstacle(boxObstacle);
+tileCache.removeObstacle(cylinderObstacle);
 ```
 
 ### Crowds and Agents
@@ -131,7 +143,7 @@ crowd.update(dt);
 Next, you can create and interface with agents in the crowd.
 
 ```ts
-const initialAgentPosition = navMesh.getRandomPointAround(
+const initialAgentPosition = navMeshQuery.getRandomPointAround(
   { x: 0, y: 0, z: 0 }, // position
   2 // radius
 );
@@ -185,16 +197,27 @@ You can use `getDebugNavMesh` to get a debug representation of the NavMesh.
 ```ts
 const debugNavMesh = navMesh.getDebugNavMesh();
 
-const { positions, indices } = debugNavMesh.positions;
+const { positions, indices } = debugNavMesh;
 ```
 
 If you are using `@recast-navigation/three`, you can use `NavMeshHelper` and `CrowdHelper` to visualize NavMeshes and Crowds.
 
-### Exporting and Importing a NavMesh
+### Exporting and Importing
+
+A NavMesh and TileCache can be exported and imported as a Uint8Array.
 
 ```ts
-const navMeshData: Uint8Array = navMesh.getNavMeshData();
+/* exporting */
+const navMeshExporter = new NavMeshExporter();
+
+const navMeshExport: Uint8Array = navMeshExporter.export(
+  navMesh,
+  tileCache // optional
+);
+
+/* importing */
+const navMeshImporter = new NavMeshImporter();
 
-const newNavMesh = new NavMesh();
-newNavMesh.buildFromNavMeshData(navMeshData);
+const { navMesh, tileCache } =
+  navMeshImporter.import(navMeshExport);
 ```

package/package.json

@@ -18,7 +18,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.0.6",
+  "version": "0.1.0",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -49,8 +49,8 @@
     "build-storybook": "storybook build"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.0.6",
-    "@recast-navigation/three": "0.0.6"
+    "@recast-navigation/core": "0.1.0",
+    "@recast-navigation/three": "0.1.0"
   },
   "peerDependencies": {
     "three": "^0.150.1"
@@ -59,7 +59,7 @@
     "@babel/core": "^7.21.3",
     "@mdx-js/react": "^1.6.22",
     "@react-three/csg": "^2.2.0",
-    "@react-three/drei": "^9.58.5",
+    "@react-three/drei": "^9.72.1",
     "@react-three/fiber": "^8.12.0",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-multi-entry": "^6.0.0",
@@ -79,6 +79,7 @@
     "@types/react-dom": "^18.0.11",
     "@types/three": "^0.150.0",
     "babel-loader": "^8.3.0",
+    "leva": "^0.9.34",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rollup": "^3.20.0",
@@ -86,7 +87,8 @@
     "rollup-plugin-filesize": "^10.0.0",
     "storybook": "^7.0.2",
     "suspend-react": "^0.0.9",
-    "three": "^0.150.1"
+    "three": "^0.150.1",
+    "three-pathfinding": "^1.2.0"
   },
   "packageManager": "yarn@3.2.2"
 }