One Logo Pool Ball
RoomPlan · IOS API REFERENCE

CapturedRoom.Surface

struct · iOS 16.0+ · SDK 27.1

struct Surface

A 2D area in a room that the framework identifies as a surface. A captured room (``CapturedRoom``) contains an arrays of surfaces that it identifies in a scan, such as its ``CapturedRoom/doors``, ``CapturedRoom/openings``, ``CapturedRoom/walls``, and ``CapturedRoom/windows``.

Members (10)

get · iOS 16.0+

confidence

TypeScript
get confidence(): CapturedRoom_Confidence
Swift declaration
var confidence: CapturedRoom.Confidence { get }

A level of certainty in the surface's category.

get · iOS 16.0+

dimensions

TypeScript
get dimensions(): SDKHandle
Swift declaration
var dimensions: simd_float3 { get }

A bounding box that contains the surface.

get · iOS 16.0+

identifier

TypeScript
get identifier(): string
Swift declaration
var identifier: UUID { get }

A unique alphanumeric value that the framework assigns the surface.

get · iOS 16.0+

completedEdges

TypeScript
get completedEdges(): Array<CapturedRoom_Surface_Edge>
Swift declaration
var completedEdges: Set<CapturedRoom.Surface.Edge> { get }

An array of edges that outline the surface.

get · iOS 17.0+

polygonCorners

TypeScript
get polygonCorners(): Array<SDKHandle>
Swift declaration
var polygonCorners: [simd_float3] { get }

A 2D polygon that represents nonuniform wall heights and floor shapes. This property's triplet type describes the polygon in local plane coordinates.

get · iOS 17.0+

parentIdentifier

TypeScript
get parentIdentifier(): (string) | null
Swift declaration
var parentIdentifier: UUID? { get }

A unique alphanumeric value that identifies a surface's parent surface. For example, the parent of a window is the wall surface on which the window rests.

get · iOS 16.0+

curve

TypeScript
get curve(): (CapturedRoom_Surface_Curve) | null
Swift declaration
var curve: CapturedRoom.Surface.Curve? { get }

An object that represents the curve of a surface.

get · iOS 17.0+

story

TypeScript
get story(): number
Swift declaration
var story: Int { get }

indicator for which story, level, or floor

get · iOS 16.0+

category

TypeScript
get category(): CapturedRoom_Surface_Category
Swift declaration
var category: CapturedRoom.Surface.Category { get }

A classification that the captured room assigns the surface.

get · iOS 16.0+

transform

TypeScript
get transform(): SDKHandle
Swift declaration
var transform: simd_float4x4 { get }

A matrix that defines the surface's position and orientation in the scene.

Skipped declarations

No declarations were skipped in this snapshot.

All RoomPlan types →