Placing entities using head and device transform
At a glance
| Item | Summary |
|---|---|
| Purpose | Query and react to changes in the position and rotation of Apple Vision Pro. |
| App architecture | A Swift sample with the source-visible chain HeadTrackingApp → ImmersiveView → AppModel → FollowSystem → SwiftUI / ARKit APIs. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 8 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: @Observable, SwiftUI state property wrapper. |
| Key frameworks/packages | SwiftUI, ARKit, RealityKit, Foundation, PackageDescription; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── HeadTracking/
│ ├── HeadTrackingApp.swift
│ ├── AppModel.swift
│ ├── FollowSystemAndComponent/
│ │ ├── FollowComponent.swift
│ │ └── FollowSystem.swift
│ ├── ImmersiveView.swift
│ ├── TogglePanel.swift
│ └── Info.plist
├── Packages/
│ └── RealityKitContent/
│ ├── Sources/
│ │ └── RealityKitContent/
│ │ └── RealityKitContent.swift
│ └── Package.swift
├── Configuration/
│ └── SampleCode.xcconfig
└── HeadTracking.xcodeproj/
├── .xcodesamplecode.plist
└── project.pbxproj
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 7 source declaration(s).
Overall architecture
flowchart LR
N1["HeadTrackingApp"]
N2["ImmersiveView"]
N3["AppModel"]
N4["FollowSystem"]
N5["SwiftUI / ARKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
HeadTracking/HeadTrackingApp.swift:10 — architecture anchor
@main
struct HeadTrackingApp: App {
@State private var appModel: AppModel = AppModel()
@Environment(\.openImmersiveSpace) var openImmersiveSpace
// Register the system and the component.
init() {
FollowSystem.registerSystem()
FollowComponent.registerComponent()
}
var body: some Scene {
WindowGroup {
TogglePanel()
.environment(appModel)
}
.defaultSize(CGSize(width: 400, height: 200))
ImmersiveSpace(id: "immersiveSpace") {
ImmersiveView()
.environment(appModel)
}
}
}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
HeadTrackingApp *-- AppModel : appModel
AppModel o-- HeadTrackState : headTrackState
AppModel *-- Bool : isImmersiveSpaceOpen
FollowSystem *-- EntityQuery : query
Ownership evidence
HeadTracking/HeadTrackingApp.swift:12 — stored dependency or nearest verified ownership anchor
@main
struct HeadTrackingApp: App {
@State private var appModel: AppModel = AppModel()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
HeadTrackingApp |
AppModel (appModel) |
owns wrapper-managed state | Owning lexical scope |
AppModel |
HeadTrackState (headTrackState) |
stores or receives | App/module collaborators |
AppModel |
Bool (isImmersiveSpaceOpen) |
owns value state | App/module collaborators |
FollowSystem |
EntityQuery (query) |
creates and retains | 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. | HeadTracking/AppModel.swift:13 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | HeadTracking/FollowSystemAndComponent/FollowSystem.swift:23 |
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | HeadTracking/FollowSystemAndComponent/FollowSystem.swift:25 |
@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
HeadTracking/AppModel.swift:13 — representative execution boundary
@MainActor
@Observable
class AppModel {
// ...
var headTrackState: HeadTrackState = .headPosition
// ...
}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. | HeadTracking/AppModel.swift:14 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | HeadTracking/HeadTrackingApp.swift:12 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | HeadTracking/AppModel.swift:8 |
| Source import | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | HeadTracking/AppModel.swift:10 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | HeadTracking/AppModel.swift:9 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift:7 |
| Source import | PackageDescription |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/RealityKitContent/Package.swift:10 |
| Source import | RealityKitContent |
The cited file imports this module; runtime use and architectural role are not inferred. | HeadTracking/ImmersiveView.swift:10 |
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
HeadTracking/HeadTrackingApp.swift:11 — representative type boundary
@main
struct HeadTrackingApp: App {
@State private var appModel: AppModel = AppModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
HeadTrackingApp |
Application entry and top-level composition | App |
AppModel |
Feature data or observable state | Concrete collaborators/imported frameworks |
FollowComponent |
Stores entity-component data or behavior | Component, Codable |
FollowSystem |
Runs entity-component-system update logic | System |
ImmersiveView |
User-interface presentation and input forwarding | View |
HeadTrackState |
Represents mutable feature state | String, CaseIterable |
TogglePanel |
Represents a feature value or composable behavior | View |
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 |
|---|---|---|---|
arkitSession (HeadTracking/FollowSystemAndComponent/FollowSystem.swift:15) |
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. |
worldTrackingProvider (HeadTracking/FollowSystemAndComponent/FollowSystem.swift:16) |
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. |
FollowSystem (HeadTracking/FollowSystemAndComponent/FollowSystem.swift:18) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
update (HeadTracking/FollowSystemAndComponent/FollowSystem.swift:32) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
Reference code
HeadTracking/FollowSystemAndComponent/FollowSystem.swift:15 — representative boundary
public struct FollowSystem: System {
// ...
private let arkitSession = ARKitSession()
// ...
}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 | HeadTrackingApp |
The source’s App suffix makes this role explicit. |
| Stores entity-component data or behavior | FollowComponent |
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 | FollowSystem |
The source’s System suffix makes this role explicit. |
| User-interface presentation and input forwarding | ImmersiveView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| No named application pattern | HeadTracking/HeadTrackingApp.swift:10 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Naming conventions
- Types: App: HeadTrackingApp; Component: FollowComponent; Model: AppModel; System: FollowSystem; View: ImmersiveView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
runSession,update,startFollowMode,startHeadPositionMode,toggleHeadPositionModeOrFollowMode,playHummingbirdAnimation. - Files:
HeadTracking/HeadTrackingApp.swift,HeadTracking/AppModel.swift,HeadTracking/FollowSystemAndComponent/FollowComponent.swift,HeadTracking/FollowSystemAndComponent/FollowSystem.swift,HeadTracking/ImmersiveView.swift,HeadTracking/TogglePanel.swift.
Architecture takeaways
HeadTrackingAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, ARKit, RealityKit, 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 |
|---|---|
HeadTracking/HeadTrackingApp.swift |
Cited implementation, HeadTrackingApp, SwiftUI state property wrapper |
HeadTracking/FollowSystemAndComponent/FollowSystem.swift |
Cited implementation, Task, await suspension point, FollowSystem |
HeadTracking/AppModel.swift |
@MainActor, @Observable, SwiftUI, ARKit, RealityKit, AppModel, HeadTrackState |
Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift |
Foundation, Feature implementation |
Packages/RealityKitContent/Package.swift |
PackageDescription, Feature implementation |
HeadTracking/ImmersiveView.swift |
RealityKitContent, ImmersiveView |
HeadTracking/FollowSystemAndComponent/FollowComponent.swift |
FollowComponent |
HeadTracking/TogglePanel.swift |
TogglePanel |