confidence
TypeScriptget confidence(): CapturedRoom_ConfidenceSwift declarationvar confidence: CapturedRoom.Confidence { get }A level of certainty in the surface's category.
struct · iOS 16.0+ · SDK 27.1
struct SurfaceA 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``.
get confidence(): CapturedRoom_ConfidenceSwift declarationvar confidence: CapturedRoom.Confidence { get }A level of certainty in the surface's category.
get dimensions(): SDKHandleSwift declarationvar dimensions: simd_float3 { get }A bounding box that contains the surface.
get identifier(): stringSwift declarationvar identifier: UUID { get }A unique alphanumeric value that the framework assigns the surface.
get completedEdges(): Array<CapturedRoom_Surface_Edge>Swift declarationvar completedEdges: Set<CapturedRoom.Surface.Edge> { get }An array of edges that outline the surface.
get polygonCorners(): Array<SDKHandle>Swift declarationvar 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 parentIdentifier(): (string) | nullSwift declarationvar 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 curve(): (CapturedRoom_Surface_Curve) | nullSwift declarationvar curve: CapturedRoom.Surface.Curve? { get }An object that represents the curve of a surface.
get story(): numberSwift declarationvar story: Int { get }indicator for which story, level, or floor
get category(): CapturedRoom_Surface_CategorySwift declarationvar category: CapturedRoom.Surface.Category { get }A classification that the captured room assigns the surface.
get transform(): SDKHandleSwift declarationvar transform: simd_float4x4 { get }A matrix that defines the surface's position and orientation in the scene.
No declarations were skipped in this snapshot.