Documentation: mention custom meshes should be in XZ plane.

Thanks for the great library.

The isVectorInPolygon test allows deviation lowestY - 0.5 < vector.y < highestY + 0.5. Implicitly, 2d points should be encoded (x, 0, y) when constructing a floor.

Would you mind noting this in the README?

[donmccurdy]

The idea is that the origin of the object you’re moving should be as close as possible to the navmesh surface, within some floating point error. You can also use a dummy object for pathfinding and put the actual model at some offset from it. I used 0.5m here to be a little more flexible, but I wouldn’t want to document that because then we’d be stuck with it. How about something like:

The origin of an agent should initially be placed on the surface of the nav mesh. If needed, a dummy object can be used for pathfinding logic, and the rendered model for that agent may be placed at on offset as needed.

[donmccurdy]

Added in https://github.com/donmccurdy/three-pathfinding/commit/b8e44650172c5612fbadd2bbfc59ccc507c9b767 😃