Describes a single node for the LayerGridGraph. More...

Detailed Description

Describes a single node for the LayerGridGraph.

Works almost the same as a grid node, except that it also stores to which layer the connections go to

Public Member Functions
	LevelGridNode (AstarPath astar)

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

override void	DeserializeNode (GraphSerializationContext ctx)
	Deserializes node data (for example when loading graphs from file). More...

override void	FloodFill (Stack< GraphNode > stack, uint region)
	Internal method to run a flood fill in order to recalculate the Area property. More...

bool	GetConnection (int i)
	Is there a grid connection in that direction. More...

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

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

int	GetConnectionValue (int dir)
	Which layer a grid connection goes to. More...

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

override GridNodeBase	GetNeighbourAlongDirection (int direction)
	Adjacent grid node in the specified direction. More...

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

bool	HasAnyGridConnections ()
	Does this node have any grid connections. More...

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

void	ResetAllGridConnections ()
	Removes all grid connections from this node. More...

override void	SerializeNode (GraphSerializationContext ctx)
	Serializes node data (for example when saving graphs to file). More...

void	SetConnectionValue (int dir, int value)
	Set which layer a grid connection goes to. More...

void	SetPosition (Int3 position)

override void	UpdateRecursiveG (Path path, PathNode pathNode, PathHandler handler)
	Internal method to update the G score. More...

Public Member Functions inherited from GridNodeBase
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...

void	ClearCustomConnections (bool alsoReverse)
	Same as ClearConnections, but does not clear grid connections, only custom ones (e.g added by AddConnection or a NodeLink component) More...

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

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

override void	FloodFill (System.Collections.Generic.Stack< GraphNode > stack, uint region)

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

override void	GetConnections (System.Action< Connection > action)
	Calls the delegate with all connections and respective costs 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 Vector3	RandomPointOnSurface ()
	A random point on the surface of the node. More...

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

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

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

override void	UpdateRecursiveG (Path path, PathNode pathNode, PathHandler handler)
	Internal method to update the G score. More...

Public Member Functions inherited from GraphNode
virtual void	OpenCooperative (CooperativeABPath path, PathNodeCooperative pathNode, CooperativePathHandler handler)
	Open the node cooperatively. More...

virtual void	RecalculateConnectionCosts ()
	Recalculates all connection costs from this node. More...

Static Public Member Functions
static LayerGridGraph	GetGridGraph (uint graphIndex)

static void	SetGridGraph (int graphIndex, LayerGridGraph graph)

Public Attributes
const int	ConnectionMask = 0xFF

ulong	gridConnections

const int	MaxLayerCount = ConnectionMask

const int	NoConnection = 0xFF

Public Attributes inherited from GridNodeBase
Connection []	connections

Public Attributes inherited from GraphNode
const uint	MaxAreaIndex = FlagsAreaMask >> FlagsAreaOffset

const uint	MaxGraphIndex = FlagsGraphMask >> FlagsGraphOffset
	Max number of graphs-1. More...

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

Static Protected Attributes
static LayerGridGraph []	gridGraphs

Properties
override bool	HasConnectionsToAllEightNeighbours `[get]`

int	LayerCoordinateInGrid `[get, set]`
	Layer coordinate of the node in the grid. More...

Properties inherited from GridNodeBase
abstract bool	HasConnectionsToAllEightNeighbours `[get]`
	True if the node has grid connections to all its 8 neighbours. More...

int	NodeInGridIndex `[get, set]`
	The index of the node in the grid. More...

bool	TmpWalkable `[get, set]`
	Temporary variable used internally when updating the graph. More...

bool	WalkableErosion `[get, set]`
	Stores walkability before erosion is applied. More...

int	XCoordinateInGrid `[get]`
	X coordinate of the node in the grid. More...

int	ZCoordinateInGrid `[get]`
	Z coordinate of the node in the grid. More...

Properties inherited from GraphNode
uint	Area `[get, set]`
	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	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 can be traversed. More...

Private Attributes
const int	ConnectionStride = 8

Static Private Attributes
static LayerGridGraph []	_gridGraphs = new LayerGridGraph[0]

Additional Inherited Members
Protected Member Functions inherited from GridNodeBase
	GridNodeBase (AstarPath astar)

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

Protected Attributes inherited from GridNodeBase
ushort	gridFlags

int	nodeInGridIndex
	Bitfield containing the x and z coordinates of the node as well as the layer (for layered grid graphs). More...

const int	NodeInGridIndexLayerOffset = 24

const int	NodeInGridIndexMask = 0xFFFFFF

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

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

Constructor & Destructor Documentation

◆ LevelGridNode()

LevelGridNode ( AstarPath astar )

Member Function Documentation

◆ 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.

◆ DeserializeNode()

override void DeserializeNode ( GraphSerializationContext ctx )

virtual

Deserializes node data (for example when loading graphs from file).

See also: SerializeNode

Reimplemented from GraphNode.

◆ FloodFill()

override void FloodFill	(	Stack< GraphNode >	stack,
		uint	region
	)

virtual

Internal method to run a flood fill in order to recalculate the Area property.

Reimplemented from GraphNode.

◆ GetConnection()

bool GetConnection ( int i )

Is there a grid connection in that direction.

◆ GetConnections() [1/2]

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.

◆ GetConnections() [2/2]

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

virtual

Calls the delegate with all connections and respective costs from this node.

Implements GraphNode.

