Building local experiences with room tracking
At a glance
| Item | Summary |
|---|---|
| Purpose | Use room tracking in visionOS to provide custom interactions with physical spaces. |
| App architecture | A Swift sample with the source-visible chain ARKitRoomTrackingApp → ContentView → RealityKit / SwiftUI APIs. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 5 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: @MainActor, Task, await suspension point; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: SwiftUI state property wrapper, @Observable. |
| Key frameworks/packages | RealityKit, SwiftUI, ARKit, OSLog; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ARKitRoomTracking/
│ ├── ARKitRoomTrackingApp.swift
│ ├── ContentView.swift
│ ├── WorldAndRoomView.swift
│ ├── AppState.swift
│ ├── Extensions.swift
│ └── Info.plist
├── ARKitRoomTracking.xcodeproj/
│ ├── .xcodesamplecode.plist
│ └── project.pbxproj
└── Configuration/
└── SampleCode.xcconfig
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 4 project/configuration file(s) and 6 source declaration(s).
Overall architecture
flowchart LR
N1["ARKitRoomTrackingApp"]
N2["ContentView"]
N3["RealityKit / SwiftUI APIs"]
N1 --> N2
N2 --> N3
Reference code
ARKitRoomTracking/ARKitRoomTrackingApp.swift:13 — architecture anchor
@main
@MainActor
struct ARKitRoomTrackingApp: App {
@State private var appState = AppState()
var body: some Scene {
WindowGroup {
ContentView()
.environment(appState)
}.defaultSize(CGSize(width: 800, height: 400))
ImmersiveSpace(id: immersiveSpace) {
WorldAndRoomView()
.environment(appState)
}
}
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into visionOS.
Ownership and state
classDiagram
ARKitRoomTrackingApp *-- AppState : appState
ARKitRoomTrackingApp *-- Logger : logger
WorldAndRoomView *-- Entity : previewSphere
WorldAndRoomView *-- Task : updateFacingWallTask
Ownership evidence
ARKitRoomTracking/ARKitRoomTrackingApp.swift:17 — stored dependency or nearest verified ownership anchor
@main
@MainActor
struct ARKitRoomTrackingApp: App {
// ...
@State private var appState = AppState()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
ARKitRoomTrackingApp |
AppState (appState) |
owns wrapper-managed state | Owning lexical scope |
ARKitRoomTrackingApp |
Logger (logger) |
creates and retains | Initialized by the owner; the binding is immutable |
WorldAndRoomView |
Entity (previewSphere) |
owns wrapper-managed state | App/module collaborators |
WorldAndRoomView |
Task (updateFacingWallTask) |
owns wrapper-managed state | Owning lexical scope |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Main isolation | @MainActor |
The cited annotation marks its attached declaration or closure as main-actor isolated. | ARKitRoomTracking/ARKitRoomTrackingApp.swift:14 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | ARKitRoomTracking/AppState.swift:112 |
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | ARKitRoomTracking/AppState.swift:113 |
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
Reference code
ARKitRoomTracking/ARKitRoomTrackingApp.swift:14 — representative execution boundary
@main
@MainActor
struct ARKitRoomTrackingApp: App {
// ...
@State private var appState = AppState()
// ...
}State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | ARKitRoomTracking/ARKitRoomTrackingApp.swift:17 |
| State propagation | @Observable |
Observation macro publishes source-visible changes. | ARKitRoomTracking/AppState.swift:12 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitRoomTracking/AppState.swift:8 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitRoomTracking/ARKitRoomTrackingApp.swift:8 |
| Source import | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitRoomTracking/AppState.swift:7 |
| Source import | OSLog |
The cited file imports this module; runtime use and architectural role are not inferred. | ARKitRoomTracking/ARKitRoomTrackingApp.swift:7 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
ARKitRoomTracking/ARKitRoomTrackingApp.swift:15 — representative type boundary
@main
@MainActor
struct ARKitRoomTrackingApp: App {
// ...
@State private var appState = AppState()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
ARKitRoomTrackingApp |
Application entry and top-level composition | App |
ContentView |
User-interface presentation and input forwarding | View |
WorldAndRoomView |
User-interface presentation and input forwarding | View |
AppState |
Represents mutable feature state | Concrete collaborators/imported frameworks |
VisualizationState |
Represents mutable feature state | Concrete collaborators/imported frameworks |
ErrorState |
Represents mutable feature state | Equatable |
No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
appState (ARKitRoomTracking/ARKitRoomTrackingApp.swift:17) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
session (ARKitRoomTracking/AppState.swift:39) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
worldTracking (ARKitRoomTracking/AppState.swift:40) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
roomTracking (ARKitRoomTracking/AppState.swift:41) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
ARKitRoomTracking/ARKitRoomTrackingApp.swift:17 — representative boundary
@main
@MainActor
struct ARKitRoomTrackingApp: App {
@State private var appState = AppState()
var body: some Scene {
WindowGroup {
ContentView()
.environment(appState)
}.defaultSize(CGSize(width: 800, height: 400))
ImmersiveSpace(id: immersiveSpace) {
WorldAndRoomView()
.environment(appState)
}
}
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| Application entry and top-level composition | ARKitRoomTrackingApp |
The source’s App suffix makes this role explicit. |
| User-interface presentation and input forwarding | ContentView, WorldAndRoomView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| No named application pattern | ARKitRoomTracking/ARKitRoomTrackingApp.swift:13 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Naming conventions
- Types: App: ARKitRoomTrackingApp; View: ContentView, WorldAndRoomView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
createPreviewSphere,run,setupContentEntity,areAllDataProvidersAuthorized,runSession,isSphereInCurrentRoom,updateSphereState,getNearestWall. - Files:
ARKitRoomTracking/ARKitRoomTrackingApp.swift,ARKitRoomTracking/ContentView.swift,ARKitRoomTracking/WorldAndRoomView.swift,ARKitRoomTracking/AppState.swift.
Architecture takeaways
ARKitRoomTrackingAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches RealityKit, SwiftUI, ARKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- The source does not justify labeling the design protocol-oriented.
Source map
| Source file | Relevant symbols |
|---|---|
ARKitRoomTracking/ARKitRoomTrackingApp.swift |
Cited implementation, ARKitRoomTrackingApp, @MainActor, SwiftUI state property wrapper, SwiftUI, OSLog |
ARKitRoomTracking/AppState.swift |
Cited implementation, Task, await suspension point, @Observable, RealityKit, ARKit, AppState, VisualizationState, ErrorState |
ARKitRoomTracking/ContentView.swift |
ContentView |
ARKitRoomTracking/WorldAndRoomView.swift |
WorldAndRoomView |
ARKitRoomTracking/Extensions.swift |
Feature implementation |