RAIN.Path.NavGridMultiRegionGraph Class Reference

Inheritance diagram for RAIN.Path.NavGridMultiRegionGraph:

List of all members.

Public Member Functions
	NavGridMultiRegionGraph (NavGridArray navGridArray_)
override void	InitGraph ()
	InitGraph is used to allocate memory and initialize the graph for use.
override PathNode	Node (int index)
	Returns the graph node associated with the given index. Graph node indices are expected to remain constant during the lifetime of the graph, although connectivity may change.
override int	Quantize (Vector3 location)
	For the purpose of conserving processor speed - the quantize step will not return a distance.
override Vector3	Localize (int nodeIndex)
	Localize determines the Vector3 location of the specified graph node.
override PathBase	CreatePath (List< int > nodes, float cost)
	Creates a PathBase object from an ordered list of nodes and a precomputed cost.
bool	TryShortcut (int startNode, int endNode)
override float	HeuristicCost (int fromNodeIndex, int toNodeIndex)
	A heuristic cost function estimating the cost from fromNodeIndex to toNodeIndex. For A*-based pathfinding to guarantee a shortest path, the heuristic cost must be less than or equal to the actual cost. The default heuristic cost is 0.
Public Attributes
NavGridArray	navGridArray
float	stepUpHeight = 0f
Properties
override int	Size [get]
	Returns the number of graph nodes in the graph.

---

Member Function Documentation

override PathBase RAIN.Path.NavGridMultiRegionGraph.CreatePath	(	List< int >	nodeList,
		float	cost
	)		[virtual]

Creates a PathBase object from an ordered list of nodes and a precomputed cost.

Parameters:

nodeList
cost

Returns:

Implements RAIN.Path.PathGraph.

override float RAIN.Path.NavGridMultiRegionGraph.HeuristicCost	(	int	fromNodeIndex,
		int	toNodeIndex
	)		[virtual]

A heuristic cost function estimating the cost from fromNodeIndex to toNodeIndex. For A*-based pathfinding to guarantee a shortest path, the heuristic cost must be less than or equal to the actual cost. The default heuristic cost is 0.

Parameters:

fromNodeIndex	The from node index
toNodeIndex	The to node index

Returns:

The heuristic cost of graph traversal between the two nodes.

Reimplemented from RAIN.Path.PathGraph.

override void RAIN.Path.NavGridMultiRegionGraph.InitGraph

(

)

[virtual]

InitGraph is used to allocate memory and initialize the graph for use.

Implements RAIN.Path.PathGraph.

override Vector3 RAIN.Path.NavGridMultiRegionGraph.Localize

(

int

nodeIndex

)

[virtual]

Localize determines the Vector3 location of the specified graph node.

Parameters:

nodeIndex

The index of the graph node to localize

Returns:

The Vector3 position of the graph node

Implements RAIN.Path.PathGraph.

override PathNode RAIN.Path.NavGridMultiRegionGraph.Node

(

int

index

)

[virtual]

Returns the graph node associated with the given index. Graph node indices are expected to remain constant during the lifetime of the graph, although connectivity may change.

Parameters:

index

The index of the graph node to retrieve

Returns:

The path node associated with the specified index.

Reimplemented from RAIN.Path.PathGraph.

override int RAIN.Path.NavGridMultiRegionGraph.Quantize

(

Vector3

location

)

[virtual]

For the purpose of conserving processor speed - the quantize step will not return a distance.

Parameters:

location
distance

Returns:

Implements RAIN.Path.PathGraph.

---

Property Documentation

override int RAIN.Path.NavGridMultiRegionGraph.Size [get]

Returns the number of graph nodes in the graph.

Reimplemented from RAIN.Path.PathGraph.