RoomPlan · IOS API REFERENCE

CapturedStructure

struct · iOS 17.0+ · SDK 27.1

struct CapturedStructure

An object that holds the results of the merger of multiple capture sessions. This structure combines the data from multiple ``CapturedRoom`` instances that a user scans in the same physical vicinity. The ``StructureBuilder`` class's function merges the captured rooms with the ``StructureBuilder/capturedStructure(from:)`` function, which returns an object of this type.

Members (11)

get · iOS 17.0+

identifier

TypeScript

get identifier(): string

Swift declaration

var identifier: UUID { get }

A unique alphanumeric value that the framework assigns the structure.

get · iOS 17.0+

doors

TypeScript

get doors(): Array<CapturedRoom_Surface>

Swift declaration

var doors: [CapturedStructure.Surface] { get }

An array of all the doors in the structure.

get · iOS 17.0+

rooms

TypeScript

get rooms(): Array<CapturedRoom>

Swift declaration

var rooms: [CapturedRoom] { get }

An array of all the captured rooms in the structure. A captured structure contains all the captured rooms that a user scans in the same physical vicinity, and then merges into a single captured instance with the ``RoomPlan/StructureBuilder/capturedStructure(from:)`` function.

get · iOS 17.0+

walls

TypeScript

get walls(): Array<CapturedRoom_Surface>

Swift declaration

var walls: [CapturedStructure.Surface] { get }

An array of all the walls in the structure.

method · iOS 17.0+

export

TypeScript

export(url: string, metadataURL?: (string) | null, modelProvider?: (CapturedRoom_ModelProvider) | null, exportOptions?: CapturedRoom_USDExportOptions): void

Swift declaration

func export(to url: URL, metadataURL: URL? = nil, modelProvider: CapturedStructure.ModelProvider? = nil, exportOptions: CapturedStructure.USDExportOptions = .mesh) throws

Produces a 3D asset from the captured structure. The file format of the output is Universal Scene Description (USD). > Tip: Before iOS 17.4, the first letter of the USD file name needs to be a character other than a number. - Parameter url: A location that the captured structure exports to. - Parameter metadataURL: A location that the captured room metadata exports to. - Parameter modelProvider: A collection of mappings of object categories and attributes to 3D model URLs. - Parameter exportOptions: Options that determine the export's data format.

get · iOS 17.0+

floors

TypeScript

get floors(): Array<CapturedRoom_Surface>

Swift declaration

var floors: [CapturedStructure.Surface] { get }

An array of all the floors in the structure.

get · iOS 17.0+

objects

TypeScript

get objects(): Array<CapturedRoom_Object>

Swift declaration

var objects: [CapturedStructure.Object] { get }

An array of all the objects in the structure.

get · iOS 17.0+

version

TypeScript

get version(): number

Swift declaration

var version: Int { get }

A version number for the captured structure.

get · iOS 17.0+

windows

TypeScript

get windows(): Array<CapturedRoom_Surface>

Swift declaration

var windows: [CapturedStructure.Surface] { get }

An array of all the windows in the structure.

get · iOS 17.0+

openings

TypeScript

get openings(): Array<CapturedRoom_Surface>

Swift declaration

var openings: [CapturedStructure.Surface] { get }

An array of all the openings in the structure.

get · iOS 17.0+

sections

TypeScript

get sections(): Array<CapturedRoom_Section>

Swift declaration

var sections: [CapturedStructure.Section] { get }

One or more room types that the framework identifies in the structure.

Skipped declarations

No declarations were skipped in this snapshot.

All RoomPlan types →