One Logo Pool Ball
RoomPlan · IOS API REFERENCE

CapturedRoom.Object

struct · iOS 16.0+ · SDK 27.1

struct Object

A 3D area in a room that the framework identifies as an object. A captured room contains an array of this type for the objects (``CapturedRoom/objects``) it identifies.

Members (8)

get · iOS 17.0+

attributes

TypeScript
get attributes(): Array<SDKHandle>
Swift declaration
var attributes: [any CapturedRoomAttribute] { get }

A collection of details that describe a particular object in the room.

get · iOS 16.0+

confidence

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

A level of certainty in the object's category.

get · iOS 16.0+

dimensions

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

A bounding box sized to the object's extremities.

get · iOS 16.0+

identifier

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

A unique alphanumeric value that the framework assigns the object.

get · iOS 17.0+

parentIdentifier

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

A unique alphanumeric value that identifies the object's parent object or surface. For example, the parent of a sink is the storage area in which the sink resides.

get · iOS 17.0+

story

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

The floor number or level on which the object resides.

get · iOS 16.0+

category

TypeScript
get category(): CapturedRoom_Object_Category
Swift declaration
var category: CapturedRoom.Object.Category { get }

A classification that the captured room assigns the object.

get · iOS 16.0+

transform

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

A matrix that defines the object's position and orientation in the room.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CapturedRoom.Object.attribute(of:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

All RoomPlan types →