CapturedRoom.Section

struct · iOS 17.0+ · SDK 27.1

struct Section

An object that identifies a particular area in a captured room in relation to common types of room areas in a building. When RoomPlan recognizes a captured room as one of the common kinds of room areas, such as a living room, the framework adds an instance of this structure to the room's ``CapturedRoom/sections`` array. The section instance provides: - A label type for the common area (``CapturedRoom/Section/label-swift.property``), such as ``CapturedRoom/Section/Label/livingRoom`` - A center point (``CapturedRoom/Section/center``), that generally locates the area within the room - A story (``CapturedRoom/Section/story``), that identifies a floor number for the area in the building In a larger room, the framework may identify multiple types of areas, for example, a kitchen and a dining room. In that case, the `sections` array contains both, ``CapturedRoom/Section/Label/kitchen`` and ``CapturedRoom/Section/Label/diningRoom``, and their `center` points distinguish their individual locations within the room.

Members (3)

get label(): CapturedRoom_Section_Label

var label: CapturedRoom.Section.Label { get }

get story(): number

var story: Int { get }

get center(): SDKHandle

var center: simd_float3 { get }

All RoomPlan types →