RealityFoundation · IOS API REFERENCE

NavigationMeshResource

class · iOS 27.0+ · SDK 27.1

class NavigationMeshResource

Members (34)

method · iOS 27.0+

markAreaOnOffMeshConnections

TypeScript

markAreaOnOffMeshConnections(offMeshConnectionIndices: Array<number>, area: NavigationMeshResource_Area): void

Swift declaration

func markAreaOnOffMeshConnections(offMeshConnectionIndices: [Int], area: NavigationMeshResource.Area)

Marks the off-mesh connections at these indices with an area.

method · iOS 27.0+

markFlagOnOffMeshConnections

TypeScript

markFlagOnOffMeshConnections(offMeshConnectionIndices: Array<number>, flag: NavigationMeshResource_Flag): void

Swift declaration

func markFlagOnOffMeshConnections(offMeshConnectionIndices: [Int], flag: NavigationMeshResource.Flag)

Marks the off-mesh connections at these indices with a flag.

method · iOS 27.0+

removeAreaOnOffMeshConnections

TypeScript

removeAreaOnOffMeshConnections(offMeshConnectionIndices: Array<number>, area: NavigationMeshResource_Area): void

Swift declaration

func removeAreaOnOffMeshConnections(offMeshConnectionIndices: [Int], area: NavigationMeshResource.Area)

Removes the area from the off-mesh connections at these indices.

method · iOS 27.0+

removeFlagOnOffMeshConnections

TypeScript

removeFlagOnOffMeshConnections(offMeshConnectionIndices: Array<number>, flag: NavigationMeshResource_Flag): void

Swift declaration

func removeFlagOnOffMeshConnections(offMeshConnectionIndices: [Int], flag: NavigationMeshResource.Flag)

Removes the flag from the off-mesh connections at these indices.

get · iOS 27.0+

offMeshConnections

TypeScript

get offMeshConnections(): Array<NavigationMeshResource_OffMeshConnection>

Swift declaration

var offMeshConnections: [NavigationMeshResource.OffMeshConnection] { get }

The off-mesh connections of the generated Navigation Mesh.

get · iOS 27.0+

heightData

TypeScript

get heightData(): NavigationMeshResource_HeightData

Swift declaration

var heightData: NavigationMeshResource.HeightData { get }

The detailed height data of the generated Navigation Mesh.

get · iOS 27.0+

configuration

TypeScript

get configuration(): NavigationMeshResource_Configuration

Swift declaration

var configuration: NavigationMeshResource.Configuration { get }

The configuration this Navigation Mesh was created with.

method · iOS 27.0+

markAreaInBox

TypeScript

markAreaInBox(boundingBox: BoundingBox, area: NavigationMeshResource_Area): void

Swift declaration

func markAreaInBox(boundingBox: BoundingBox, area: NavigationMeshResource.Area)

Marks all polygons in this box with an area.

method · iOS 27.0+

markFlagInBox

TypeScript

markFlagInBox(boundingBox: BoundingBox, flag: NavigationMeshResource_Flag): void

Swift declaration

func markFlagInBox(boundingBox: BoundingBox, flag: NavigationMeshResource.Flag)

Marks all polygons in this box with a flag.

init · iOS 27.0+

init

TypeScript

static initMeshDescriptorOffMeshConnectionsConfiguration(meshDescriptor: MeshDescriptor, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration): NavigationMeshResource

Swift declaration

convenience init(meshDescriptor: MeshDescriptor, offMeshConnections: [NavigationMeshResource.OffMeshConnection] = [], configuration: NavigationMeshResource.Configuration) throws

Creates a NavigationMeshResource from a MeshDescriptor. This will take the input geometry and configuration and process it into a Navigation Mesh. The input and final geometry of the Navigation Mesh may not match, as it strives to simplify regions and match the configuration to determine what areas are walkable.

init · iOS 27.0+

init

TypeScript

static initMeshDescriptorOffMeshConnectionsConfiguration92272(meshDescriptor: MeshDescriptor, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration): Promise<NavigationMeshResource>

Swift declaration

convenience init(meshDescriptor: MeshDescriptor, offMeshConnections: [NavigationMeshResource.OffMeshConnection] = [], configuration: NavigationMeshResource.Configuration) async throws

Asynchronously creates a NavigationMeshResource from a MeshDescriptor. This will take the input geometry and configuration and process it into a Navigation Mesh. The input and final geometry of the Navigation Mesh may not match, as it strives to simplify regions and match the configuration to determine what areas are walkable.

init · iOS 27.0+

init

TypeScript

static initPolygonIndicesVerticesOffMeshConnectionsConfigurationAreasFlagsHeightData(polygonIndices: Array<Array<number>>, vertices: Array<SDKHandle>, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration, areas: Array<NavigationMeshResource_Area>, flags: Array<Array<NavigationMeshResource_Flag>>, heightData: NavigationMeshResource_HeightData): NavigationMeshResource

