Presenting images in RealityKit
At a glance
| Item | Summary |
|---|---|
| Purpose | Create and display spatial scenes in RealityKit |
| App architecture | A Swift sample with the source-visible chain SpatialPhotosSampleApp → ContentView → AppModel → RealityKit APIs. |
| Main patterns | Delegate or data-source callbacks |
| Project style | 7 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; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: @Observable, SwiftUI state property wrapper. |
| Key frameworks/packages | SwiftUI, RealityKit; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── SpatialPhotosSample/
│ ├── SpatialPhotosSample/
│ │ ├── SpatialPhotosSampleApp.swift
│ │ ├── Delegates/
│ │ │ ├── AppDelegate.swift
│ │ │ └── SceneDelegate.swift
│ │ ├── Model/
│ │ │ └── AppModel.swift
│ │ ├── Views/
│ │ │ ├── ContentView.swift
│ │ │ ├── ImagePresentationView.swift
│ │ │ └── OrnamentsView.swift
│ │ └── Info.plist
│ └── SpatialPhotosSample.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 8 source declaration(s).
Overall architecture
flowchart LR
N1["SpatialPhotosSampleApp"]
N2["ContentView"]
N3["AppModel"]
N4["RealityKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift:10 — architecture anchor
@main
struct SpatialPhotosSampleApp: App {
@State private var appModel = AppModel()
@UIApplicationDelegateAdaptor private var appDelegate: AppDelegate
var body: some Scene {
WindowGroup {
ContentView()
.environment(appModel)
.frame(minWidth: 600, maxWidth: 2000, minHeight: 600, maxHeight: 2000)
}
.windowResizability(.contentSize)
.windowStyle(.plain)
}
}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
SpatialPhotosSampleApp *-- AppModel : appModel
SpatialPhotosSampleApp o-- AppDelegate : appDelegate
AppModel *-- Array : imageNames
AppModel *-- Int : imageIndex
Ownership evidence
SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift:12 — stored dependency or nearest verified ownership anchor
@main
struct SpatialPhotosSampleApp: App {
@State private var appModel = AppModel()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
SpatialPhotosSampleApp |
AppModel (appModel) |
owns wrapper-managed state | Owning lexical scope |
SpatialPhotosSampleApp |
AppDelegate (appDelegate) |
stores or receives | Owning lexical scope |
AppModel |
Array (imageNames) |
owns value state | Initialized by the owner; the binding is immutable |
AppModel |
Int (imageIndex) |
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. | SpatialPhotosSample/SpatialPhotosSample/Model/AppModel.swift:17 |
| Suspension boundary | async declaration or closure |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | SpatialPhotosSample/SpatialPhotosSample/Model/AppModel.swift:49 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | SpatialPhotosSample/SpatialPhotosSample/Views/ImagePresentationView.swift:68 |
@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
SpatialPhotosSample/SpatialPhotosSample/Model/AppModel.swift:17 — representative execution boundary
@MainActor
@Observable
class AppModel {
// ...
var imageURLs: [URL] = []
// ...
}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. | SpatialPhotosSample/SpatialPhotosSample/Delegates/AppDelegate.swift:10 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift:12 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | SpatialPhotosSample/SpatialPhotosSample/Delegates/AppDelegate.swift:8 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | SpatialPhotosSample/SpatialPhotosSample/Model/AppModel.swift:8 |
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
SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift:11 — representative type boundary
@main
struct SpatialPhotosSampleApp: App {
@State private var appModel = AppModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
SpatialPhotosSampleApp |
Application entry and top-level composition | App |
AppDelegate |
Receives callback-driven events | NSObject, UIApplicationDelegate |
AppModel |
Feature data or observable state | Concrete collaborators/imported frameworks |
SceneDelegate |
Receives callback-driven events | NSObject, UIWindowSceneDelegate |
ContentView |
User-interface presentation and input forwarding | View |
ImagePresentationView |
User-interface presentation and input forwarding | View |
OrnamentsView |
User-interface presentation and input forwarding | View |
Spatial3DImageState |
Represents mutable feature state | Concrete collaborators/imported frameworks |
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 |
|---|---|---|---|
appModel (SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.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. |
appDelegate (SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.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 (SpatialPhotosSample/SpatialPhotosSample/Views/ContentView.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. |
appModel (SpatialPhotosSample/SpatialPhotosSample/Views/ImagePresentationView.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. |
Reference code
SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift:12 — representative boundary
@main
struct SpatialPhotosSampleApp: App {
@State private var appModel = AppModel()
// ...
}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 | SpatialPhotosSampleApp |
The source’s App suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate, SceneDelegate |
The source’s Delegate suffix makes this role explicit. |
| Feature data or observable state | AppModel |
The source’s Model suffix makes this role explicit. |
| User-interface presentation and input forwarding | ContentView, ImagePresentationView, OrnamentsView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Delegate or data-source callbacks | SpatialPhotosSample/SpatialPhotosSample/Delegates/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: App: SpatialPhotosSampleApp; Delegate: AppDelegate, SceneDelegate; Model: AppModel; View: ContentView, ImagePresentationView, OrnamentsView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
application,createImagePresentationComponent,generateSpatial3DImage,scene,scaleImagePresentationToFit. - Files:
SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift,SpatialPhotosSample/SpatialPhotosSample/Delegates/AppDelegate.swift,SpatialPhotosSample/SpatialPhotosSample/Model/AppModel.swift,SpatialPhotosSample/SpatialPhotosSample/Delegates/SceneDelegate.swift,SpatialPhotosSample/SpatialPhotosSample/Views/ContentView.swift,SpatialPhotosSample/SpatialPhotosSample/Views/ImagePresentationView.swift.
Architecture takeaways
SpatialPhotosSampleAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, RealityKit 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 |
|---|---|
SpatialPhotosSample/SpatialPhotosSample/SpatialPhotosSampleApp.swift |
Cited implementation, SpatialPhotosSampleApp, SwiftUI state property wrapper |
SpatialPhotosSample/SpatialPhotosSample/Views/ContentView.swift |
Cited implementation, ContentView |
SpatialPhotosSample/SpatialPhotosSample/Views/ImagePresentationView.swift |
Cited implementation, Task, ImagePresentationView |
SpatialPhotosSample/SpatialPhotosSample/Delegates/AppDelegate.swift |
Cited implementation, @Observable, SwiftUI, AppDelegate |
SpatialPhotosSample/SpatialPhotosSample/Model/AppModel.swift |
@MainActor, async declaration or closure, RealityKit, Spatial3DImageState, AppModel |
SpatialPhotosSample/SpatialPhotosSample/Delegates/SceneDelegate.swift |
SceneDelegate |
SpatialPhotosSample/SpatialPhotosSample/Views/OrnamentsView.swift |
OrnamentsView |