Composing interactive 3D content with RealityKit and Reality Composer Pro
At a glance
| Item | Summary |
|---|---|
| Purpose | Build an interactive scene using an animation timeline. |
| App architecture | A Swift sample with the source-visible chain RealityKitAnimationApp → ContentView → AppModel → EntityMoverSystem → RealityKit / RealityKitContent APIs. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 12 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: @MainActor, await suspension point, Task closure isolated to MainActor, Task; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: @Observable, SwiftUI state property wrapper, NotificationCenter. |
| Key frameworks/packages | RealityKit, Foundation, Combine, SwiftUI, Spatial; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
└── RealityKitAnimation/
├── RealityKitAnimation/
│ ├── RealityKitAnimationApp.swift
│ ├── AppModel.swift
│ ├── ContentView.swift
│ ├── ImmersiveView.swift
│ └── ToggleImmersiveSpaceButton.swift
└── Packages/
└── RealityKitContent/
├── Sources/
│ └── RealityKitContent/
│ ├── HeroRobotComponent.swift
│ ├── HeroPlantComponent.swift
│ ├── EntityMoverComponent.swift
│ ├── StationaryRobotComponent.swift
│ ├── HeroRobotComponentExtension.swift
│ └── RealityKitContent.swift
└── Package.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 22 source declaration(s).
Overall architecture
flowchart LR
N1["RealityKitAnimationApp"]
N2["ContentView"]
N3["AppModel"]
N4["EntityMoverSystem"]
N5["RealityKit / RealityKitContent APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
RealityKitAnimation/RealityKitAnimation/RealityKitAnimationApp.swift:10 — architecture anchor
@main
struct RealityKitAnimationApp: App {
@State private var appModel = AppModel()
var body: some Scene {
WindowGroup {
ContentView()
.environment(appModel)
.volumeBaseplateVisibility(.visible)
}
.windowStyle(.volumetric)
ImmersiveSpace(id: "ImmersiveSpace") {
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 RealityKit.
Ownership and state
classDiagram
RealityKitAnimationApp *-- AppModel : appModel
HeroRobotComponent *-- Float : ikTotalBlendTime
HeroRobotRuntimeComponent o-- HeroRobotComponent : settingsSource
HeroRobotRuntimeComponent o-- HeroRobotState : currentState
Ownership evidence
RealityKitAnimation/RealityKitAnimation/RealityKitAnimationApp.swift:13 — stored dependency or nearest verified ownership anchor
@main
struct RealityKitAnimationApp: App {
// ...
@State private var appModel = AppModel()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
RealityKitAnimationApp |
AppModel (appModel) |
owns wrapper-managed state | Owning lexical scope |
HeroRobotComponent |
Float (ikTotalBlendTime) |
owns value state | App/module collaborators |
HeroRobotRuntimeComponent |
HeroRobotComponent (settingsSource) |
stores or receives | App/module collaborators |
HeroRobotRuntimeComponent |
HeroRobotState (currentState) |
stores or receives | 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. | RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:28 |
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | RealityKitAnimation/RealityKitAnimation/ContentView.swift:32 |
| Main isolation | Task closure isolated to MainActor |
The cited operation explicitly enters a main-actor-isolated region. | RealityKitAnimation/RealityKitAnimation/ToggleImmersiveSpaceButton.swift:18 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | RealityKitAnimation/RealityKitAnimation/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
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:28 — representative execution boundary
@MainActor
public struct EntityMoverRuntimeComponent: Component {
// ...
private var settingsSource: EntityMoverComponent? = nil
// ...
}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. | RealityKitAnimation/RealityKitAnimation/AppModel.swift:17 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | RealityKitAnimation/RealityKitAnimation/ContentView.swift:14 |
| State propagation | NotificationCenter |
NotificationCenter distributes named process-local events. | RealityKitAnimation/RealityKitAnimation/ImmersiveView.swift:21 |
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:9 |
| Source import | Combine |
The cited file imports this module; runtime use and architectural role are not inferred. | RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:10 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | RealityKitAnimation/RealityKitAnimation/AppModel.swift:8 |
| Source import | Spatial |
The cited file imports this module; runtime use and architectural role are not inferred. | RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/HeroRobotComponent.swift:11 |
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
RealityKitAnimation/RealityKitAnimation/RealityKitAnimationApp.swift:11 — representative type boundary
@main
struct RealityKitAnimationApp: App {
// ...
@State private var appModel = AppModel()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
RealityKitAnimationApp |
Application entry and top-level composition | App |
HeroRobotComponent |
Stores entity-component data or behavior | Component, Codable |
HeroRobotRuntimeComponent |
Stores entity-component data or behavior | Component |
HeroRobotSystem |
Runs entity-component-system update logic | System |
HeroPlantComponent |
Stores entity-component data or behavior | Component, Codable |
HeroPlantRuntimeComponent |
Stores entity-component data or behavior | Component |
HeroPlantSystem |
Runs entity-component-system update logic | System |
EntityMoverComponent |
Stores entity-component data or behavior | Component, Codable |
EntityMoverRuntimeComponent |
Stores entity-component data or behavior | Component |
EntityMoverSystem |
Runs entity-component-system update logic | System |
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 |
|---|---|---|---|
settingsSource (RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:31) |
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. |
currentExtentX (RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:34) |
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. |
currentExtentY (RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:35) |
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. |
currentExtentZ (RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:36) |
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
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift:31 — representative boundary
@MainActor
public struct EntityMoverRuntimeComponent: Component {
// ...
private var settingsSource: EntityMoverComponent? = nil
// ...
}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 | RealityKitAnimationApp |
The source’s App suffix makes this role explicit. |
| Stores entity-component data or behavior | EntityMoverComponent, EntityMoverRuntimeComponent, HeroPlantComponent, HeroPlantRuntimeComponent |
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 | EntityMoverSystem, HeroPlantSystem, HeroRobotSystem, StationaryRobotSystem |
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 | RealityKitAnimation/RealityKitAnimation/RealityKitAnimationApp.swift:10 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Naming conventions
- Types: App: RealityKitAnimationApp; Component: EntityMoverComponent, EntityMoverRuntimeComponent, HeroPlantComponent, HeroPlantRuntimeComponent, HeroRobotComponent; Model: AppModel; System: EntityMoverSystem, HeroPlantSystem, HeroRobotSystem, StationaryRobotSystem; View: ContentView, ImmersiveView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
isAvailable,setState,enableIK,calculateReachPosition,initialize,initializeIKComponent,initializeRobotTravelHomeAction,findModelComponentEntity. - Files:
RealityKitAnimation/RealityKitAnimation/RealityKitAnimationApp.swift,RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/HeroRobotComponent.swift,RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/HeroPlantComponent.swift,RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift,RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/StationaryRobotComponent.swift,RealityKitAnimation/RealityKitAnimation/AppModel.swift.
Architecture takeaways
RealityKitAnimationAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches RealityKit, SwiftUI, Spatial, RealityKitContent 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 |
|---|---|
RealityKitAnimation/RealityKitAnimation/RealityKitAnimationApp.swift |
Cited implementation, RealityKitAnimationApp |
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/EntityMoverComponent.swift |
Cited implementation, @MainActor, RealityKit, Foundation, Combine, EntityMoverComponent, EntityMoverRuntimeComponent, EntityMoverSystem |
RealityKitAnimation/RealityKitAnimation/ContentView.swift |
await suspension point, SwiftUI state property wrapper, ContentView |
RealityKitAnimation/RealityKitAnimation/ToggleImmersiveSpaceButton.swift |
Task closure isolated to MainActor, Task, ToggleImmersiveSpaceButton |
RealityKitAnimation/RealityKitAnimation/AppModel.swift |
@Observable, SwiftUI, ImmersiveSpaceState, AppModel |
RealityKitAnimation/RealityKitAnimation/ImmersiveView.swift |
NotificationCenter, ImmersiveView |
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/HeroRobotComponent.swift |
Spatial, HeroRobotState, RobotTravelHomeAction, RobotMoveToHomeComplete, HeroRobotComponent, HeroRobotRuntimeComponent, HeroRobotSystem |
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/HeroPlantComponent.swift |
PlantState, HeroPlantComponent, HeroPlantRuntimeComponent, HeroPlantSystem |
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/StationaryRobotComponent.swift |
StationaryRobotComponent, StationaryRobotRuntimeComponent, StationaryRobotSystem |
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/HeroRobotComponentExtension.swift |
Feature implementation |
RealityKitAnimation/Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift |
Feature implementation |
RealityKitAnimation/Packages/RealityKitContent/Package.swift |
Feature implementation |