Integrating virtual objects with your environment
At a glance
| Item | Summary |
|---|---|
| Purpose | Create an immersive game using native anchor support, environmental blending, model manipulation, and mesh instance duplication. |
| App architecture | A Swift sample with the source-visible chain TinyTreasureTroveApp → ContentView → AppModel → GameObjectSystem → RealityKit APIs. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 16 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, 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 | RealityKit, SwiftUI, Foundation, ARKit, PackageDescription; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── TinyTreasureTrove/
│ ├── TinyTreasureTroveApp.swift
│ ├── AppModel.swift
│ ├── Gameplay/
│ │ ├── ThrowableComponent.swift
│ │ ├── GameObjectSystem.swift
│ │ └── GameLogic.swift
│ ├── ECS/
│ │ ├── AnimationCallbackComponent.swift
│ │ ├── ChestComponent.swift
│ │ ├── GameObjectComponent.swift
│ │ └── KeyComponent.swift
│ └── UI/
│ ├── ContentView.swift
│ └── ImmersiveView.swift
└── Packages/
└── RealityKitContent/
└── Sources/
└── RealityKitContent/
└── RealityKitContent.swift
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 17 source declaration(s).
Overall architecture
flowchart LR
N1["TinyTreasureTroveApp"]
N2["ContentView"]
N3["AppModel"]
N4["GameObjectSystem"]
N5["RealityKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
TinyTreasureTrove/TinyTreasureTroveApp.swift:10 — architecture anchor
@main
struct TinyTreasureTroveApp: App {
@State private var appModel = AppModel()
var body: some Scene {
WindowGroup {
ContentView()
.environment(appModel)
}
.windowStyle(.volumetric)
ImmersiveSpace(id: appModel.immersiveSpaceID) {
ImmersiveView()
.environment(appModel)
.onAppear {
appModel.immersiveSpaceState = .open
}
.onDisappear {
appModel.immersiveSpaceState = .closed
}
}
.immersionStyle(selection: .constant(.mixed), in: .mixed)
}
}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 RealityKit.
Ownership and state
classDiagram
TinyTreasureTroveApp *-- AppModel : appModel
PositionTimeStamp *-- SIMD3 : position
PositionTimeStamp o-- CFTimeInterval : timestamp
ThrowableComponent *-- Float : throwThreshold
Ownership evidence
TinyTreasureTrove/TinyTreasureTroveApp.swift:12 — stored dependency or nearest verified ownership anchor
@main
struct TinyTreasureTroveApp: App {
@State private var appModel = AppModel()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
TinyTreasureTroveApp |
AppModel (appModel) |
owns wrapper-managed state | Owning lexical scope |
PositionTimeStamp |
SIMD3 (position) |
owns value state | Initialized by the owner; the binding is immutable |
PositionTimeStamp |
CFTimeInterval (timestamp) |
stores or receives | Initialized by the owner; the binding is immutable |
ThrowableComponent |
Float (throwThreshold) |
owns value state | App/module collaborators |
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. | TinyTreasureTrove/AppModel.swift:10 |
| Suspension boundary | async declaration or closure |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | TinyTreasureTrove/Gameplay/EntityExtensions.swift:12 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | TinyTreasureTrove/Gameplay/GameSetUp.swift:15 |
| Main isolation | Task closure isolated to MainActor |
The cited operation explicitly enters a main-actor-isolated region. | TinyTreasureTrove/ToggleImmersiveSpaceButton.swift:19 |
@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
TinyTreasureTrove/AppModel.swift:10 — representative execution boundary
@MainActor
@Observable
class AppModel {
// ...
case closed
// ...
}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. | TinyTreasureTrove/AppModel.swift:11 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | TinyTreasureTrove/TinyTreasureTroveApp.swift:12 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | TinyTreasureTrove/ECS/AnimationCallbackComponent.swift:8 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | TinyTreasureTrove/AppModel.swift:7 |
| 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 | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | TinyTreasureTrove/Gameplay/GameLogic.swift:10 |
| 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. | TinyTreasureTrove/Gameplay/GameSetUp.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
TinyTreasureTrove/TinyTreasureTroveApp.swift:11 — representative type boundary
@main
struct TinyTreasureTroveApp: App {
@State private var appModel = AppModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
TinyTreasureTroveApp |
Application entry and top-level composition | App |
AppModel |
Feature data or observable state | Concrete collaborators/imported frameworks |
ThrowableComponent |
Stores entity-component data or behavior | Component |
AnimationCallbackComponent |
Stores entity-component data or behavior | Component |
ChestComponent |
Stores entity-component data or behavior | Component |
GameObjectComponent |
Stores entity-component data or behavior | Component |
KeyComponent |
Stores entity-component data or behavior | Component |
GameObjectSystem |
Runs entity-component-system update logic | System |
ContentView |
User-interface presentation and input forwarding | View |
ImmersiveView |
User-interface presentation and input forwarding | 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 |
|---|---|---|---|
realityKitContentBundle (Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift:10) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
tooLow (TinyTreasureTrove/Gameplay/GameObjectSystem.swift:11) |
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. |
gameObjectQuery (TinyTreasureTrove/Gameplay/GameObjectSystem.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. |
update (TinyTreasureTrove/Gameplay/GameObjectSystem.swift:18) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
Reference code
Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift:10 — representative boundary
public let realityKitContentBundle = Bundle.moduleSwift 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 | TinyTreasureTroveApp |
The source’s App suffix makes this role explicit. |
| Stores entity-component data or behavior | AnimationCallbackComponent, ChestComponent, GameObjectComponent, KeyComponent |
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 | GameObjectSystem |
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 | TinyTreasureTrove/TinyTreasureTroveApp.swift:10 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Naming conventions
- Types: App: TinyTreasureTroveApp; Component: AnimationCallbackComponent, ChestComponent, GameObjectComponent, KeyComponent, ThrowableComponent; Model: AppModel; System: GameObjectSystem; View: ContentView, ImmersiveView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
updatePositionHistory,calculateThrowVelocity,shouldThrow,clearHistory,makeThrowable,addCallback,handleEvent,playAnimation. - Files:
TinyTreasureTrove/TinyTreasureTroveApp.swift,TinyTreasureTrove/AppModel.swift,TinyTreasureTrove/Gameplay/ThrowableComponent.swift,TinyTreasureTrove/ECS/AnimationCallbackComponent.swift,TinyTreasureTrove/ECS/ChestComponent.swift,TinyTreasureTrove/ECS/GameObjectComponent.swift.
Architecture takeaways
TinyTreasureTroveAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches RealityKit, SwiftUI, 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 |
|---|---|
TinyTreasureTrove/TinyTreasureTroveApp.swift |
Cited implementation, TinyTreasureTroveApp, SwiftUI state property wrapper |
Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift |
Cited implementation, Foundation, Feature implementation |
TinyTreasureTrove/Gameplay/GameObjectSystem.swift |
Cited implementation, GameObjectSystem |
TinyTreasureTrove/AppModel.swift |
@MainActor, @Observable, SwiftUI, AppModel, ImmersiveSpaceState, GameSetUpState |
TinyTreasureTrove/Gameplay/EntityExtensions.swift |
async declaration or closure, Feature implementation |
TinyTreasureTrove/Gameplay/GameSetUp.swift |
Task, RealityKitContent, GameEntities |
TinyTreasureTrove/ToggleImmersiveSpaceButton.swift |
Task closure isolated to MainActor, ToggleImmersiveSpaceButton |
TinyTreasureTrove/ECS/AnimationCallbackComponent.swift |
RealityKit, AnimationCallbackComponent |
TinyTreasureTrove/Gameplay/GameLogic.swift |
ARKit, NoModelComponentError, GameContext |
Packages/RealityKitContent/Package.swift |
PackageDescription, Feature implementation |
TinyTreasureTrove/Gameplay/ThrowableComponent.swift |
PositionTimeStamp, ThrowableComponent |
TinyTreasureTrove/ECS/ChestComponent.swift |
ChestComponent |
TinyTreasureTrove/ECS/GameObjectComponent.swift |
GameObjectComponent |
TinyTreasureTrove/ECS/KeyComponent.swift |
KeyComponent |
TinyTreasureTrove/UI/ContentView.swift |
ContentView |
TinyTreasureTrove/UI/ImmersiveView.swift |
ImmersiveView |