Transforming RealityKit entities using gestures
At a glance
| Item | Summary |
|---|---|
| Purpose | Build a RealityKit component to support standard visionOS gestures on any entity. |
| App architecture | A Swift sample with the source-visible chain EntityGestureApp → ContentView → RealityKit / RealityKitContent APIs. |
| Main patterns | No named application pattern supported by the extracted structure |
| Project style | 8 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: await suspension point, @MainActor; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | RealityKit, SwiftUI, Foundation, RealityKitContent, PackageDescription; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── EntityGestures/
│ ├── EntityGestureApp.swift
│ ├── ContentView.swift
│ └── Info.plist
├── Packages/
│ └── RealityKitContent/
│ ├── Sources/
│ │ └── RealityKitContent/
│ │ ├── Components/
│ │ │ └── GestureComponent.swift
│ │ ├── Extensions/
│ │ │ ├── EntityExtensions.swift
│ │ │ ├── GestureExtensions.swift
│ │ │ └── RealityViewExtensions.swift
│ │ └── RealityKitContent.swift
│ └── Package.swift
├── Configuration/
│ └── SampleCode.xcconfig
└── EntityGestures.xcodeproj/
├── .xcodesamplecode.plist
└── project.pbxproj
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 5 project/configuration file(s) and 4 source declaration(s).
Overall architecture
flowchart LR
N1["EntityGestureApp"]
N2["ContentView"]
N3["RealityKit / RealityKitContent APIs"]
N1 --> N2
N2 --> N3
Reference code
EntityGestures/EntityGestureApp.swift:11 — architecture anchor
@main
struct EntityGestureApp: App {
init() {
RealityKitContent.GestureComponent.registerComponent()
}
var body: some Scene {
WindowGroup {
ContentView()
}
.windowStyle(.volumetric)
.defaultSize(width: 2, height: 1.75, depth: 1, in: .meters)
}
}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
EntityGestureState o-- Entity : targetedEntity
EntityGestureState *-- SIMD3 : dragStartPosition
EntityGestureState o-- Entity : pivotEntity
EntityGestureState o-- simd_quatf : initialOrientation
Ownership evidence
Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift:14 — stored dependency or nearest verified ownership anchor
public class EntityGestureState {
// ...
var targetedEntity: Entity?
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
EntityGestureState |
Entity (targetedEntity) |
stores or receives | App/module collaborators |
EntityGestureState |
SIMD3 (dragStartPosition) |
owns value state | App/module collaborators |
EntityGestureState |
Entity (pivotEntity) |
stores or receives | App/module collaborators |
EntityGestureState |
simd_quatf (initialOrientation) |
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 |
|---|---|---|---|
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | EntityGestures/ContentView.swift:52 |
| Main isolation | @MainActor |
The cited annotation marks its attached declaration or closure as main-actor isolated. | Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift:48 |
@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
EntityGestures/ContentView.swift:52 — representative execution boundary
if let scene = try? await Entity(named: "Scene", in: realityKitContentBundle) {
content.add(scene)
}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 |
|---|---|---|---|
| Source import | RealityKit |
The cited file imports this module; runtime use and architectural role are not inferred. | EntityGestures/ContentView.swift:9 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | EntityGestures/ContentView.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/RealityKitContent/Sources/RealityKitContent/Extensions/EntityExtensions.swift:8 |
| Source import | RealityKitContent |
The cited file imports this module; runtime use and architectural role are not inferred. | EntityGestures/ContentView.swift:10 |
| Source import | PackageDescription |
The cited file imports this module; runtime use and architectural role are not inferred. | Packages/RealityKitContent/Package.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
EntityGestures/EntityGestureApp.swift:12 — representative type boundary
@main
struct EntityGestureApp: App {
// ...
RealityKitContent.GestureComponent.registerComponent()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
EntityGestureApp |
Application entry and top-level composition | App |
GestureComponent |
Stores entity-component data or behavior | Component, Codable |
ContentView |
User-interface presentation and input forwarding | View |
EntityGestureState |
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 |
|---|---|---|---|
canDrag (Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift:58) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
pivotOnDrag (Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift:61) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
preserveOrientationOnPivotDrag (Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift:67) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
canScale (Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift:70) |
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/Components/GestureComponent.swift:58 — representative boundary
@MainActor
public struct GestureComponent: Component, Codable {
// ...
public var canDrag: Bool = true
// ...
}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 | EntityGestureApp |
The source’s App suffix makes this role explicit. |
| Stores entity-component data or behavior | GestureComponent |
The source’s Component suffix makes this role explicit. |
| User-interface presentation and input forwarding | ContentView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| No named application pattern | EntityGestures/EntityGestureApp.swift:11 |
The verified source directly composes concrete framework types; this document avoids forcing a pattern name. |
Naming conventions
- Types: App: EntityGestureApp; Component: GestureComponent; View: ContentView.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
onChanged,handlePivotDrag,handleFixedDrag,onEnded,useGestureComponent,installGestures. - Files:
EntityGestures/EntityGestureApp.swift,Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift,EntityGestures/ContentView.swift.
Architecture takeaways
EntityGestureAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches RealityKit, SwiftUI, RealityKitContent, 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 |
|---|---|
EntityGestures/EntityGestureApp.swift |
Cited implementation, EntityGestureApp |
Packages/RealityKitContent/Sources/RealityKitContent/Components/GestureComponent.swift |
Cited implementation, @MainActor, EntityGestureState, GestureComponent |
EntityGestures/ContentView.swift |
await suspension point, RealityKit, SwiftUI, RealityKitContent, ContentView |
Packages/RealityKitContent/Sources/RealityKitContent/Extensions/EntityExtensions.swift |
Foundation, Feature implementation |
Packages/RealityKitContent/Package.swift |
PackageDescription, Feature implementation |
Packages/RealityKitContent/Sources/RealityKitContent/Extensions/GestureExtensions.swift |
Feature implementation |
Packages/RealityKitContent/Sources/RealityKitContent/Extensions/RealityViewExtensions.swift |
Feature implementation |
Packages/RealityKitContent/Sources/RealityKitContent/RealityKitContent.swift |
Feature implementation |