Documentation for pathfinder.

2010-12-09 21:39:35 +00:00
parent cb7180f7d0
commit 11fc214583
3 changed files with 76 additions and 8 deletions
--- a/library/PolyVoxCore/include/PolyVoxImpl/AStarPathfinderImpl.h
+++ b/library/PolyVoxCore/include/PolyVoxImpl/AStarPathfinderImpl.h
@@ -35,10 +35,14 @@ namespace PolyVox
 	class ClosedNodesContainer;
 	class ThermiteGameLogic;

+	/// The Connectivity of a voxel determines how many neighbours it has.
 	enum Connectivity
 	{
+		/// Each voxel has six neighbours, which are those sharing a face.
 		SixConnected,
+		/// Each voxel has 18 neighbours, which are those sharing a face or an edge.
 		EighteenConnected,
+		/// Each voxel has 26 neighbours, which are those sharing a face, edge, or corner.
 		TwentySixConnected
 	};