Swift declaration

convenience init(polygonIndices: [[Int]], vertices: [SIMD3<Float>], offMeshConnections: [NavigationMeshResource.OffMeshConnection], configuration: NavigationMeshResource.Configuration, areas: [NavigationMeshResource.Area], flags: [[NavigationMeshResource.Flag]], heightData: NavigationMeshResource.HeightData) throws

Creates a NavigationMeshResource through existing Navigation Mesh data. This will not regenerate the Navigation Mesh. It will copy and save the input data to create a Navigation Mesh with this information.

get · iOS 27.0+

polygonIndices

TypeScript

get polygonIndices(): Array<Array<number>>

Swift declaration

var polygonIndices: [[Int]] { get }

The polygon indices of the generated Navigation Mesh. Polygons may have different numbers of vertices, so each entry in the list is a list of indices into the vertices array for that polygon.

method · iOS 27.0+

removeAreaInBox

TypeScript

removeAreaInBox(boundingBox: BoundingBox, area: NavigationMeshResource_Area): void

Swift declaration

func removeAreaInBox(boundingBox: BoundingBox, area: NavigationMeshResource.Area)

Removes the area from all polygons in this box.

method · iOS 27.0+

removeFlagInBox

TypeScript

removeFlagInBox(boundingBox: BoundingBox, flag: NavigationMeshResource_Flag): void

Swift declaration

func removeFlagInBox(boundingBox: BoundingBox, flag: NavigationMeshResource.Flag)

Removes the flag from all polygons in this box.

init · iOS 27.0+

init

TypeScript

static initTriangleIndicesVerticesOffMeshConnectionsConfiguration(triangleIndices: Array<number>, vertices: Array<SDKHandle>, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration): NavigationMeshResource

Swift declaration

init(triangleIndices: [UInt32], vertices: [SIMD3<Float>], offMeshConnections: [NavigationMeshResource.OffMeshConnection] = [], configuration: NavigationMeshResource.Configuration) throws

Creates a NavigationMeshResource from triangle indices and vertices. This will take the input geometry and configuration and process it into a Navigation Mesh. The input and final geometry of the Navigation Mesh may not match, as it strives to simplify regions and match the configuration to determine what areas are walkable.

init · iOS 27.0+

init

TypeScript

static initTriangleIndicesVerticesOffMeshConnectionsConfiguration92546(triangleIndices: Array<number>, vertices: Array<SDKHandle>, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration): Promise<NavigationMeshResource>

Swift declaration

convenience init(triangleIndices: [UInt32], vertices: [SIMD3<Float>], offMeshConnections: [NavigationMeshResource.OffMeshConnection] = [], configuration: NavigationMeshResource.Configuration) async throws

Asynchronously creates a NavigationMeshResource from triangle indices and vertices. This will take the input geometry and configuration and process it into a Navigation Mesh. The input and final geometry of the Navigation Mesh may not match, as it strives to simplify regions and match the configuration to determine what areas are walkable.

method · iOS 27.0+

markAreaInCylinder

TypeScript

markAreaInCylinder(position: SDKHandle, radius: number, halfHeight: number, area: NavigationMeshResource_Area): void

Swift declaration

func markAreaInCylinder(position: SIMD3<Float>, radius: Float, halfHeight: Float, area: NavigationMeshResource.Area)

Marks all polygons in this cylinder with an area.

method · iOS 27.0+

markAreaOnPolygons

TypeScript

markAreaOnPolygons(polygonIndices: Array<number>, area: NavigationMeshResource_Area): void

Swift declaration

func markAreaOnPolygons(polygonIndices: [Int], area: NavigationMeshResource.Area)

Marks the polygons at these indices with an area.

method · iOS 27.0+

markFlagInCylinder

TypeScript

markFlagInCylinder(position: SDKHandle, radius: number, halfHeight: number, flag: NavigationMeshResource_Flag): void

Swift declaration

func markFlagInCylinder(position: SIMD3<Float>, radius: Float, halfHeight: Float, flag: NavigationMeshResource.Flag)

Marks all polygons in this cylinder with a flag.

method · iOS 27.0+

markFlagOnPolygons

TypeScript

markFlagOnPolygons(polygonIndices: Array<number>, flag: NavigationMeshResource_Flag): void

Swift declaration

func markFlagOnPolygons(polygonIndices: [Int], flag: NavigationMeshResource.Flag)

Marks the polygons at these indices with a flag.

method · iOS 27.0+

removeAreaInCylinder

TypeScript

removeAreaInCylinder(position: SDKHandle, radius: number, halfHeight: number, area: NavigationMeshResource_Area): void

Swift declaration

func removeAreaInCylinder(position: SIMD3<Float>, radius: Float, halfHeight: Float, area: NavigationMeshResource.Area)