◆ GetConnectionValue()

int GetConnectionValue ( int dir )

Which layer a grid connection goes to.

Parameters

dir	Direction for the connection.

Returns: The layer of the connected node or NoConnection if there is no connection in that direction.

◆ 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.

◆ GetGridGraph()

static LayerGridGraph GetGridGraph ( uint graphIndex )

static

◆ GetNeighbourAlongDirection()

override GridNodeBase GetNeighbourAlongDirection ( int direction )

virtual

Adjacent grid node in the specified direction.

This will return null if the node does not have a connection to a node in that direction.

The dir parameter corresponds to directions in the grid as:

        Z
        |
        |
     6  2  5
      \ | /
--  3 - X - 1  ----- X
      / | \
     7  0  4
        |
        |

See also: GetConnections

Implements GridNodeBase.

◆ GetPortal()

override bool GetPortal	(	GraphNode	other,
		List< Vector3 >	left,
		List< Vector3 >	right,
		bool	backwards
	)

virtual

Add a portal from this node to the specified node.

This function should add a portal to the left and right lists which is connecting the two nodes (this and other).

Parameters

other	The node which is on the other side of the portal (strictly speaking it does not actually have to be on the other side of the portal though).
left	List of portal points on the left side of the funnel
right	List of portal points on the right side of the funnel
backwards	If this is true, the call was made on a node with the other node as the node before this one in the path. In this case you may choose to do nothing since a similar call will be made to the other node with this node referenced as other (but then with backwards = true). You do not have to care about switching the left and right lists, that is done for you already.

Returns: True if the call was deemed successful. False if some unknown case was encountered and no portal could be added. If both calls to node1.GetPortal (node2,...) and node2.GetPortal (node1,...) return false, the funnel modifier will fall back to adding to the path the positions of the node.

The default implementation simply returns false.

This function may add more than one portal if necessary.

See also: http://digestingduck.blogspot.se/2010/03/simple-stupid-funnel-algorithm.html

Reimplemented from GraphNode.

◆ HasAnyGridConnections()

bool HasAnyGridConnections ( )

Does this node have any grid connections.

◆ Open()

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

virtual

Open the node.

Adds all neighbours of this node to the open list.

See also: https://en.wikipedia.org/wiki/A*_search_algorithm

Implements GraphNode.

◆ ResetAllGridConnections()

void ResetAllGridConnections ( )

Removes all grid connections from this node.

◆ SerializeNode()

override void SerializeNode ( GraphSerializationContext ctx )

virtual

Serializes node data (for example when saving graphs to file).

See also: DeserializeNode

Reimplemented from GraphNode.

◆ SetConnectionValue()

void SetConnectionValue	(	int	dir,
		int	value
	)

Set which layer a grid connection goes to.

Parameters

dir	Direction for the connection.
value	The layer of the connected node or NoConnection if there should be no connection in that direction.

◆ SetGridGraph()

static void SetGridGraph	(	int	graphIndex,
		LayerGridGraph	graph
	)

static

◆ SetPosition()

void SetPosition ( Int3 position )

◆ UpdateRecursiveG()

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

virtual

Internal method to update the G score.

Internal method to update the G score for this node and all children of it in the search graph

Reimplemented from GraphNode.

Member Data Documentation

◆ _gridGraphs

LayerGridGraph [] _gridGraphs = new LayerGridGraph[0]

staticprivate

◆ ConnectionMask

const int ConnectionMask = 0xFF

◆ ConnectionStride

const int ConnectionStride = 8

private

◆ gridConnections

ulong gridConnections

◆ gridGraphs

LayerGridGraph [] gridGraphs

staticprotected

◆ MaxLayerCount

const int MaxLayerCount = ConnectionMask

◆ NoConnection

const int NoConnection = 0xFF

Property Documentation

◆ HasConnectionsToAllEightNeighbours

override bool HasConnectionsToAllEightNeighbours

get

◆ LayerCoordinateInGrid

int LayerCoordinateInGrid

getset

Layer coordinate of the node in the grid.

If there are multiple nodes in the same (x,z) cell, then they will be stored in different layers. Together with NodeInGridIndex, you can look up the node in the nodes array

int index = node.NodeInGridIndex + node.LayerCoordinateInGrid * graph.width * graph.depth;

Assert(node == graph.nodes[index]);

See also: XCoordInGrid; ZCoordInGrid; NodeInGridIndex

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

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

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Attributes

Properties

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ LevelGridNode()

Member Function Documentation

◆ ClearConnections()

◆ DeserializeNode()

◆ FloodFill()

◆ GetConnection()

◆ GetConnections() [1/2]

◆ GetConnections() [2/2]

◆ GetConnectionValue()

◆ GetGizmoHashCode()

◆ GetGridGraph()

◆ GetNeighbourAlongDirection()

◆ GetPortal()

◆ HasAnyGridConnections()

◆ Open()

◆ ResetAllGridConnections()

◆ SerializeNode()

◆ SetConnectionValue()

◆ SetGridGraph()

◆ SetPosition()

◆ UpdateRecursiveG()

Member Data Documentation

◆ _gridGraphs

◆ ConnectionMask

◆ ConnectionStride

◆ gridConnections

◆ gridGraphs

◆ MaxLayerCount

◆ NoConnection

Property Documentation

◆ HasConnectionsToAllEightNeighbours

◆ LayerCoordinateInGrid