Class PointGraph Extends NavGraph, IUpdatableGraph

PointNode AddNode (

Int3

position

)

Add a node to the graph at the specified position.

AstarPath.active.AddWorkItem(new AstarWorkItem(ctx => {
var graph = AstarPath.active.data.pointGraph;
// Add 2 nodes and connect them
var node1 = graph.AddNode((Int3)transform.position);
var node2 = graph.AddNode((Int3)(transform.position + Vector3.right));
var cost = (uint)(node2.position - node1.position).costMagnitude;
node1.AddConnection(node2, cost);
node2.AddConnection(node1, cost);
}));


T AddNode<T> (

T	node	This must be a node created using T(AstarPath.active) right before the call to this method. The node parameter is only there because there is no new(AstarPath) constraint on generic type parameters.
Int3	position	The node will be set to this position.

)

Add a node with the specified type to the graph at the specified position.

void ConnectNodes ()

Recalculates connections for all nodes in the graph.

This is useful if you have created nodes manually using AddNode and then want to connect them in the same way as the point graph normally connects nodes.

int CountNodes ()

Number of nodes in the graph.

Note that this is, unless the graph type has overriden it, an O(n) operation.

This is an O(1) operation for grid graphs and point graphs. For layered grid graphs it is an O(n) operation.

NNInfoInternal GetNearest (

Vector3	position	The position to try to find a close node to
NNConstraint	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.
GraphNode	hint	Can be passed to enable some graph generators to find the nearest node faster.

)

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

NNInfoInternal GetNearestForce (

Vector3	position
NNConstraint	constraint

)

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

void GetNodes (

System.Action<GraphNode>

action

)

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.

var gg = AstarPath.active.data.gridGraph;

gg.GetNodes(node => {
// Here is a node
Debug.Log("I found a node at position " + (Vector3)node.position);
});
If you want to store all nodes in a list you can do this

var gg = AstarPath.active.data.gridGraph;

List<GraphNode> nodes = new List<GraphNode>();

gg.GetNodes((System.Action<GraphNode>)nodes.Add);


bool IsValidConnection (

GraphNode	a
GraphNode	b
out float	dist

)

Returns if the connection between a and b is valid.

Checks for obstructions using raycasts (if enabled) and checks for height differences.
As a bonus, it outputs the distance between the nodes too if the connection is valid.

void RebuildConnectionDistanceLookup ()

Rebuilds a cache used when nearestNodeDistanceMode = #NodeDistanceMode.ToConnection.

void RebuildNodeLookup ()

Rebuilds the lookup structure for nodes.

This is used when optimizeForSparseGraph is enabled.

You should call this method every time you move a node in the graph manually and you are using optimizeForSparseGraph, otherwise pathfinding might not work correctly.

You may also call this after you have added many nodes using the AddNode method. When adding nodes using the AddNode method they will be added to the lookup structure. The lookup structure will rebalance itself when it gets too unbalanced however if you are sure you won't be adding any more nodes in the short term, you can make sure it is perfectly balanced and thus squeeze out the last bit of performance by calling this method. This can improve the performance of the GetNearest method slightly. The improvements are on the order of 10-20%.

void RegisterConnectionLength (

long

sqrLength

The length of the connection in squared Int3 units. This can be calculated using (node1.position - node2.position).sqrMagnitudeLong.

)

Ensures the graph knows that there is a connection with this length.

This is used when the nearest node distance mode is set to ToConnection. If you are modifying node connections yourself (i.e. manipulating the PointNode.connections array) then you must call this function when you add any connections.

When using PointNode.AddConnection this is done automatically. It is also done for all nodes when RebuildNodeLookup is called.

void RelocateNodes (

Matrix4x4

deltaMatrix

)

Moves the nodes in this graph.

Multiplies all node positions by deltaMatrix.

For example if you want to move all your nodes in e.g a point graph 10 units along the X axis from the initial position var graph = AstarPath.data.pointGraph;
var m = Matrix4x4.TRS (new Vector3(10,0,0), Quaternion.identity, Vector3.one);
graph.RelocateNodes (m);


