Hello World
At a glance
| Item | Summary |
|---|---|
| Purpose | Use windows, volumes, and immersive spaces to teach people about the Earth. |
| App architecture | A Swift sample with the source-visible chain WorldApp → ItemView → ViewModel → RotationSystem → SwiftUI / RealityKit APIs. |
| Main patterns | Model-View-ViewModel, Binding-based state propagation |
| Project style | 43 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: async declaration or closure, @MainActor, Task; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: SwiftUI state property wrapper, @Observable. |
| Key frameworks/packages | SwiftUI, RealityKit, WorldAssets, Foundation, PackageDescription; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── World/
│ ├── WorldApp.swift
│ ├── Model/
│ │ └── ViewModel.swift
│ ├── Systems/
│ │ ├── TraceSystem.swift
│ │ └── RotationSystem.swift
│ ├── Globe/
│ │ └── GlobeControls.swift
│ ├── Solar System/
│ │ └── SolarSystem.swift
│ ├── Modules/
│ │ └── TableOfContents.swift
│ ├── Orbit/
│ │ └── OrbitModule.swift
│ ├── Entities/
│ │ └── EarthEntity+Configuration.swift
│ └── RealityViews/
│ └── OpenWindow.swift
└── Packages/
└── WorldAssets/
└── Sources/
└── WorldAssets/
├── SunPositionSystem.swift
└── WorldAssets.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 53 source declaration(s).
Overall architecture
flowchart LR
N1["WorldApp"]
N2["ItemView"]
N3["ViewModel"]
N4["RotationSystem"]
N5["SwiftUI / RealityKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
World/WorldApp.swift:12 — architecture anchor
@main
struct WorldApp: App {
// ...
@State private var model = ViewModel()
// ...
}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
ViewModel *-- Array : navigationPath
ViewModel *-- String : titleText
ViewModel *-- Bool : isTitleFinished
ViewModel *-- String : finalTitle
Ownership evidence
World/Model/ViewModel.swift:20 — stored dependency or nearest verified ownership anchor
@Observable
class ViewModel {
// ...
var navigationPath: [Module] = []
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
ViewModel |
Array (navigationPath) |
owns value state | App/module collaborators |
ViewModel |
String (titleText) |
owns value state | App/module collaborators |
ViewModel |
Bool (isTitleFinished) |
owns value state | App/module collaborators |
ViewModel |
String (finalTitle) |
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 |
|---|---|---|---|
| Suspension boundary | async declaration or closure |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | Packages/WorldAssets/Sources/WorldAssets/WorldAssets.swift:48 |
| Main isolation | @MainActor |
The cited annotation marks its attached declaration or closure as main-actor isolated. | World/Entities/EarthEntity.swift:40 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | World/Entities/Entity+Sunlight.swift:29 |
@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
Packages/WorldAssets/Sources/WorldAssets/WorldAssets.swift:48 — representative execution boundary
public func entity(named name: String) async -> Entity? {
// ...
return try await Entity(named: name, in: worldAssetsBundle)
// ...
}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. | World/Globe/Globe.swift:13 |
| State propagation | @Observable |
Observation macro publishes source-visible changes. | World/Model/ViewModel.swift:11 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:10 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:9 |
| Source import | WorldAssets |
The cited file imports this module; runtime use and architectural role are not inferred. | World/Entities/EarthEntity.swift:10 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:8 |
| Source import | PackageDescription |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/WorldAssets/Package.swift:9 |
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
World/WorldApp.swift:13 — representative type boundary
@main
struct WorldApp: App {
// ...
@State private var model = ViewModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
WorldApp |
Application entry and top-level composition | App |
ViewModel |
UI-facing state and feature coordination | Concrete collaborators/imported frameworks |
SunPositionComponent |
Stores entity-component data or behavior | Component, Codable |
SunPositionSystem |
Runs entity-component-system update logic | System |
TraceComponent |
Stores entity-component data or behavior | Component |
TraceSystem |
Runs entity-component-system update logic | System |
RotationComponent |
Stores entity-component data or behavior | Component |
RotationSystem |
Runs entity-component-system update logic | System |
SolarSystem |
Runs entity-component-system update logic | View |
ItemView |
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 |
|---|---|---|---|
SunPositionSystem (Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:15) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
SunPositionSystem (Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:23) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
update (Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:25) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
worldAssetsBundle (Packages/WorldAssets/Sources/WorldAssets/WorldAssets.swift:12) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
Reference code
Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift:15 — representative boundary
public init(_ sunAngle: Float) {
sunAngleRadians = sunAngle
}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 | WorldApp |
The source’s App suffix makes this role explicit. |
| Stores entity-component data or behavior | RotationComponent, SunPositionComponent, TraceComponent |
The source’s Component suffix makes this role explicit. |
| Runs entity-component-system update logic | RotationSystem, SolarSystem, SunPositionSystem, TraceSystem |
The source’s System suffix makes this role explicit. |
| User-interface presentation and input forwarding | ItemView |
The source’s View suffix makes this role explicit. |
| UI-facing state and feature coordination | ViewModel |
The source’s ViewModel suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Model-View-ViewModel | World/Model/ViewModel.swift:12 |
Role-named view models keep UI-facing state or coordination outside view declarations. |
| Binding-based state propagation | World/Globe/GlobeControls.swift:73 |
A binding exposes controlled read/write access while the upstream owner remains authoritative. |
Main application flow
sequenceDiagram
participant EarthEntity
participant WorldAssets
participant satellites
participant SatelliteEntity
EarthEntity->>WorldAssets: entity()
EarthEntity->>WorldAssets: entity()
EarthEntity->>satellites: addChild()
EarthEntity->>SatelliteEntity: SatelliteEntity()
Reference code
World/Entities/EarthEntity.swift:70 — init()
init(
configuration: Configuration,
satelliteConfiguration: [SatelliteEntity.Configuration],
moonConfiguration: SatelliteEntity.Configuration?
) async {
// ...
super.init()
guard let earth = await WorldAssets.entity(named: configuration.isCloudy ? "Earth" : "Globe"),
let pole = await WorldAssets.entity(named: "Pole") else { return }
self.earth = earth
self.pole = pole
for configuration in satelliteConfiguration {
await satellites.addChild(SatelliteEntity(configuration))
}
self.addChild(equatorialPlane)
equatorialPlane.addChild(earth)
earth.addChild(pole)
moon = await SatelliteEntity(.orbitMoonDefault)
self.addChild(moon)
equatorialPlane.addChild(satellites)
update(
configuration: configuration,
satelliteConfiguration: satelliteConfiguration,
moonConfiguration: moonConfiguration,
animateUpdates: false)
}Naming conventions
- Types: App: WorldApp; Component: RotationComponent, SunPositionComponent, TraceComponent; System: RotationSystem, SolarSystem, SunPositionSystem, TraceSystem; View: ItemView; ViewModel: ViewModel.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
update,getModelDescendents,setSunPosition,addPosition,generateIndices,makeTraceModel,defaultValue. - Files:
World/WorldApp.swift,World/Model/ViewModel.swift,Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift,World/Systems/TraceSystem.swift,World/Systems/RotationSystem.swift,World/Globe/GlobeControls.swift.
Architecture takeaways
WorldAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, RealityKit, WorldAssets, 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 |
|---|---|
World/WorldApp.swift |
Cited implementation, WorldApp |
World/Model/ViewModel.swift |
Cited implementation, ViewModel, @Observable, WindowState |
Packages/WorldAssets/Sources/WorldAssets/SunPositionSystem.swift |
Cited implementation, SwiftUI, RealityKit, Foundation, SunPositionComponent, SunPositionSystem |
Packages/WorldAssets/Sources/WorldAssets/WorldAssets.swift |
Cited implementation, async declaration or closure, Feature implementation |
World/Globe/GlobeControls.swift |
Cited implementation, GlobeControls, GlobeTiltPicker, TiltButtonAlignment, GlobeTilt |
World/Entities/EarthEntity.swift |
@MainActor, WorldAssets, EarthEntity |
World/Entities/Entity+Sunlight.swift |
Task, Feature implementation |
World/Globe/Globe.swift |
SwiftUI state property wrapper, Globe |
Packages/WorldAssets/Package.swift |
PackageDescription, Feature implementation |
World/Systems/TraceSystem.swift |
TraceComponent, TraceSystem, TraceMesh |
World/Systems/RotationSystem.swift |
RotationComponent, RotationSystem |
World/Solar System/SolarSystem.swift |
SolarSystem |
World/Modules/TableOfContents.swift |
TableOfContents, TitleText, EarthAlignment |
World/Orbit/OrbitModule.swift |
Item, OrbitModule, ItemView |
World/Entities/EarthEntity+Configuration.swift |
Configuration, AccessibilityActions |
World/RealityViews/OpenWindow.swift |
OpenWindow, OpenWindowButton |