One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

NavigationMeshResource.Configuration

struct · iOS 27.0+ · SDK 27.1

struct Configuration

The NavigationMeshResource configuration that defines how the mesh is created.

Members (29)

get · iOS 27.0+

cellHeight

TypeScript
get cellHeight(): number
Swift declaration
var cellHeight: Double

The height of a cell, in meters.

set · iOS 27.0+

cellHeight

TypeScript
set cellHeight(value: number)
Swift declaration
var cellHeight: Double

The height of a cell, in meters.

get · iOS 27.0+

walkableClimb

TypeScript
get walkableClimb(): number
Swift declaration
var walkableClimb: Double

The maximum height difference between two surfaces that a character can walk through, in meters.

set · iOS 27.0+

walkableClimb

TypeScript
set walkableClimb(value: number)
Swift declaration
var walkableClimb: Double

The maximum height difference between two surfaces that a character can walk through, in meters.

get · iOS 27.0+

characterHeight

TypeScript
get characterHeight(): number
Swift declaration
var characterHeight: Double

The height of characters using this Navigation Mesh, representing the minimum height of obstacles above a surface to allow it to be walkable, in meters.

set · iOS 27.0+

characterHeight

TypeScript
set characterHeight(value: number)
Swift declaration
var characterHeight: Double

The height of characters using this Navigation Mesh, representing the minimum height of obstacles above a surface to allow it to be walkable, in meters.

get · iOS 27.0+

characterRadius

TypeScript
get characterRadius(): number
Swift declaration
var characterRadius: Double

The radius of characters using this Navigation Mesh, representing the minimum distance from edges or obstacles that can still be walkable, in meters.

set · iOS 27.0+

characterRadius

TypeScript
set characterRadius(value: number)
Swift declaration
var characterRadius: Double

The radius of characters using this Navigation Mesh, representing the minimum distance from edges or obstacles that can still be walkable, in meters.

get · iOS 27.0+

partitionMethod

TypeScript
get partitionMethod(): NavigationMeshResource_Configuration_PartitionMethod
Swift declaration
var partitionMethod: NavigationMeshResource.Configuration.PartitionMethod

The partitioning method to use when creating the polygon regions of the Navigation Mesh.

set · iOS 27.0+

partitionMethod

TypeScript
set partitionMethod(value: NavigationMeshResource_Configuration_PartitionMethod)
Swift declaration
var partitionMethod: NavigationMeshResource.Configuration.PartitionMethod

The partitioning method to use when creating the polygon regions of the Navigation Mesh.

get · iOS 27.0+

maximumEdgeLength

TypeScript
get maximumEdgeLength(): number
Swift declaration
var maximumEdgeLength: Double

The maximum length of polygon edges in the generated Navigation Mesh, in meters. This value can help modify the resulting Navigation Mesh to have better-looking polygons on maps with long, uninterrupted edges.

set · iOS 27.0+

maximumEdgeLength

TypeScript
set maximumEdgeLength(value: number)
Swift declaration
var maximumEdgeLength: Double

The maximum length of polygon edges in the generated Navigation Mesh, in meters. This value can help modify the resulting Navigation Mesh to have better-looking polygons on maps with long, uninterrupted edges.

get · iOS 27.0+

walkableSlopeAngle

TypeScript
get walkableSlopeAngle(): number
Swift declaration
var walkableSlopeAngle: Double

The maximum slope angle that will allow a surface to be walkable, in degrees.

set · iOS 27.0+

walkableSlopeAngle

TypeScript
set walkableSlopeAngle(value: number)
Swift declaration
var walkableSlopeAngle: Double

The maximum slope angle that will allow a surface to be walkable, in degrees.

get · iOS 27.0+

detailSampleDistance

TypeScript
get detailSampleDistance(): number
Swift declaration
var detailSampleDistance: Double

The sampling distance used when generating the detailed Navigation Mesh heightmap, in meters.

set · iOS 27.0+

detailSampleDistance

TypeScript
set detailSampleDistance(value: number)
Swift declaration
var detailSampleDistance: Double

The sampling distance used when generating the detailed Navigation Mesh heightmap, in meters.

get · iOS 27.0+

minimumCellsPerRegion

TypeScript
get minimumCellsPerRegion(): number
Swift declaration
var minimumCellsPerRegion: Int

The minimum number of cells allowed to generate isolated regions or islands in the Navigation Mesh.

set · iOS 27.0+

minimumCellsPerRegion

TypeScript
set minimumCellsPerRegion(value: number)
Swift declaration
var minimumCellsPerRegion: Int

The minimum number of cells allowed to generate isolated regions or islands in the Navigation Mesh.

get · iOS 27.0+

detailSampleMaximumError

TypeScript
get detailSampleMaximumError(): number
Swift declaration
var detailSampleMaximumError: Double

The maximum deviation from the original heightfield data allowed when creating the detailed heightmap, in meters.

set · iOS 27.0+

detailSampleMaximumError

TypeScript
set detailSampleMaximumError(value: number)
Swift declaration
var detailSampleMaximumError: Double

The maximum deviation from the original heightfield data allowed when creating the detailed heightmap, in meters.

get · iOS 27.0+

maximumVerticesPerPolygon

TypeScript
get maximumVerticesPerPolygon(): number
Swift declaration
var maximumVerticesPerPolygon: Int

The maximum vertices per polygon used when creating the Navigation Mesh.

set · iOS 27.0+

maximumVerticesPerPolygon

TypeScript
set maximumVerticesPerPolygon(value: number)
Swift declaration
var maximumVerticesPerPolygon: Int

The maximum vertices per polygon used when creating the Navigation Mesh.

get · iOS 27.0+

maximumSimplificationError

TypeScript
get maximumSimplificationError(): number
Swift declaration
var maximumSimplificationError: Double

The maximum deviation that the contours of a generated Navigation Mesh can have from the original mesh, in meters.

set · iOS 27.0+

maximumSimplificationError

TypeScript
set maximumSimplificationError(value: number)
Swift declaration
var maximumSimplificationError: Double

The maximum deviation that the contours of a generated Navigation Mesh can have from the original mesh, in meters.

get · iOS 27.0+

minimumCellsToMergeRegions

TypeScript
get minimumCellsToMergeRegions(): number
Swift declaration
var minimumCellsToMergeRegions: Int

The number of walkable cells in a region below which the region will be merged with nearby regions to simplify the Navigation Mesh.

set · iOS 27.0+

minimumCellsToMergeRegions

TypeScript
set minimumCellsToMergeRegions(value: number)
Swift declaration
var minimumCellsToMergeRegions: Int

The number of walkable cells in a region below which the region will be merged with nearby regions to simplify the Navigation Mesh.

init · iOS 27.0+

init

TypeScript
static init(cellSize: number, cellHeight: number, walkableSlopeAngle: number, characterHeight: number, walkableClimb: number, characterRadius: number): NavigationMeshResource_Configuration
Swift declaration
init(cellSize: Double, cellHeight: Double, walkableSlopeAngle: Double, characterHeight: Double, walkableClimb: Double, characterRadius: Double)
get · iOS 27.0+

cellSize

TypeScript
get cellSize(): number
Swift declaration
var cellSize: Double

The x-z size of a cell, in meters.

set · iOS 27.0+

cellSize

TypeScript
set cellSize(value: number)
Swift declaration
var cellSize: Double

The x-z size of a cell, in meters.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →