One Logo Pool Ball
RoomPlan · IOS API REFERENCE

CapturedRoom.Object.Category

enum · iOS 16.0+ · SDK 27.1

enum Category

Classifications of an object in a captured room. Each ``CapturedRoom/Object`` instance in a captured room's ``CapturedRoom/objects`` array reflects a classification (``RoomPlan/CapturedRoom/Object/category-swift.property``) of this type.

Members (3)

method · iOS 17.0+

supportsCombination

TypeScript
supportsCombination($self: CapturedRoom_Object_Category, attributes: Array<SDKHandle>): boolean
Swift declaration
func supportsCombination(_ attributes: [any CapturedRoomAttribute]) -> Bool

Returns a Boolean value that indicates whether a category supports the given attribute combination. Only compatible attributes can pair up in association with a 3D model, for example, with the ``CapturedRoom/ModelProvider`` function ``CapturedRoom/ModelProvider/setModelFileURL(_:for:)-8xio``. These ``CapturedRoom/ModelProvider`` functions for `setModelFileURL` and `modelFileURL` throw ``CapturedRoom/ModelProvider/Error/attributeCombinationNotSupported`` if no object category supports all of the attributes in the arguments to their call. - parameter attributes: An array of attributes to check whether the object supports them.

get · iOS 17.0+

supportedCombinations

TypeScript
getSupportedCombinations($self: CapturedRoom_Object_Category): Array<Array<SDKHandle>>
Swift declaration
var supportedCombinations: [[any CapturedRoomAttribute]] { get }

An array of supported attributes that differs by category. The framework defines the contents of this array. Only compatible attributes can pair up in association with a 3D model, for example, with the ``CapturedRoom/ModelProvider`` function ``CapturedRoom/ModelProvider/setModelFileURL(_:for:)-8xio``. These ``CapturedRoom/ModelProvider`` functions for `setModelFileURL` and `modelFileURL` throw ``CapturedRoom/ModelProvider/Error/attributeCombinationNotSupported`` if no object category supports all of the attributes in the arguments to their call.

get · iOS 16.0+

allCases

TypeScript
get allCases(): Array<CapturedRoom_Object_Category>
Swift declaration
nonisolated static var allCases: [CapturedRoom.Object.Category] { get }

A collection of all values of this type.

Skipped declarations

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

CapturedRoom.Object.Category.supportedAttributeTypes

Passing a Swift type itself is not supported.

All RoomPlan types →