Vector3 limits

Max distance along the axis for a connection to be valid.

0 = infinity

LayerMask mask

Layer mask to use for raycast.

float maxDistance

Max distance for a connection to be valid.

The value 0 (zero) will be read as infinity and thus all nodes not restricted by other constraints will be added as connections.

A negative value will disable any neighbours to be added. It will completely stop the connection processing to be done, so it can save you processing power if you don't these connections.

NodeDistanceMode nearestNodeDistanceMode

Distance query mode.

In the image above there are a few red nodes. Assume the agent is the orange circle. Using the Node mode the closest point on the graph that would be found would be the node at the bottom center which may not be what you want. Using the Connection mode it will find the closest point on the connection between the two nodes in the top half of the image.

When using the Connection option you may also want to use the Connection option for the Seeker's Start End Modifier snapping options. This is not strictly necessary, but it most cases it is what you want.

If you enable this during runtime, you will need to call RebuildConnectionDistanceLookup to make sure some cache data is properly recalculated. If the graph doesn't have any nodes yet or if you are going to scan the graph afterwards then you do not need to do this.

int nodeCount

Number of nodes in this graph.

PointNode[] nodes

All nodes in this graph.

Note that only the first nodeCount will be non-null.

You can also use the GetNodes method to get all nodes.

bool optimizeForSparseGraph

Optimizes the graph for sparse graphs.

This can reduce calculation times for both scanning and for normal path requests by huge amounts. It reduces the number of node-node checks that need to be done during scan, and can also optimize getting the nearest node from the graph (such as when querying for a path).

Try enabling and disabling this option, check the scan times logged when you scan the graph to see if your graph is suited for this optimization or if it makes it slower.

The gain of using this optimization increases with larger graphs, the default scan algorithm is brute force and requires O(n^2) checks, this optimization along with a graph suited for it, requires only O(n) checks during scan (assuming the connection distance limits are reasonable).

If you enable this during runtime, you will need to call RebuildNodeLookup to make sure any existing nodes are added to the lookup structure. If the graph doesn't have any nodes yet or if you are going to scan the graph afterwards then you do not need to do this.

bool raycast = true

Use raycasts to check connections.

bool recursive = true

Recursively search for child nodes to the root.

Transform root

Childs of this transform are treated as nodes.

string searchTag

If no root is set, all nodes with the tag is used as nodes.

bool thickRaycast

Use thick raycast.

float thickRaycastRadius = 1

Thick raycast radius.

bool use2DPhysics

Use the 2D Physics API.

NodeDistanceMode

Distance query mode.

In the image above there are a few red nodes. Assume the agent is the orange circle. Using the Node mode the closest point on the graph that would be found would be the node at the bottom center which may not be what you want. Using the Connection mode it will find the closest point on the connection between the two nodes in the top half of the image.

When using the Connection option you may also want to use the Connection option for the Seeker's Start End Modifier snapping options. This is not strictly necessary, but it most cases it is what you want.

NNInfoInternal GetNearest (

Vector3

position

The position to try to find a close node to

)

Returns the nearest node to a position.

NNInfoInternal GetNearest (

Vector3	position	The position to try to find a close node to
NNConstraint	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.

)

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

void GetNodes (

System.Func<GraphNode, bool>

action

)

Calls a delegate with all nodes in the graph until the delegate returns false.

void OnDrawGizmos (

DrawingData	gizmos
bool	drawNodes
RedrawScope	redrawScope

)

Draw gizmos for the graph.

void Scan ()

Scan the graph.

Consider using AstarPath.Scan() instead since this function only scans this graph and if you are using multiple graphs with connections between them, then it is better to scan all graphs at once.

AstarPath active

Reference to the AstarPath object in the scene.

bool drawGizmos = true

Enable to draw gizmos in the Unity scene view.

In the inspector this value corresponds to the state of the 'eye' icon in the top left corner of every graph inspector.

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.

