NavigationMeshResource
A representation of a scene’s navigable surfaces that the system uses to compute paths.
Declaration
class NavigationMeshResourceOverview
Build a navigation mesh from a model’s geometry or from raw vertex and polygon data, then mark areas and flags to describe where agents can travel and at what cost. Provide the resulting resource to a NavigationMeshComponent so a NavigationController can find paths across it.
Topics
Creating a navigation mesh
init(mesh:offMeshConnections:configuration:)init(mesh:offMeshConnections:configuration:)init(meshDescriptor:offMeshConnections:configuration:)init(meshDescriptor:offMeshConnections:configuration:)init(triangleIndices:vertices:offMeshConnections:configuration:)init(triangleIndices:vertices:offMeshConnections:configuration:)init(polygonIndices:vertices:offMeshConnections:configuration:areas:flags:heightData:)
Marking areas and flags
markAreaInBox(boundingBox:area:)markFlagInBox(boundingBox:flag:)markAreaInCylinder(position:radius:halfHeight:area:)markFlagInCylinder(position:radius:halfHeight:flag:)markAreaOnPolygons(polygonIndices:area:)markFlagOnPolygons(polygonIndices:flag:)markAreaOnOffMeshConnections(offMeshConnectionIndices:area:)markFlagOnOffMeshConnections(offMeshConnectionIndices:flag:)
Removing areas and flags
removeAreaInBox(boundingBox:area:)removeFlagInBox(boundingBox:flag:)removeAreaInCylinder(position:radius:halfHeight:area:)removeFlagInCylinder(position:radius:halfHeight:flag:)removeAreaOnPolygons(polygonIndices:area:)removeFlagOnPolygons(polygonIndices:flag:)removeAreaOnOffMeshConnections(offMeshConnectionIndices:area:)removeFlagOnOffMeshConnections(offMeshConnectionIndices:flag:)
Accessing mesh data
Supporting types
NavigationMeshResource.ConfigurationNavigationMeshResource.AreaNavigationMeshResource.FlagNavigationMeshResource.FlagGroupNavigationMeshResource.OffMeshConnectionNavigationMeshResource.HeightDataNavigationMeshResource.LayerNavigationMeshResource.PathNode