Object tracking with Reality Composer Pro experiences
At a glance
| Item | Summary |
|---|---|
| Purpose | Use object tracking in visionOS to attach digital content to real objects to create engaging experiences. |
| App architecture | A Swift sample with the source-visible chain ObjectTrackingExperiencesSampleApp → ContentView → AppModel → FadeOutSystem → SwiftUI / RealityKit APIs. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 11 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: @MainActor, async declaration or closure, Task, DispatchQueue.main.asyncAfter, Task closure isolated to MainActor; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: @Observable, SwiftUI state property wrapper. |
| Key frameworks/packages | SwiftUI, Foundation, RealityKit, ARKit, Combine; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ObjectTrackingExperiencesSample/
│ ├── ObjectTrackingExperiencesSampleApp.swift
│ ├── Game/
│ │ └── KeyboardGame.swift
│ ├── AppModel.swift
│ ├── Utils/
│ │ ├── FadeOutComponent.swift
│ │ ├── AppLogger.swift
│ │ └── ObjectTrackingGuide.swift
│ └── Views/
│ ├── ContentView.swift
│ ├── ImmersiveView.swift
│ └── ToggleImmersiveSpaceButton.swift
├── Packages/
│ └── RealityKitContent/
│ ├── Sources/
│ │ └── RealityKitContent/
│ │ └── RealityKitContent.swift
│ └── Package.swift
└── 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 5 project/configuration file(s) and 15 source declaration(s).
Overall architecture
flowchart LR
N1["ObjectTrackingExperiencesSampleApp"]
N2["ContentView"]
N3["AppModel"]
N4["FadeOutSystem"]
N5["SwiftUI / RealityKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift:9 — architecture anchor
@main
struct ObjectTrackingExperiencesSampleApp: App {
@State private var appModel = AppModel()
var body: some Scene {
WindowGroup {
ContentView()
.environment(appModel)
}
ImmersiveSpace(id: appModel.immersiveSpaceID) {
ImmersiveView()
.environment(appModel)
.onAppear {
appModel.immersiveSpaceState = .open
}
.onDisappear {
appModel.immersiveSpaceState = .closed
}
}
}
}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
ObjectTrackingExperiencesSampleApp *-- AppModel : appModel
KeyboardGame o-- Challenge : currentChallenge
KeyboardGame o-- Challenge : initialChallenge
Challenge *-- String : description
Ownership evidence
ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift:12 — stored dependency or nearest verified ownership anchor
@main
struct ObjectTrackingExperiencesSampleApp: App {
// ...
@State private var appModel = AppModel()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
ObjectTrackingExperiencesSampleApp |
AppModel (appModel) |
owns wrapper-managed state | Owning lexical scope |
KeyboardGame |
Challenge (currentChallenge) |
stores or receives | App/module collaborators |
KeyboardGame |
Challenge (initialChallenge) |
stores or receives | Owning lexical scope |
Challenge |
String (description) |
owns value state | Initialized by the owner; the binding is immutable |
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. | ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift:20 |
| Suspension boundary | async declaration or closure |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | ObjectTrackingExperiencesSample/Utils/ObjectTrackingGuide.swift:41 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | ObjectTrackingExperiencesSample/Views/ContentView.swift:30 |
| Queue scheduling | DispatchQueue.main.asyncAfter |
The source addresses the main dispatch queue. | ObjectTrackingExperiencesSample/Views/ImmersiveView.swift:191 |
| Main isolation | Task closure isolated to MainActor |
The cited operation explicitly enters a main-actor-isolated region. | ObjectTrackingExperiencesSample/Views/ToggleImmersiveSpaceButton.swift:18 |
@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
ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift:20 — representative execution boundary
@MainActor
class FadeOutSystem: System {
private static let query = EntityQuery(where: .has(FadeOutComponent.self))
// ...
}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 | @Observable |
Observation macro publishes source-visible changes. | ObjectTrackingExperiencesSample/AppModel.swift:9 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift:12 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | ObjectTrackingExperiencesSample/AppModel.swift:7 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | ObjectTrackingExperiencesSample/Game/KeyboardGame.swift:7 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift:9 |
| Source import | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ObjectTrackingExperiencesSample/Utils/ObjectTrackingGuide.swift:8 |
| Source import | Combine |
The cited file imports this module; runtime use and architectural role are not inferred. | ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift:8 |
| Source import | OSLog |
The cited file imports this module; runtime use and architectural role are not inferred. | ObjectTrackingExperiencesSample/Utils/AppLogger.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
ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift:10 — representative type boundary
@main
struct ObjectTrackingExperiencesSampleApp: App {
// ...
@State private var appModel = AppModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
ObjectTrackingExperiencesSampleApp |
Application entry and top-level composition | App |
AppModel |
Feature data or observable state | Concrete collaborators/imported frameworks |
FadeOutComponent |
Stores entity-component data or behavior | Component |
FadeOutSystem |
Runs entity-component-system update logic | System |
ContentView |
User-interface presentation and input forwarding | View |
ImmersiveView |
User-interface presentation and input forwarding | View |
KeyboardGame |
Owns feature behavior and collaborator lifecycle | Concrete collaborators/imported frameworks |
Challenge |
Represents a feature value or composable behavior | Codable |
Outcome |
Represents a feature value or composable behavior | Codable |
PlayerInput |
Defines a closed set of feature states or choices | Codable, 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 |
|---|---|---|---|
initialChallenge (ObjectTrackingExperiencesSample/Game/KeyboardGame.swift:13) |
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. |
appModel (ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift:12) |
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. |
query (ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift:22) |
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. |
updateAnimation (ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift:32) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: hide an implementation step that is not part of the collaboration surface. |
Reference code
ObjectTrackingExperiencesSample/Game/KeyboardGame.swift:13 — representative boundary
class KeyboardGame {
// ...
private var initialChallenge: Challenge!
// ...
}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 | ObjectTrackingExperiencesSampleApp |
The source’s App suffix makes this role explicit. |
| Stores entity-component data or behavior | FadeOutComponent |
The source’s Component suffix makes this role explicit. |
| Feature data or observable state | AppModel |
The source’s Model suffix makes this role explicit. |
| Runs entity-component-system update logic | FadeOutSystem |
The source’s System suffix makes this role explicit. |
| User-interface presentation and input forwarding | ContentView, ImmersiveView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| No named application pattern | ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift:9 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Naming conventions
- Types: App: ObjectTrackingExperiencesSampleApp; Component: FadeOutComponent; Model: AppModel; System: FadeOutSystem; View: ContentView, ImmersiveView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
loadChallenges,startGame,respond,encode,update,updateAnimation,setupEntities,setupAttachments. - Files:
ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift,ObjectTrackingExperiencesSample/Game/KeyboardGame.swift,ObjectTrackingExperiencesSample/AppModel.swift,ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift,ObjectTrackingExperiencesSample/Views/ContentView.swift,ObjectTrackingExperiencesSample/Views/ImmersiveView.swift.
Architecture takeaways
ObjectTrackingExperiencesSampleAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, RealityKit, ARKit, PackageDescription 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 |
|---|---|
ObjectTrackingExperiencesSample/ObjectTrackingExperiencesSampleApp.swift |
Cited implementation, ObjectTrackingExperiencesSampleApp, SwiftUI state property wrapper |
ObjectTrackingExperiencesSample/Game/KeyboardGame.swift |
Cited implementation, Foundation, KeyboardGame, Challenge, Outcome, PlayerInput, CodingKeys, InputFormat |
ObjectTrackingExperiencesSample/Utils/FadeOutComponent.swift |
Cited implementation, @MainActor, RealityKit, Combine, FadeOutComponent, FadeOutSystem |
ObjectTrackingExperiencesSample/Utils/ObjectTrackingGuide.swift |
async declaration or closure, ARKit, ObjectTrackingGuide |
ObjectTrackingExperiencesSample/Views/ContentView.swift |
Task, ContentView |
ObjectTrackingExperiencesSample/Views/ImmersiveView.swift |
DispatchQueue.main.asyncAfter, ImmersiveView |
ObjectTrackingExperiencesSample/Views/ToggleImmersiveSpaceButton.swift |
Task closure isolated to MainActor, ToggleImmersiveSpaceButton |
ObjectTrackingExperiencesSample/AppModel.swift |
@Observable, SwiftUI, AppModel, ImmersiveSpaceState |
ObjectTrackingExperiencesSample/Utils/AppLogger.swift |
OSLog, AppLogger |
Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift |
Feature implementation |
Packages/RealityKitContent/Package.swift |
Feature implementation |