Should be inside UNITY_EDITOR only #ifs but just in case anyone tries to serialize a NavGraph instance using Unity, I have left it like this as it would otherwise cause a crash when building. Version 3.0.8.1 was released because of this bug only

uint initialPenalty

Default penalty to apply to all nodes.

string name

Name of the graph.

Can be set in the unity editor

bool open

Is the graph open in the editor.

void AddChildren (

ref int	c
Transform	tr

)

Recursively adds childrens of a transform as nodes.

void AddToLookup (

PointNode

node

)

void AssertSafeToUpdateGraph ()

Throws an exception if it is not safe to update internal graph data right now.

It is safe to update graphs when graphs are being scanned, or inside a work item. In other cases pathfinding could be running at the same time, which would not appreciate graph data changing under its feet.

GraphUpdateThreadingIUpdatableGraph. CanUpdateAsync (

GraphUpdateObject

o

)

IEnumerable<Progress> ConnectNodesAsync ()

Calculates connections for all nodes in the graph.

This is an IEnumerable, you can iterate through it using e.g foreach to get progress information.

int CountChildren (

Transform

tr

)

Recursively counds children of a transform.

PointNode[] CreateNodes (

int

count

)

void DeserializeExtraInfo (

GraphSerializationContext

ctx

)

Deserializes graph type specific node data.

void DestroyAllNodes ()

Destroys all nodes in the graph.

void DisposeUnmanagedData ()

Cleans up any unmanaged data that the graph has.

void DrawUnwalkableNodes (

DrawingData	gizmos
float	size
RedrawScope	redrawScope

)

NNInfoInternal FindClosestConnectionPoint (

PointNode	node
Vector3	position

)

NNInfoInternal GetNearestInternal (

Vector3	position
NNConstraint	constraint
bool	fastCheck

)

void OnDestroy ()

Function for cleaning up references.

This will be called on the same time as OnDisable on the gameObject which the AstarPath script is attached to (remember, not in the editor). Use for any cleanup code such as cleaning up static variables which otherwise might prevent resources from being collected. Use by creating a function overriding this one in a graph class, but always call base.OnDestroy () in that function. All nodes should be destroyed in this function otherwise a memory leak will arise.

void PostDeserialization (

GraphSerializationContext

ctx

)

Called after all deserialization has been done for all graphs.

Can be used to set up more graph data which is not serialized

IEnumerable<Progress> ScanInternal (

bool

async

)

Internal method to scan the graph.

Called from AstarPath.ScanAsync. Override this function to implement custom scanning logic. Progress objects can be yielded to show progress info in the editor and to split up processing over several frames when using async scanning.

void SerializeExtraInfo (

GraphSerializationContext

ctx

)

Serializes graph type specific node data.

This function can be overriden to serialize extra node information (or graph information for that matter) which cannot be serialized using the standard serialization. Serialize the data in any way you want and return a byte array. When loading, the exact same byte array will be passed to the DeserializeExtraInfo function.
These functions will only be called if node serialization is enabled.

void IUpdatableGraph. UpdateArea (

GraphUpdateObject

guo

)

Updates an area in the list graph.

Recalculates possibly affected connections, i.e all connectionlines passing trough the bounds of the guo will be recalculated

GraphUpdatePromiseIUpdatableGraph. UpdateAreaInit (

GraphUpdateObject

o

)

May be called on the Unity thread before starting the update.

May return a GraphUpdatePromise or null. If a GraphUpdatePromise is returned it will be polled on the main thread until it returns done. Only then will it progress to the next stage. The `Complete` method may be called if the graph update needs to be completed immediately.

void IUpdatableGraph. UpdateAreaPost (

GraphUpdateObject

o

)

May be called on the Unity thread after executing the update.

bool exists

True if the graph exists, false if it has been destroyed.

PointKDTree lookupTree = new PointKDTree()

long maximumConnectionLength = 0

Longest known connection.

In squared Int3 units.

void DeserializeSettingsCompatibility (

GraphSerializationContext

ctx

)

An old format for serializing settings.

IEnumerable<Progress> ScanInternal ()

Internal method to scan the graph.