One Logo Pool Ball
RealityFoundation · IOS API REFERENCE

Entity.Observable

struct · iOS 26.0+ · SDK 27.1

@frozen struct Observable

An observable interface to an entity's properties and components, enabling reactive updates using Swift's Observation framework. When you access properties in this structure, they participate in Observation. This means that the app notifies obersvers when they change in value. Each of these properties passes through to the underlying entity's corresponding properties, so modifications of them modify the entity's corresponding property.

Members (16)

get · iOS 26.0+

components

TypeScript
get components(): Promise<Entity_Observable_Components>
Swift declaration
var components: Entity.Observable.Components { get set }

The components an entity manages, enabling observation of their presence and values. This property provides a direct interface to the entity's components. When you read a component through this property's accessor, it marks that component type as accessed for observation. Observers trigger when you modify any accessed component.

set · iOS 26.0+

components

TypeScript
setComponents(value: Entity_Observable_Components): Promise<void>
Swift declaration
var components: Entity.Observable.Components { get set }

The components an entity manages, enabling observation of their presence and values. This property provides a direct interface to the entity's components. When you read a component through this property's accessor, it marks that component type as accessed for observation. Observers trigger when you modify any accessed component.

get · iOS 26.0+

orientation

TypeScript
get orientation(): Promise<SDKHandle>
Swift declaration
var orientation: simd_quatf { get set }

The entity's local orientation, allowing observation of its rotation.

set · iOS 26.0+

orientation

TypeScript
setOrientation(value: SDKHandle): Promise<void>
Swift declaration
var orientation: simd_quatf { get set }

The entity's local orientation, allowing observation of its rotation.

get · iOS 26.0+

name

TypeScript
get name(): Promise<string>
Swift declaration
var name: String { get set }

The entity's name, enabling observation of its changes.

set · iOS 26.0+

name

TypeScript
setName(value: string): Promise<void>
Swift declaration
var name: String { get set }

The entity's name, enabling observation of its changes.

get · iOS 26.0+

scale

TypeScript
get scale(): Promise<SDKHandle>
Swift declaration
var scale: SIMD3<Float> { get set }

The entity's local scale, enabling observation of its size.

set · iOS 26.0+

scale

TypeScript
setScale(value: SDKHandle): Promise<void>
Swift declaration
var scale: SIMD3<Float> { get set }

The entity's local scale, enabling observation of its size.

get · iOS 26.0+

children

TypeScript
get children(): Promise<Entity_ChildCollection>
Swift declaration
var children: Entity.ChildCollection { get set }

The collection of child entities, allowing observation of its contents

set · iOS 26.0+

children

TypeScript
setChildren(value: Entity_ChildCollection): Promise<void>
Swift declaration
var children: Entity.ChildCollection { get set }

The collection of child entities, allowing observation of its contents

get · iOS 26.0+

position

TypeScript
get position(): Promise<SDKHandle>
Swift declaration
var position: SIMD3<Float> { get set }

The entity's local position, allowing observation of its translation.

set · iOS 26.0+

position

TypeScript
setPosition(value: SDKHandle): Promise<void>
Swift declaration
var position: SIMD3<Float> { get set }

The entity's local position, allowing observation of its translation.

get · iOS 26.0+

isEnabled

TypeScript
get isEnabled(): Promise<boolean>
Swift declaration
var isEnabled: Bool { get set }

A Boolean value that indicates whether the entity is enabled in the scene, allowing observation of its state. For more information, see ``Entity/isEnabled``.

set · iOS 26.0+

isEnabled

TypeScript
setIsEnabled(value: boolean): Promise<void>
Swift declaration
var isEnabled: Bool { get set }

A Boolean value that indicates whether the entity is enabled in the scene, allowing observation of its state. For more information, see ``Entity/isEnabled``.

get · iOS 26.0+

transform

TypeScript
get transform(): Promise<Transform>
Swift declaration
var transform: Transform { get set }

The entity's position, rotation, and scale, enabling observation of its complete spatial state.

set · iOS 26.0+

transform

TypeScript
setTransform(value: Transform): Promise<void>
Swift declaration
var transform: Transform { get set }

The entity's position, rotation, and scale, enabling observation of its complete spatial state.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →