Class NavmeshBase Extends NavGraph, INavmesh, INavmeshHolder, ITransformedGraph, IRaycastableGraph

Public Abstract

Base class for RecastGraph and NavMeshGraph.

Public Methods

CalculateTransform ()

Returns a new transform which transforms graph space to world space.

Public Abstract
EndBatchTileUpdate ()

End batch updating of tiles.

Public
GetNearest (position, constraint, maxDistanceSqr)

Nearest node to a position using the specified NNConstraint.

Public
GetNodes (action)

Calls a delegate with all nodes in the graph.

Public
GetTile (x, z)

Tile at the specified x, z coordinate pair.

Public
GetTileBounds (rect)

Returns a bounds object with the bounding box of a group of tiles.

Public
GetTileBounds (x, z, width=1, depth=1)

Returns a bounds object with the bounding box of a group of tiles.

Public
GetTileBoundsInGraphSpace (rect)
Public
GetTileBoundsInGraphSpace (x, z, width=1, depth=1)

Returns an XZ bounds object with the bounds of a group of tiles in graph space.

Public
GetTileCoordinates (tileIndex, x, z)

Tile coordinates from a tile index.

Public
GetTileCoordinates (position)

Returns the tile coordinate which contains the specified position.

Public
GetTiles ()

All tiles.

Public
GetTouchingTiles (bounds, margin=0)

Returns a rect containing the indices of all tiles touching the specified bounds.

Public
GetTouchingTilesInGraphSpace (rect)

Returns a rect containing the indices of all tiles touching the specified bounds.

Public
GetTouchingTilesRound (bounds)

Returns a rect containing the indices of all tiles by rounding the specified bounds to tile borders.

Public
GetVertex (index)

Vertex coordinate for the specified vertex index.

Public
GetVertexArrayIndex (index)
Public
GetVertexInGraphSpace (index)

Vertex coordinate in graph space for the specified vertex index.

Public
Linecast (start, end)

Returns if there is an obstacle between start and end on the graph.

Public
Linecast (start, end, hint, hit)

Returns if there is an obstacle between start and end on the graph.

Public
Linecast (start, end, hint)

Returns if there is an obstacle between start and end on the graph.

Public
Linecast (start, end, hint, hit, trace)

Returns if there is an obstacle between start and end on the graph.

Public
Linecast (start, end, hit, trace, filter)

Returns if there is an obstacle between start and end on the graph.

Public
Linecast (start, end, hint, hit, trace, filter)

Returns if there is an obstacle between start and end on the graph.

Public
NavmeshBase ()
NearestNodeDistanceSqrLowerBound (position, constraint)

Lower bound on the squared distance from the given point to the closest node in this graph.

Public
OnDrawGizmos (gizmos, drawNodes, redrawScope)

Draw gizmos for the graph.

Public
PointOnNavmesh (position, constraint)

Finds the first node which contains position.

Public
RelocateNodes (deltaMatrix)

Moves the nodes in this graph.

Public
RelocateNodes (newTransform)

Moves the nodes in this graph.

Public
ReplaceTile (x, z, verts, tris)

Replace tile at index with nodes created from specified navmesh.

Public
StartBatchTileUpdate ()

Start batch updating of tiles.

Public

Public Static Methods

GetTileIndex (index)

Tile index from a vertex index.

Public Static
Linecast (graph, start, end, hint, hit)

Returns if there is an obstacle between start and end on the graph.

Public Static
Linecast (graph, origin, end, hint, hit, trace, filter=null)

Returns if there is an obstacle between origin and end on the graph.

Public Static

Public Variables

MaxTileConnectionEdgeDistance

Maximum (vertical) distance between the sides of two nodes for them to be connected across a tile edge.

Public Abstract
NavmeshCuttingCharacterRadius
OnRecalculatedTiles

Called when tiles have been completely recalculated.

Public
RecalculateNormals

Determines how normals are calculated.

Public Abstract
TileWorldSizeX

Size of a tile in world units along the X axis.

Public Abstract
TileWorldSizeZ

Size of a tile in world units along the Z axis.

Public Abstract
enableNavmeshCutting

Should navmesh cuts affect this graph.

Public
forcedBoundsSize

Size of the bounding box.

Public
isScanned
Public
navmeshUpdateData

Handles navmesh cutting.

showMeshOutline

Show an outline of the polygons in the Unity Editor.