Removes the area from all polygons in this cylinder.

method · iOS 27.0+

removeAreaOnPolygons

TypeScript

removeAreaOnPolygons(polygonIndices: Array<number>, area: NavigationMeshResource_Area): void

Swift declaration

func removeAreaOnPolygons(polygonIndices: [Int], area: NavigationMeshResource.Area)

Removes the area from the polygons at these indices.

method · iOS 27.0+

removeFlagInCylinder

TypeScript

removeFlagInCylinder(position: SDKHandle, radius: number, halfHeight: number, flag: NavigationMeshResource_Flag): void

Swift declaration

func removeFlagInCylinder(position: SIMD3<Float>, radius: Float, halfHeight: Float, flag: NavigationMeshResource.Flag)

Removes the flag from all polygons in this cylinder.

method · iOS 27.0+

removeFlagOnPolygons

TypeScript

removeFlagOnPolygons(polygonIndices: Array<number>, flag: NavigationMeshResource_Flag): void

Swift declaration

func removeFlagOnPolygons(polygonIndices: [Int], flag: NavigationMeshResource.Flag)

Removes the flag from the polygons at these indices.

init · iOS 27.0+

init

TypeScript

static initMeshOffMeshConnectionsConfiguration(mesh: MeshResource, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration): NavigationMeshResource

Swift declaration

convenience init(mesh: MeshResource, offMeshConnections: [NavigationMeshResource.OffMeshConnection] = [], configuration: NavigationMeshResource.Configuration) throws

Creates a NavigationMeshResource from a MeshResource. This will take the input geometry and configuration and process it into a Navigation Mesh. The input and final geometry of the Navigation Mesh may not match, as it strives to simplify regions and match the configuration to determine what areas are walkable.

init · iOS 27.0+

init

TypeScript

static initMeshOffMeshConnectionsConfiguration60929(mesh: MeshResource, offMeshConnections: Array<NavigationMeshResource_OffMeshConnection>, configuration: NavigationMeshResource_Configuration): Promise<NavigationMeshResource>

Swift declaration

convenience init(mesh: MeshResource, offMeshConnections: [NavigationMeshResource.OffMeshConnection] = [], configuration: NavigationMeshResource.Configuration) async throws

Asynchronously creates a NavigationMeshResource from a MeshResource. This will take the input geometry and configuration and process it into a Navigation Mesh. The input and final geometry of the Navigation Mesh may not match, as it strives to simplify regions and match the configuration to determine what areas are walkable.

get · iOS 27.0+

areas

TypeScript

get areas(): Array<NavigationMeshResource_Area>

Swift declaration

var areas: [NavigationMeshResource.Area] { get }

The areas associated with each polygon in the generated Navigation Mesh.

get · iOS 27.0+

flags

TypeScript

get flags(): Array<Array<NavigationMeshResource_Flag>>

Swift declaration

var flags: [[NavigationMeshResource.Flag]] { get }

The flags associated with each polygon in the generated Navigation Mesh.

get · iOS 27.0+

layer

TypeScript

get layer(): (NavigationMeshResource_Layer) | null

Swift declaration

var layer: NavigationMeshResource.Layer? { get set }

The identification of this NavigationMeshResource, used when entities are searching for a specific NavigationMeshResource in a scene.

set · iOS 27.0+

layer

TypeScript

set layer(value: (NavigationMeshResource_Layer) | null)

Swift declaration

var layer: NavigationMeshResource.Layer? { get set }

The identification of this NavigationMeshResource, used when entities are searching for a specific NavigationMeshResource in a scene.

init · iOS 27.0+

init

TypeScript

static initNamedIn(name: string, bundle?: (_Foundation_Bundle) | null): NavigationMeshResource

Swift declaration

convenience init(named name: String, in bundle: Bundle? = nil) throws

Creates a NavigationMeshResource by importing an existing one from a Bundle. The name is the path of the NavigationMeshResource within the bundle. The bundle is the app package that contains the NavigationMeshResource. If nothing is specified, then the main bundle is used. This loads an existing Navigation Mesh and will not process and create a new one.

init · iOS 27.0+

init

TypeScript

static initNamedIn82766(name: string, bundle?: (_Foundation_Bundle) | null): Promise<NavigationMeshResource>

Swift declaration

convenience init(named name: String, in bundle: Bundle? = nil) async throws

Asynchronously creates a NavigationMeshResource by importing an existing one from a Bundle. The name is the path of the NavigationMeshResource within the bundle. The bundle is the app package that contains the NavigationMeshResource. If nothing is specified, then the main bundle is used. This loads an existing Navigation Mesh and will not process and create a new one.

get · iOS 27.0+

vertices

TypeScript

get vertices(): Array<SDKHandle>

Swift declaration

var vertices: [SIMD3<Float>] { get }

The vertices of the generated Navigation Mesh.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →