One Logo Pool Ball
RoomPlan · IOS API REFERENCE

CapturedRoom.USDExportOptions

struct · iOS 16.0+ · SDK 27.1

struct USDExportOptions

Options that determine the underlying data format of a scan export. The `exportOptions` parameter of the captured room (``CapturedRoom``) and captured structure (``CapturedStructure``) functions `export(to:metadataURL:modelProvider:exportOptions:)` are of this type. The following table lists the features that each export option supports in the output result. Feature per export option | Parametric | Mesh | Model --- | --- | --- | --- Changing the size or position of objects, windows, or doors | ✔ | | Boolean operations | ✔ | | Section positions and labels | ✔| ✔| ✔ Polygonal walls | | ✔| ✔ Windows, doors, and other openings cut out of wall geometry | | ✔| ✔ The recessed areas of a sink or fireplace | | ✔| ✔ ModelProvider models | | | ✔

Members (5)

get · iOS 16.0+

parametric

TypeScript
get parametric(): CapturedRoom_USDExportOptions
Swift declaration
static let parametric: CapturedRoom.USDExportOptions

An export option that formats the output file as a collection of size-dependent primitives. A parametric model stores elements as unit-sized cubes versus polygonal units. The scale of each element determines whether it appears as a plane or a box.

get · iOS 16.0+

mesh

TypeScript
get mesh(): CapturedRoom_USDExportOptions
Swift declaration
static let mesh: CapturedRoom.USDExportOptions

An export option that formats the output file as a collection of size-independant triangles that connect to form a mesh. A mesh model stores elements as polygonal units. You infer element size based on the bounding box around its vertices.

get · iOS 16.0+

model

TypeScript
get model(): CapturedRoom_USDExportOptions
Swift declaration
static let model: CapturedRoom.USDExportOptions

An export option that formats the output file as a collection of 3D models. This export option works in conjunction with the ``CapturedRoomAttribute`` and ``CapturedRoom/ModelProvider`` APIs to replace objects the framework identifies as of a particular category, or to have particular attributes, with 3D models that you choose in advance.

init · iOS 16.0+

init

TypeScript
init(rawValue: number): CapturedRoom_USDExportOptions
Swift declaration
init(rawValue: Int32)

Creates an export option with the specified raw value. - Parameter rawValue: A raw value for the export option.

get · iOS 16.0+

rawValue

TypeScript
getRawValue($self: CapturedRoom_USDExportOptions): number
Swift declaration
let rawValue: Int32

A raw value for the export option.

Skipped declarations

No declarations were skipped in this snapshot.

All RoomPlan types →