Working with generic spatial accessories

At a glance

Project structure

Source bundle/
└── WorkingWithGenericSpatialAccessories/
    └── WorkingWithGenericSpatialAccessories/
        ├── Models/
        │   ├── AccessoryModel.swift  # AccessoryModel
        │   ├── AccessoryModel+Haptics.swift
        │   ├── AppModel.swift  # AppModel, ImmersiveSpaceState
        │   └── HapticModel.swift  # HapticModel, Constants
        ├── WorkingWithGenericSpatialAccessoriesApp.swift  # WorkingWithGenericSpatialAccessoriesApp
        └── Views/
            ├── ContentView.swift  # ContentView, AccessorySettingsForm
            ├── ImmersiveView.swift  # ImmersiveView
            └── VolumeView.swift  # VolumeView

Structure observations

• The runtime boundary is Window + WindowGroup + volumetric window + ImmersiveSpace; the pruned tree lists only files that explain lifecycle, state, or framework integration.
• App code is split into role-named views, models, managers, providers, components, or systems.

Overall architecture

flowchart LR
    WorkingWithGenericSpatialAccessoriesApp_1["WorkingWithGenericSpatialAccessoriesApp"]
    Window___WindowGroup___volumetric_window___ImmersiveSpace_2["Window + WindowGroup + volumetric window + ImmersiveSpace"]
    ContentView_3["ContentView"]
    AppModel_4["AppModel"]
    RealityView_entity_graph_5["RealityView entity graph"]
    ARKit_providers___RealityKit_6["ARKit providers + RealityKit"]
    WorkingWithGenericSpatialAccessoriesApp_1 --> Window___WindowGroup___volumetric_window___ImmersiveSpace_2
    Window___WindowGroup___volumetric_window___ImmersiveSpace_2 --> ContentView_3
    ContentView_3 --> AppModel_4
    AppModel_4 --> RealityView_entity_graph_5
    RealityView_entity_graph_5 --> ARKit_providers___RealityKit_6

Reference code

WorkingWithGenericSpatialAccessories/WorkingWithGenericSpatialAccessories/WorkingWithGenericSpatialAccessoriesApp.swift:11 — the app or executable entry declares the outer scene lifecycle.

struct WorkingWithGenericSpatialAccessoriesApp: App {
    // ...
}

The diagram is a responsibility flow, not a claim that every adjacent node directly calls the next. It keeps scene ownership, shared state, RealityKit content, and framework-provider work at separate levels.

Ownership and state

classDiagram
    WorkingWithGenericSpatialAccessoriesApp *-- AppModel : appModel
    ContentView o-- AppModel : appModel
    AccessoryModel *-- ARKitSession : arkitSession
    ImmersiveSpaceState *-- AccessoryModel : accessoryModel

Ownership evidence

WorkingWithGenericSpatialAccessories/WorkingWithGenericSpatialAccessories/WorkingWithGenericSpatialAccessoriesApp.swift:12 — representative stored state or the nearest verified lifecycle anchor.

    @State private var appModel = AppModel()

Ownership here is deliberately narrow: @Environment and weak references are shared links, initialized @State or stored services are lifecycle ownership, and a RealityView content closure owns additions to its entity graph without making the SwiftUI view a reference-type owner.

Class and protocol design

The source defines no local substitution protocol in the reviewed boundary. Its protocol use is framework-facing (App, View, RealityKit/ARKit protocols, or platform adapters), so this document does not label the whole app protocol-oriented.

Access control

No reviewed declaration uses fileprivate, public, open; unmodified Swift declarations are internal.

Reference code

WorkingWithGenericSpatialAccessories/WorkingWithGenericSpatialAccessories/Models/AccessoryModel.swift:35 — representative visibility boundary.

    private(set) var accessoryTrackingProviderState: DataProviderState?
    private(set) var authorizationStatus: ARKitSession.AuthorizationStatus = .notDetermined {
        // ...
    }

Logic ownership and placement

Design patterns

Naming conventions

• Role suffixes are evidence, not decoration: App: WorkingWithGenericSpatialAccessoriesApp; Model: AccessoryModel, AppModel, HapticModel; View: ContentView, ImmersiveView, VolumeView.
• Protocols: no app-defined protocol in the reviewed source.
• Commands use verb-led methods: makeAnchoringSource, toggleAccessoryLocation, initiateDigitalReplicaPlacement, queryLatestAccessoryAnchor, observeAccessoryTrackingProvider, observeAccessoryConnections, observeAccessoryConnectNotifications, observeAccessoryDisconnectNotifications.
• Files generally match their primary type; Views, Models, Managers, Providers, Components, Systems, and Packages folders describe architectural roles where present.

Architecture takeaways

• Treat WorkingWithGenericSpatialAccessoriesApp as the owner of scene declarations, not as the owner of every RealityKit entity created later.
• Keep view-local interaction in SwiftUI, but move provider sessions, playback resources, shared game state, or transport state into a stable owner when their lifetime exceeds one render pass.
• Run ARKit providers for the scene lifetime and consume their asynchronous updates in cancellable tasks; map anchors to entities at the boundary.
• Model immersive-space open, transition, and close states explicitly so windows and immersive content cannot drift apart.

Source map

• Official Apple documentation