Technologies›AR & Spatial

RoomPlan

iOSmacOStvOSwatchOSvisionOS

RoomPlan scans a room with ARKit and LiDAR to produce a parametric 3D model of its walls, surfaces, and objects on iOS. You drive a scan through a RoomCaptureSession, observe its progress with RoomCaptureSessionDelegate and RoomCaptureViewDelegate, and feed the resulting CapturedRoomData to a RoomBuilder or StructureBuilder to construct a CapturedRoom or CapturedStructure. The captured model classifies elements by CapturedElementCategory and describes furniture in detail through enumerations such as ChairType, SofaType, StorageType, TableType, and TableShapeType.

Scanning a Room 3

Drive a room scan and build a model from the data the session captures.

  • Cl
    RoomCaptureSessioniOS 16.0+
    An object that manages the room-scanning process.
  • Cl
    RoomBuilderiOS 16.0+
    An object that generates a 3D asset from room-capture data.
  • Cl
    StructureBuilderiOS 17.0+
    An object that combines multiple scan sessions into a single captured result.

Responding to Capture Events 2

Observe the progress and results of a capture session and its view.

  • Pr
    RoomCaptureSessionDelegateiOS 16.0+
    A specification of important events in the room-scanning process.
  • Pr
    RoomCaptureViewDelegateiOS 16.0+
    A specification to post-process the results of a scan.

The Captured Model 4

The parametric structures that describe a scanned room and its raw capture data.

  • St
    CapturedRoomiOS 16.0+
    A structure that provides the key details of a scanned room.
  • St
    CapturedStructureiOS 17.0+
    An object that holds the results of the merger of multiple capture sessions.
  • St
    CapturedRoomDataiOS 16.0+
    An opaque object that holds the raw results of a scan.
  • Pr
    CapturedRoomAttributeiOS 17.0+
    Details about an object in the room that the framework observes during a scan.

Classifying Elements 1

Categorize the walls, surfaces, and objects detected in a scan.

  • En
    CapturedElementCategoryiOS 17.0+
    The category of the particular object or surface.

Describing Furniture 8

Enumerations that detail the form of chairs, sofas, storage, and tables.

  • En
    ChairTypeiOS 17.0+
    Types of chair that the framework identifies in a captured room.
  • En
    ChairArmTypeiOS 17.0+
    Types of armchair the framework identifies in a captured room.
  • En
    ChairBackTypeiOS 17.0+
    Types of chair back the framework identifies in a captured room.
  • En
    ChairLegTypeiOS 17.0+
    Types of chair legs the framework identifies in a captured room.
  • En
    SofaTypeiOS 17.0+
    Types of sofa the framework identifies in a captured room.
  • En
    StorageTypeiOS 17.0+
    Types of storage area that the framework identifies in a captured room.
  • En
    TableTypeiOS 17.0+
    Types of table the framework identifies in a captured room.
  • En
    TableShapeTypeiOS 17.0+
    Different table shapes that the framework identifies in a captured room.

Classes 1

  • Cl
    RoomCaptureViewiOS 16.0+
    A view that enables the user to scan their room with the device’s camera.
← AR & Spatial