RealityFoundation · IOS API REFERENCE

NavigationComponent.Filter

struct · iOS 27.0+ · SDK 27.1

struct Filter

A struct that stores information about flags to ignore and include, and area costs for a pathfind.

Members (7)

get · iOS 27.0+

ignoreFlags

TypeScript

get ignoreFlags(): NavigationMeshResource_FlagGroup

Swift declaration

var ignoreFlags: NavigationMeshResource.FlagGroup

The set of flags to ignore when pathfinding. The path will not be able to move through any polygons with any of these flags set.

set · iOS 27.0+

ignoreFlags

TypeScript

set ignoreFlags(value: NavigationMeshResource_FlagGroup)

Swift declaration

var ignoreFlags: NavigationMeshResource.FlagGroup

The set of flags to ignore when pathfinding. The path will not be able to move through any polygons with any of these flags set.

get · iOS 27.0+

includeFlags

TypeScript

get includeFlags(): NavigationMeshResource_FlagGroup

Swift declaration

var includeFlags: NavigationMeshResource.FlagGroup

The set of flags to include when pathfinding. The path will only move through polygons that have any of these flags set.

set · iOS 27.0+

includeFlags

TypeScript

set includeFlags(value: NavigationMeshResource_FlagGroup)

Swift declaration

var includeFlags: NavigationMeshResource.FlagGroup

The set of flags to include when pathfinding. The path will only move through polygons that have any of these flags set.

get · iOS 27.0+

areaCosts

TypeScript

get areaCosts(): NativeMap<NavigationMeshResource_Area, number>

Swift declaration

var areaCosts: [NavigationMeshResource.Area : Float]

The costs for pathing through an area. The path can move through polygons with these areas, but will try to find the lowest-cost path, avoiding high-cost areas if possible.

set · iOS 27.0+

areaCosts

TypeScript

set areaCosts(value: NativeMap<NavigationMeshResource_Area, number>)

Swift declaration

var areaCosts: [NavigationMeshResource.Area : Float]

The costs for pathing through an area. The path can move through polygons with these areas, but will try to find the lowest-cost path, avoiding high-cost areas if possible.

init · iOS 27.0+

init

TypeScript

static init(): NavigationComponent_Filter

Swift declaration

init()

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →