Generates graphs based on navmeshes. More...

Detailed Description

Generates graphs based on navmeshes.

Navmeshes are meshes where each polygon define a walkable area. These are great because the AI can get so much more information on how it can walk. Polygons instead of points mean that the funnel smoother can produce really nice looking paths and the graphs are also really fast to search and have a low memory footprint because of their smaller size to describe the same area (compared to grid graphs).

See Also: Pathfinding.RecastGraph

Public Member Functions
GraphUpdateThreading	CanUpdateAsync (GraphUpdateObject o)

bool	ContainsPoint (TriangleMeshNode node, Vector3 pos)
	Returns if the point is inside the node in XZ space.

override void	DeserializeExtraInfo (GraphSerializationContext ctx)
	Deserializes graph type specific node data.

override void	DeserializeSettingsCompatibility (GraphSerializationContext ctx)
	An old format for serializing settings.

void	GenerateMatrix ()

override NNInfoInternal	GetNearest (Vector3 position, NNConstraint constraint, GraphNode hint)
	Returns the nearest node to a position using the specified NNConstraint.

override NNInfoInternal	GetNearestForce (Vector3 position, NNConstraint constraint)
	This performs a linear search through all polygons returning the closest one.

override void	GetNodes (GraphNodeDelegateCancelable del)
	Calls a delegate with all nodes in the graph.

void	GetTileCoordinates (int tileIndex, out int x, out int z)

Int3	GetVertex (int index)

int	GetVertexArrayIndex (int index)

bool	Linecast (Vector3 origin, Vector3 end)
	Returns if there is an obstacle between origin and end on the graph.

bool	Linecast (Vector3 origin, Vector3 end, GraphNode hint, out GraphHitInfo hit)
	Returns if there is an obstacle between origin and end on the graph.

bool	Linecast (Vector3 origin, Vector3 end, GraphNode hint)
	Returns if there is an obstacle between origin and end on the graph.

bool	Linecast (Vector3 origin, Vector3 end, GraphNode hint, out GraphHitInfo hit, List< GraphNode > trace)
	Returns if there is an obstacle between origin and end on the graph.

override void	OnDestroy ()
	Function for cleaning up references.

override void	OnDrawGizmos (bool drawNodes)
	Draw gizmos for the graph.

void	PostProcess ()

override void	RelocateNodes (Matrix4x4 oldMatrix, Matrix4x4 newMatrix)
	Transforms the nodes using newMatrix from their initial positions.

void	ScanInternal (string objMeshPath)
	Scans the graph using the path to an .obj mesh.

override IEnumerable< Progress >	ScanInternal ()
	Internal method to scan the graph.

void	ScanInternal (OnScanStatus statusCallback)

override void	SerializeExtraInfo (GraphSerializationContext ctx)
	Serializes graph type specific node data.

void	UpdateArea (GraphUpdateObject o)

void	UpdateAreaInit (GraphUpdateObject o)

void	UpdateAreaPost (GraphUpdateObject o)

Public Member Functions inherited from NavGraph
virtual void	Awake ()
	This will be called on the same time as Awake on the gameObject which the AstarPath script is attached to.

virtual int	CountNodes ()
	Number of nodes in the graph.

NNInfoInternal	GetNearest (Vector3 position)
	Returns the nearest node to a position using the default NNConstraint.

NNInfoInternal	GetNearest (Vector3 position, NNConstraint constraint)
	Returns the nearest node to a position using the specified NNConstraint.

virtual Color	NodeColor (GraphNode node, PathHandler data)
	Color to use for gizmos.

virtual void	PostDeserialization ()
	Called after all deserialization has been done for all graphs.

void	Scan ()

void	ScanGraph ()
	Partially scan the graph.

void	SetMatrix (Matrix4x4 m)
	Use to set both matrix and inverseMatrix at the same time.

Public Member Functions inherited from INavmesh
void	GetNodes (GraphNodeDelegateCancelable del)

Public Member Functions inherited from IUpdatableGraph
GraphUpdateThreading	CanUpdateAsync (GraphUpdateObject o)

void	UpdateArea (GraphUpdateObject o)
	Updates an area using the specified GraphUpdateObject.

void	UpdateAreaInit (GraphUpdateObject o)
	May be called on the Unity thread before starting the update.

void	UpdateAreaPost (GraphUpdateObject o)
	May be called on the Unity thread after executing the update.

Public Member Functions inherited from INavmeshHolder
void	GetTileCoordinates (int tileIndex, out int x, out int z)

Int3	GetVertex (int i)

int	GetVertexArrayIndex (int index)

Public Member Functions inherited from IRaycastableGraph
bool	Linecast (Vector3 start, Vector3 end)

bool	Linecast (Vector3 start, Vector3 end, GraphNode hint)

bool	Linecast (Vector3 start, Vector3 end, GraphNode hint, out GraphHitInfo hit)

bool	Linecast (Vector3 start, Vector3 end, GraphNode hint, out GraphHitInfo hit, List< GraphNode > trace)

Static Public Member Functions
static bool	ContainsPoint (TriangleMeshNode node, Vector3 pos, Int3[] vertices)
	Returns if the point is inside the node in XZ space.

static NNInfoInternal	GetNearest (NavMeshGraph graph, GraphNode[] nodes, Vector3 position, NNConstraint constraint, bool accurateNearestNode)

static NNInfoInternal	GetNearestForce (NavGraph graph, INavmeshHolder navmesh, Vector3 position, NNConstraint constraint, bool accurateNearestNode)
	This performs a linear search through all polygons returning the closest one.

static NNInfoInternal	GetNearestForceBoth (NavGraph graph, INavmeshHolder navmesh, Vector3 position, NNConstraint constraint, bool accurateNearestNode)
	This performs a linear search through all polygons returning the closest one.

static bool	Linecast (INavmesh graph, Vector3 tmp_origin, Vector3 tmp_end, GraphNode hint, out GraphHitInfo hit)
	Returns if there is an obstacle between origin and end on the graph.

static bool	Linecast (INavmesh graph, Vector3 tmp_origin, Vector3 tmp_end, GraphNode hint, out GraphHitInfo hit, List< GraphNode > trace)
	Returns if there is an obstacle between origin and end on the graph.

static void	RebuildBBTree (NavMeshGraph graph)
	Rebuilds the BBTree on a NavGraph.

static void	UpdateArea (GraphUpdateObject o, INavmesh graph)

Static Public Member Functions inherited from NavGraph
static bool	InSearchTree (GraphNode node, Path path)
	Returns if the node is in the search tree of the path.

Public Attributes
bool	accurateNearestNode = true
	More accurate nearest node queries.

TriangleMeshNode[]	nodes

Vector3	offset
	Offset in world space.

Vector3	rotation
	Rotation in degrees.

float	scale = 1
	Scale of the graph.

Mesh	sourceMesh
	Mesh to construct navmesh from.

int[]	triangles

Public Attributes inherited from NavGraph
AstarPath	active
	Reference to the AstarPath object in the scene.

bool	drawGizmos = true
	Enable to draw gizmos in the Unity scene view.

uint	graphIndex
	Index of the graph, used for identification purposes.

Guid	guid
	Used as an ID of the graph, considered to be unique.

bool	infoScreenOpen
	Used in the editor to check if the info screen is open.

uint	initialPenalty
	Default penalty to apply to all nodes.

Matrix4x4	inverseMatrix = Matrix4x4.identity
	Inverse of matrix.

Matrix4x4	matrix = Matrix4x4.identity
	A matrix for translating/rotating/scaling the graph.

string	name
	Name of the graph.

bool	open
	Is the graph open in the editor.

Properties
BBTree	bbTree `[get, set]`

TriangleMeshNode[]	TriNodes `[get]`

Int3[]	vertices `[get, set]`

Private Member Functions
void	GenerateNodes (Vector3[] vectorVertices, int[] triangles, out Vector3[] originalVertices, out Int3[] vertices)
	Generates a navmesh.

Static Private Member Functions
static Vector3	ClosestPointOnNode (TriangleMeshNode node, Int3[] vertices, Vector3 pos)
	Returns the closest point of the node.

Private Attributes
BBTree	_bbTree
	Bounding Box Tree.

Int3[]	_vertices

