three-pathfinding
Advanced tools
Navigation mesh toolkit for ThreeJS, based on PatrolJS. Computes paths between points on a 3D nav mesh, supports multiple zones, and clamps movement vectors for FPS controls. To learn how to create a navigation mesh using Blender, see Creating a Nav Mesh.
npm install --save three-pathfinding
const Pathfinder = require('three-pathfinding');
const pathfinder = new Pathfinder();
// Create level.
const ZONE = 'level1';
pathfinder.setZoneData(ZONE, Pathfinder.createZone(mesh.geometry));
// Find path from A to B.
const groupID = pathfinder.getGroup(ZONE, a);
const path = pathfinder.findPath(a, b, ZONE, groupID);
git clone https://github.com/donmccurdy/three-pathfinding.git
cd three-pathfinding
npm install
npm run dev
The demo will start at http://localhost:9966/demo/demo.html.
Defines an instance of the pathfinding module, with one or more zones.
Sets data for the given zone.
Parameters
Returns closest node group ID for given position.
Parameters
zoneID stringposition THREE.Vector3Returns number
Returns a random node within a given range of a given position.
Parameters
Returns Node
Returns the closest node to the target position.
Parameters
Returns Node
Returns a path between given start and end points. If a complete path cannot be found, will return the nearest endpoint available.
Parameters
startPosition THREE.Vector3 Start position.targetPosition THREE.Vector3 Destination.zoneID string ID of current zone.groupID number Current group ID.Returns Array<THREE.Vector3> Array of points defining the path.
Clamps a step along the navmesh, given start and desired endpoint. May be used to constrain first-person / WASD controls.
Parameters
start THREE.Vector3end THREE.Vector3 Desired endpoint.node NodezoneID stringgroupID numberendTarget THREE.Vector3 Updated endpoint.Returns Node Updated node.
(Static) Builds a zone/node set from navigation mesh geometry.
Parameters
geometry THREE.GeometryReturns Zone
Defines a zone of interconnected groups on a navigation mesh.
Properties
Defines a group within a navigation mesh.
Defines a node (or polygon) within a group.
Properties
id numberneighbours Array<number> IDs of neighboring nodes.centroid THREE.Vector3portals Array<Array<number>> Array of portals, each defined by two vertex IDs.closed booleancost numberFAQs
Navigation mesh toolkit for three.js, based on PatrolJS
The npm package three-pathfinding receives a total of 9,416 weekly downloads. As such, three-pathfinding popularity was classified as popular.
We found that three-pathfinding demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.