Public
showMeshSurface

Show the surface of the navmesh.

Public
showNodeConnections

Show the connections between the polygons in the Unity Editor.

Public
tileXCount

Number of tiles along the X-axis.

Public
tileZCount

Number of tiles along the Z-axis.

Public
transform

Determines how the graph transforms graph space to world space.

Public

Public Static Variables

TileIndexMask
Public Static
TileIndexOffset
Public Static
VertexIndexMask
Public Static

Inherited Public Members

CountNodes ()

Number of nodes in the graph.

Public
GetNearest (position, constraint=null)

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

Public
GetNodes (action)

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

Public
IsInsideBounds (point)

True if the point is inside the bounding box of this graph.

Public
Scan ()

Scan the graph.

Public
Snapshot (bounds)

Captures a snapshot of a part of the graph, to allow restoring it later.

Public
active

Reference to the AstarPath object in the scene.

Public
bounds

World bounding box for the graph.

Public
drawGizmos

Enable to draw gizmos in the Unity scene view.

Public
graphIndex

Index of the graph, used for identification purposes.

Public
guid

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

Public
infoScreenOpen

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

Public
initialPenalty

Default penalty to apply to all nodes.

Public
name

Name of the graph.

Public
open

Is the graph open in the editor.

Public
persistent

True if the graph will be included when serializing graph data.

Public
showInInspector

True if the graph should be visible in the editor.

Public

Private/Protected Members

AssertSafeToUpdateGraph ()

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

Protected
ClearTile (x, z)

Clear the tile at the specified coordinate.

Protected
ConnectTileWithNeighbours (tile, onlyUnflagged=…)
Protected
ConnectTiles (tile1, tile2, tileWorldSizeX, tileWorldSizeZ, maxTileConnectionEdgeDistance)

Generate connections between the two tiles.

Internal Static
CreateNavmeshOutlineVisualization (tiles, startTile, endTile, helper)

Creates an outline of the navmesh for use in OnDrawGizmos in the editor.

Private Static
CreateNavmeshSurfaceVisualization (tiles, startTile, endTile, helper)

Creates a mesh of the surfaces of the navmesh for use in OnDrawGizmos in the editor.

Private
CreateNodeConnections (nodes, keepExistingConnections)

Create connections between all nodes.

Protected Static
CreateNodes (tile, tris, tileIndex, graphIndex, tags, astar, initialPenalty, recalculateNormals)
Internal Static
DeserializeExtraInfo (ctx)

Deserializes graph type specific node data.

Protected
DestroyAllNodes ()

Destroys all nodes in the graph.

Protected
DestroyNodes (nodes)

Destroy several nodes simultaneously.

Private Static
DirtyBounds (bounds)

Notifies the system that changes have been made inside these bounds.

Protected
DisposeUnmanagedData ()

Cleans up any unmanaged data that the graph has.

Protected
DrawUnwalkableNodes (gizmos, size, redrawScope)
Protected
FillWithEmptyTiles ()

Fills graph with tiles created by NewEmptyTile.

Protected
LinecastShapeEdgeLookup

Used to optimize linecasts by precomputing some values.

Private Static Readonly
NNConstraintNoneXZ

Cached NNConstraint.None with distanceXZ=true to reduce allocations.

Private Static Readonly
NavmeshBase ()
NewEmptyTile (x, z)

Creates a single new empty tile.

Protected
OnDestroy ()

Function for cleaning up references.

Protected
PostDeserialization (ctx)

Called after all deserialization has been done for all graphs.

Protected
PrepareNodeRecycling (x, z, verts, tris, recycledNodeBuffer)

Reuse nodes that keep the exact same vertices after a tile replacement.

Private
ScanInternal (async)

Internal method to scan the graph.

Protected
SerializeExtraInfo (ctx)

Serializes Node Info.

Protected
TryConnect (tileIdx1, tileIdx2)
Private
batchNodesToDestroy

List of nodes that are going to be destroyed as part of a batch update.

Private
batchTileUpdate

Currently updating tiles in a batch.

Private
batchUpdatedTiles

List of tiles updating during batch.

Private
exists

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

Internal
nodeRecyclingHashBuffer

Temporary buffer used in PrepareNodeRecycling.

Private
tiles

All tiles.

Protected
transform
Private

Deprecated Members

nearestSearchOnlyXZ

Perform nearest node searches in XZ space only.

Public