Vector3[]	originalVertices

Additional Inherited Members
Package Functions inherited from NavGraph
virtual void	UnloadGizmoMeshes ()
	Called when temporary meshes used in OnDrawGizmos need to be unloaded to prevent memory leaks.

Member Function Documentation

GraphUpdateThreading CanUpdateAsync ( GraphUpdateObject o )

static Vector3 ClosestPointOnNode	(	TriangleMeshNode	node,
		Int3[]	vertices,
		Vector3	pos
	)

staticprivate

Returns the closest point of the node.

The only reason this is here is because it is slightly faster compared to TriangleMeshNode.ClosestPointOnNode since it doesn't involve so many indirections.

Use TriangleMeshNode.ClosestPointOnNode in most other cases.

bool ContainsPoint	(	TriangleMeshNode	node,
		Vector3	pos
	)

Returns if the point is inside the node in XZ space.

static bool ContainsPoint	(	TriangleMeshNode	node,
		Vector3	pos,
		Int3[]	vertices
	)

static

Returns if the point is inside the node in XZ space.

override void DeserializeExtraInfo ( GraphSerializationContext ctx )

virtual

Deserializes graph type specific node data.

See Also: SerializeExtraInfo

Reimplemented from NavGraph.

override void DeserializeSettingsCompatibility ( GraphSerializationContext ctx )

virtual

An old format for serializing settings.

Deprecated:: This is deprecated now, but the deserialization code is kept to avoid loosing data when upgrading from older versions.

Reimplemented from NavGraph.

void GenerateMatrix ( )

void GenerateNodes	(	Vector3[]	vectorVertices,
		int[]	triangles,
		out Vector3[]	originalVertices,
		out Int3[]	vertices
	)

private

Generates a navmesh.

Based on the supplied vertices and triangles

static NNInfoInternal GetNearest	(	NavMeshGraph	graph,
		GraphNode[]	nodes,
		Vector3	position,
		NNConstraint	constraint,
		bool	accurateNearestNode
	)

static

override NNInfoInternal GetNearest	(	Vector3	position,
		NNConstraint	constraint,
		GraphNode	hint
	)

virtual

Returns the nearest node to a position using the specified NNConstraint.

Parameters

position	The position to try to find a close node to
hint	Can be passed to enable some graph generators to find the nearest node faster.
constraint	Can for example tell the function to try to return a walkable node. If you do not get a good node back, consider calling GetNearestForce.

Reimplemented from NavGraph.

override NNInfoInternal GetNearestForce	(	Vector3	position,
		NNConstraint	constraint
	)

virtual

This performs a linear search through all polygons returning the closest one.

This is usually only called in the Free version of the A* Pathfinding Project since the Pro one supports BBTrees and will do another query

Reimplemented from NavGraph.

static NNInfoInternal GetNearestForce	(	NavGraph	graph,
		INavmeshHolder	navmesh,
		Vector3	position,
		NNConstraint	constraint,
		bool	accurateNearestNode
	)

static

This performs a linear search through all polygons returning the closest one.

static NNInfoInternal GetNearestForceBoth	(	NavGraph	graph,
		INavmeshHolder	navmesh,
		Vector3	position,
		NNConstraint	constraint,
		bool	accurateNearestNode
	)

static

This performs a linear search through all polygons returning the closest one.

This will fill the NNInfo with .node for the closest node not necessarily complying with the NNConstraint, and .constrainedNode with the closest node complying with the NNConstraint.

See Also: GetNearestForce(Node[],Int3[],Vector3,NNConstraint,bool)

override void GetNodes ( GraphNodeDelegateCancelable del )

virtual

Calls a delegate with all nodes in the graph.

This is the primary way of iterating through all nodes in a graph.

Do not change the graph structure inside the delegate.

myGraph.GetNodes (node => {
    Debug.Log ("I found a node at position " + (Vector3)node.Position);
    return true;
});

Implements NavGraph.

void GetTileCoordinates	(	int	tileIndex,
		out int	x,
		out int	z
	)

Int3 GetVertex ( int index )

int GetVertexArrayIndex ( int index )

bool Linecast	(	Vector3	origin,
		Vector3	end
	)