Empty constructor.

Note:

Call PathFinding_Init to initialize the class.

PathFinding_Exec is the heart of the engine, the search is done in this function.

The search will be completed with one call.

Parameters:

	start_x	Starting tile's x coordinate.
	start_y	Starting tile's y coordinate.
	start_dir	Starting direction of the entity that will be moving.
	end_x	Ending tile's x coordinate.
	end_y	Ending tile's y coordinate.

PathFinding_Free will free all of the internal buffers and arrays.

Parameters:

bKeepLastPath

If true, will keep the last path found array. If false, it will be freed also, and calls to query path results will fail.

PathFinding_GetPathLength will give you the path length that was found by the previous call to PathFinding_Exec.

Returns:

The current path length. 0 if no path was found.

Note:

You need to call PathFinding_Exec once before calling this fonction.

PathFinding_GetPathPosition will give you the position of the path node in array index i.e.

((y*width) + x) so that you can access you array without computing the array pos.

Parameters:

nIndex

The path node you want to query.

Returns:

The path node position in your collision map.

Note:

You need to call PathFinding_Exec once before calling this fonction.

The result will be backward, going from the end to the bening, so PathFinding_GetPathPosition(0) start from the end.

PathFinding_GetPathPositionX will give you the x position of the path node you are querying.

Parameters:

nIndex

The path node you want to query.

Returns:

The X position your collision map.

Note:

You need to call PathFinding_Exec once before calling this fonction.

PathFinding_GetPathPositionY will give you the y position of the path node you are querying.

Parameters:

nIndex

The path node you want to query.

Returns:

The Y position your collision map.

Note:

You need to call PathFinding_Exec once before calling this fonction.

PathFinding_Init must be used once to initialize the PathFinding engine, or if you want to change the parameters of the search.

Parameters:

	nMapWidth	The witdh of your collision map grid.
	nMapHeight	The height of your collision map grid.
	pPhysicalMap	The coolision map, single dimension byte array. The format is the same as a pixel array, a cell is found by cell=((y*width)+x). For the moment, the internal format of this array is 0=freecell anything else is blocked.
	nCostMove	is the cost of moving verticaly or horizontaly (but not both). Usually you should use 10.
	nCostMoveDiag	is the cost of moving verticaly and horizontaly at the same time. Usually you should use 14. Its not used if nDirCount is 4.
	nCostChangeDir	is the cost of changing direction. Use 0 if there is no cost involve in changing direction. Usually you should use 10.
	nDirCount	is used to specify if the algo should look at diagonals possibilities (8) or only the minimal ones (4).
	nCollisionMask	is a mask applied to your Physical Map to find collision. Usefull if you want to store more info in you map. By default the mask should be 0xFFFFFFFF.

PathFinding_Init must be used once to initialize the PathFinding engine, or if you want to change the parameters of the search.

Parameters:

	nMapWidth	The witdh of your collision map grid.
	nMapHeight	The height of your collision map grid.
	pPhysicalMap	The coolision map, single dimension byte array. The format is the same as a pixel array, a cell is found by cell=((y*width)+x). For the moment, the internal format of this array is 0=freecell anything else is blocked.
	nCostMove	is the cost of moving verticaly or horizontaly (but not both). Usually you should use 10.
	nCostMoveDiag	is the cost of moving verticaly and horizontaly at the same time. Usually you should use 14. Its not used if nDirCount is 4.
	nCostChangeDir	is the cost of changing direction. Use 0 if there is no cost involve in changing direction. Usually you should use 10.
	nDirCount	is used to specify if the algo should look at diagonals possibilities (8) or only the minimal ones (4).