Detailed Description

Node used for the PointGraph.

This is just a simple point with a list of connections (and associated costs) to other nodes. It does not have any concept of a surface like many other node types.

See also: PointGraph

Public Member Functions
	PointNode (AstarPath astar)

override void	AddConnection (GraphNode node, uint cost)
	Add a connection from this node to the specified node. More...

override void	ClearConnections (bool alsoReverse)
	Remove all connections from this node. More...

override bool	ContainsConnection (GraphNode node)
	Checks if this node has a connection to the specified node. More...

override void	DeserializeNode (GraphSerializationContext ctx)
	Deserializes the node data from a byte array. More...

override void	DeserializeReferences (GraphSerializationContext ctx)
	Used to deserialize references to other nodes e.g connections. More...

override void	GetConnections (System.Action< GraphNode > action)
	Calls the delegate with all connections from this node. More...

override int	GetGizmoHashCode ()
	Hash code used for checking if the gizmos need to be updated. More...

override void	Open (Path path, PathNode pathNode, PathHandler handler)
	Open the node. More...

override void	RemoveConnection (GraphNode node)
	Removes any connection from this node to the specified node. More...

override void	SerializeNode (GraphSerializationContext ctx)
	Serialized the node data to a byte array. More...

override void	SerializeReferences (GraphSerializationContext ctx)
	Used to serialize references to other nodes e.g connections. More...

void	SetPosition (Int3 value)

override void	UpdateRecursiveG (Path path, PathNode pathNode, PathHandler handler)

Public Member Functions inherited from GraphNode
void	Destroy ()
	Destroys the node. More...

virtual bool	GetPortal (GraphNode other, List< Vector3 > left, List< Vector3 > right, bool backwards)
	Add a portal from this node to the specified node. More...

virtual Vector3	RandomPointOnSurface ()
	A random point on the surface of the node. More...

void	RecalculateConnectionCosts ()
	Recalculates a node's connection costs. More...

void	SetConnectivityDirty ()
	Inform the system that the node's connectivity has changed. More...

virtual float	SurfaceArea ()
	The surface area of the node in square world units. More...

Public Attributes
Connection []	connections
	All connections from this node. More...

GameObject	gameObject
	GameObject this node was created from (if any). More...

Public Attributes inherited from GraphNode
const uint	MaxGraphIndex = FlagsGraphMask >> FlagsGraphOffset
	Max number of graphs-1. More...

const uint	MaxHierarchicalNodeIndex = HierarchicalIndexMask >> FlagsHierarchicalIndexOffset

Int3	position
	Position of the node in world space. More...

Additional Inherited Members
Protected Member Functions inherited from GraphNode
	GraphNode (AstarPath astar)
	Constructor for a graph node. More...

Protected Attributes inherited from GraphNode
uint	flags
	Bitpacked field holding several pieces of data. More...

Properties inherited from GraphNode
uint	Area `[get]`
	Connected component that contains the node. More...

bool	Destroyed `[get]`

uint	Flags `[get, set]`
	Holds various bitpacked variables. More...

NavGraph	Graph `[get]`
	Graph which this node belongs to. More...

uint	GraphIndex `[get, set]`
	Graph which contains this node. More...

int	HierarchicalNodeIndex `[get, set]`
	Hierarchical Node that contains this node. More...

bool	IsHierarchicalNodeDirty `[get, set]`
	Some internal bookkeeping. More...

int	NodeIndex `[get, private set]`
	Internal unique index. More...

uint	Penalty `[get, set]`
	Penalty cost for walking on this node. More...

uint	Tag `[get, set]`
	Node tag. More...

bool	TemporaryFlag1 `[get, set]`
	Temporary flag for internal purposes. More...

bool	TemporaryFlag2 `[get, set]`
	Temporary flag for internal purposes. More...

bool	Walkable `[get, set]`
	True if the node is traversable. More...

Constructor & Destructor Documentation

◆ PointNode()

PointNode ( AstarPath astar )

Member Function Documentation

◆ AddConnection()

override void AddConnection	(	GraphNode	node,
		uint	cost
	)

virtual

Add a connection from this node to the specified node.

If the connection already exists, the cost will simply be updated and no extra connection added.

Note: Only adds a one-way connection. Consider calling the same function on the other node to get a two-way connection.

        AstarPath.active.AddWorkItem(new AstarWorkItem(ctx => {
            // Connect two nodes
            var node1 = AstarPath.active.GetNearest(transform.position, NNConstraint.None).node;
            var node2 = AstarPath.active.GetNearest(transform.position + Vector3.right, NNConstraint.None).node;
            var cost = (uint)(node2.position - node1.position).costMagnitude;
            node1.AddConnection(node2, cost);
            node2.AddConnection(node1, cost);
            node1.ContainsConnection(node2); // True
            node1.RemoveConnection(node2);
            node2.RemoveConnection(node1);
        }));

Implements GraphNode.

◆ ClearConnections()

override void ClearConnections ( bool alsoReverse )

virtual

Remove all connections from this node.

Parameters

alsoReverse if true, neighbours will be requested to remove connections to this node.

Implements GraphNode.

◆ ContainsConnection()

override bool ContainsConnection ( GraphNode node )

virtual

Checks if this node has a connection to the specified node.

        AstarPath.active.AddWorkItem(new AstarWorkItem(ctx => {
            // Connect two nodes
            var node1 = AstarPath.active.GetNearest(transform.position, NNConstraint.None).node;
            var node2 = AstarPath.active.GetNearest(transform.position + Vector3.right, NNConstraint.None).node;
            var cost = (uint)(node2.position - node1.position).costMagnitude;
            node1.AddConnection(node2, cost);
            node2.AddConnection(node1, cost);
            node1.ContainsConnection(node2); // True
            node1.RemoveConnection(node2);
            node2.RemoveConnection(node1);
        }));

Reimplemented from GraphNode.

◆ DeserializeNode()

override void DeserializeNode ( GraphSerializationContext ctx )

virtual

Deserializes the node data from a byte array.

Reimplemented from GraphNode.

◆ DeserializeReferences()

override void DeserializeReferences ( GraphSerializationContext ctx )

virtual

Used to deserialize references to other nodes e.g connections.

Use the GraphSerializationContext.GetNodeIdentifier and GraphSerializationContext.GetNodeFromIdentifier methods for serialization and deserialization respectively.

Nodes must override this method and serialize their connections. Graph generators do not need to call this method, it will be called automatically on all nodes at the correct time by the serializer.

Reimplemented from GraphNode.

◆ GetConnections()

override void GetConnections ( System.Action< GraphNode > action )

virtual

Calls the delegate with all connections from this node.

        node.GetConnections(connectedTo => {
            Debug.DrawLine((Vector3)node.position, (Vector3)connectedTo.position, Color.red);
        });

You can add all connected nodes to a list like this

var connections = new List<GraphNode>();

node.GetConnections(connections.Add);

Implements GraphNode.

◆ GetGizmoHashCode()

override int GetGizmoHashCode ( )

virtual

Hash code used for checking if the gizmos need to be updated.

Will change when the gizmos for the node might change.

Reimplemented from GraphNode.

◆ Open()

override void Open	(	Path	path,
		PathNode	pathNode,
		PathHandler	handler
	)

virtual

Open the node.

Used internally for the A* algorithm.

Implements GraphNode.

◆ RemoveConnection()

override void RemoveConnection ( GraphNode node )

virtual

Removes any connection from this node to the specified node.

If no such connection exists, nothing will be done.

Note: This only removes the connection from this node to the other node. You may want to call the same function on the other node to remove its possible connection to this node.

        AstarPath.active.AddWorkItem(new AstarWorkItem(ctx => {
            // Connect two nodes
            var node1 = AstarPath.active.GetNearest(transform.position, NNConstraint.None).node;
            var node2 = AstarPath.active.GetNearest(transform.position + Vector3.right, NNConstraint.None).node;
            var cost = (uint)(node2.position - node1.position).costMagnitude;
            node1.AddConnection(node2, cost);
            node2.AddConnection(node1, cost);
            node1.ContainsConnection(node2); // True
            node1.RemoveConnection(node2);
            node2.RemoveConnection(node1);
        }));

Implements GraphNode.

◆ SerializeNode()

override void SerializeNode ( GraphSerializationContext ctx )

virtual

Serialized the node data to a byte array.

Reimplemented from GraphNode.

◆ SerializeReferences()

override void SerializeReferences ( GraphSerializationContext ctx )

virtual

Used to serialize references to other nodes e.g connections.

Use the GraphSerializationContext.GetNodeIdentifier and GraphSerializationContext.GetNodeFromIdentifier methods for serialization and deserialization respectively.

Nodes must override this method and serialize their connections. Graph generators do not need to call this method, it will be called automatically on all nodes at the correct time by the serializer.

Reimplemented from GraphNode.

◆ SetPosition()

void SetPosition ( Int3 value )

◆ UpdateRecursiveG()

override void UpdateRecursiveG	(	Path	path,
		PathNode	pathNode,
		PathHandler	handler
	)

virtual

Reimplemented from GraphNode.

Member Data Documentation

◆ connections

Connection [] connections

All connections from this node.

See also: AddConnection; RemoveConnection

Note: If you modify this array or the contents of it you must call SetConnectivityDirty.; If you modify this array or the contents of it you must call #PointGraph.RegisterConnectionLength with the length of the new connections.

◆ gameObject

GameObject gameObject

GameObject this node was created from (if any).

Warning: When loading a graph from a saved file or from cache, this field will be null.

        var node = AstarPath.active.GetNearest(transform.position).node;
        var pointNode = node as PointNode;
        if (pointNode != null) {
            Debug.Log("That node was created from the GameObject named " + pointNode.gameObject.name);
        } else {
            Debug.Log("That node is not a PointNode");
        }

The documentation for this class was generated from the following file:

/Users/arong/Unity/a-pathfinding-project/Assets/AstarPathfindingProject/Generators/NodeClasses/PointNode.cs

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ PointNode()

Member Function Documentation

◆ AddConnection()

◆ ClearConnections()

◆ ContainsConnection()

◆ DeserializeNode()

◆ DeserializeReferences()

◆ GetConnections()

◆ GetGizmoHashCode()

◆ Open()

◆ RemoveConnection()

◆ SerializeNode()

◆ SerializeReferences()

◆ SetPosition()

◆ UpdateRecursiveG()

Member Data Documentation

◆ connections

◆ gameObject