Merge pull request #11 from maxxfrazer/touch-updates

Release 1.3.0

- Update RUIStepper and RUISwitch to have better touch controls.
- Added hasCollided to arTouchEnded method call.
- Added tests for the above.
- Modified the default opacity background of RUIStepper
- Update indentation
- Add DocC Articles for setup + started RUIControls.

All updated methods have deprecated tags with auto-update options on the old ones.

Fixes:
- Fix padding value on RUIButton
- Fix collision shape for RUISwitch

Author: maxxfrazer

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.2
+// swift-tools-version:5.6
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

README.md

@@ -6,12 +6,16 @@ The classes included in RealityUI aim to offer familiar User Interface guideline
 The User Interface controls in this repository so far are made to be familiar to what people are used to with 2D interfaces, however the plan is to expand the tools on offer to new and unique controls, which are more appropriate for an Augmented Reality and Virtual Reality context.
 
 <p align="center">
-  <img src="https://img.shields.io/github/v/release/maxxfrazer/RealityUI?color=orange&label=SwiftPM&logo=swift"/>
-  <img src="https://img.shields.io/badge/platform-iOS%20%7C%20macOS-lightgrey"/>
-  <img src="https://img.shields.io/badge/Swift-5.2-orange?logo=swift"/>
-  <!-- <a href="https://codecov.io/gh/maxxfrazer/RealityUI" > 
-    <img src="https://codecov.io/gh/maxxfrazer/RealityUI/branch/main/graph/badge.svg?token=3PCDBMSCLL"/> 
-  </a> -->
+  <a href="https://swiftpackageindex.com/maxxfrazer/RealityUI">
+    <img src="https://img.shields.io/github/v/release/maxxfrazer/RealityUI?color=F05138&label=Package%20Version&logo=Swift"/>
+  </a>
+  <a href="https://swiftpackageindex.com/maxxfrazer/RealityUI">
+    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fmaxxfrazer%2FRealityUI%2Fbadge%3Ftype%3Dplatforms"/>
+  </a>
+  <a href="https://swiftpackageindex.com/maxxfrazer/RealityUI">
+    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fmaxxfrazer%2FRealityUI%2Fbadge%3Ftype%3Dswift-versions"/>
+  </a>
+  <br/>
   <img src="https://img.shields.io/github/license/maxxfrazer/RealityUI"/>
   <img src="https://github.com/maxxfrazer/RealityUI/workflows/build/badge.svg?branch=main"/>
   <img src="https://github.com/maxxfrazer/RealityUI/workflows/Deploy%20DocC/badge.svg?branch=main"/>
@@ -22,8 +26,8 @@ The User Interface controls in this repository so far are made to be familiar to
 ## Requirements
 
 - iOS 13 or macOS 10.15
-- Swift 5.2
-- Xcode 11
+- Swift 5.4
+- Xcode 12
 
 ## Content
 
@@ -56,8 +60,10 @@ All components used in RealityUI must be registered before they are used, simply
 
 #### Activating Gestures
 
-If you plan on using RUISwitch or RUIStepper, then you should at least enable `.tap`
-RUISlider uses `.pan`, but I would just recommend using `.all` to avoid issues, as these will inevitably move around ad RealityUI develops, and will not interfere with the rest of your RealityKit scene.
+Enabling RealityUI gestures can be doen by calling `RealityUI.enableGestures(.all, on: ARView)`, with `ARView` being your instance of an [ARView](https://developer.apple.com/documentation/realitykit/arview) object.
+
+RUISlider, RUISwitch, RUIStepper and RUIButton all use `.longTouch`, and if you are adding elements that use the protocol `HasClick` you can use the gesture `.tap`.
+I would just recommend using `.all` when enabling gestures, as these will inevitably move around as RealityUI develops.
 
 `RealityUI.enableGestures(.all, on: arView)`
 

RealityUI+Examples/RealityUI+Examples/ViewController.swift

@@ -15,30 +15,42 @@ import RealityUI
 class ViewController: UIViewController {
 
   var arView = ARView(frame: .zero, cameraMode: .ar, automaticallyConfigureSession: false)
-
+  var arMode = true
   func addARView() {
+
     arView.frame = self.view.bounds
     self.arView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
     self.view.addSubview(arView)
+    RealityUI.enableGestures(.all, on: self.arView)
     self.arView.renderOptions.insert(.disableGroundingShadows)
 
-    let config = ARWorldTrackingConfiguration()
-    config.planeDetection = [.horizontal]
-    arView.session.run(config, options: [])
+      if self.arMode {
+          let config = ARWorldTrackingConfiguration()
+          config.planeDetection = [.horizontal]
+          arView.session.run(config, options: [])
+          self.addObjectToPlane()
+      } else {
+          arView.cameraMode = .nonAR
+          arView.environment.background = .color(.orange)
+          self.addNonARParts()
+      }
     // Replaces camera feed, if 6dof VR look is wanted
 //    arView.environment.background = .color(.systemGray)
 
     // Register all the components used in RealityUI
     RealityUI.registerComponents()
   }
 
+    func addNonARParts() {
+        let stepper = RUIStepper()
+        let anchor = AnchorEntity(world: .zero)
+        self.arView.scene.addAnchor(anchor)
+        anchor.addChild(stepper)
+    }
+
   override func viewDidLoad() {
     super.viewDidLoad()
-
-    self.addARView()
-
     // Add all RealityUI gestures to the current ARView
-    RealityUI.enableGestures(.all, on: self.arView)
-    self.addObjectToPlane()
+    self.addARView()
   }
 }

Sources/RealityUI/HasClick.swift

@@ -10,11 +10,11 @@ import RealityKit
 
 /// An interface used for entities which have actions upon being clicked
 public protocol HasClick: HasRUI, HasCollision {
-  /// Action to be applied on successfully tapping an Entity.
-  var tapAction: ((HasClick, SIMD3<Float>?) -> Void)? {get set}
+    /// Action to be applied on successfully tapping an Entity.
+    var tapAction: ((HasClick, SIMD3<Float>?) -> Void)? {get set}
 }
 internal extension HasClick {
-  func onTap(worldCollision: SIMD3<Float>? = nil) {
-    self.tapAction?(self, worldCollision)
-  }
+    func onTap(worldCollision: SIMD3<Float>? = nil) {
+        self.tapAction?(self, worldCollision)
+    }
 }

Sources/RealityUI/HasRUI.swift

@@ -11,112 +11,117 @@ import CoreGraphics
 
 /// A collection of properties for all RealityUI Entities.
 public struct RUIComponent: Component {
-  /// A Boolean value indicating whether the RealityUI Entity is enabled.
-  public internal(set) var ruiEnabled: Bool
-  /// A Boolean value indicating whether the RealityUI Entity materials respond to light.
-  internal var respondsToLighting: Bool
+    /// A Boolean value indicating whether the RealityUI Entity is enabled.
+    public internal(set) var ruiEnabled: Bool
+    /// A Boolean value indicating whether the RealityUI Entity materials respond to light.
+    internal var respondsToLighting: Bool
 
-  /// Create a new `RUIComponent` for a RealityUI Entity
-  /// - Parameters:
-  ///   - isEnabled: A Boolean value indicating whether the RealityUI Entity is enabled.
-  ///   - respondsToLighting: A Boolean value indicating whether the RealityUI Entity materials respond to light.
-  public init(isEnabled: Bool = true, respondsToLighting: Bool = false) {
-    self.ruiEnabled = isEnabled
-    self.respondsToLighting = respondsToLighting
-  }
+    /// Create a new ``RUIComponent`` for a RealityUI Entity
+    /// - Parameters:
+    ///   - isEnabled: A Boolean value indicating whether the RealityUI Entity is enabled.
+    ///   - respondsToLighting: A Boolean value indicating whether the RealityUI Entity materials respond to light.
+    public init(isEnabled: Bool = true, respondsToLighting: Bool = false) {
+        self.ruiEnabled = isEnabled
+        self.respondsToLighting = respondsToLighting
+    }
 }
 
 /// An interface used for all entities in the RealityUI package
-public protocol HasRUI: Entity {
-}
+public protocol HasRUI: Entity {}
+
 public extension HasRUI {
-  /// A Boolean value that determines whether touch events are ignored on this RealityUI Entity
-  var ruiEnabled: Bool {
-    get { self.RUI.ruiEnabled }
-    set {
-      if self.RUI.ruiEnabled == newValue { return }
-      self.RUI.ruiEnabled = newValue
-      (self as? HasRUIMaterials)?.materialsShouldChange()
+    /// A Boolean value that determines whether touch events are ignored on this RealityUI Entity
+    var ruiEnabled: Bool {
+        get { self.rui.ruiEnabled }
+        set {
+            if self.rui.ruiEnabled == newValue { return }
+            self.rui.ruiEnabled = newValue
+            (self as? HasRUIMaterials)?.materialsShouldChange()
+        }
     }
-  }
 
-  /// A Boolean value that determines whether this Entity's materials respond to lighting
-  var respondsToLighting: Bool {
-    get { self.RUI.respondsToLighting }
-    set {
-      if self.RUI.respondsToLighting == newValue { return }
-      self.RUI.respondsToLighting = newValue
-      (self as? HasRUIMaterials)?.materialsShouldChange()
+    /// A Boolean value that determines whether this Entity's materials respond to lighting
+    var respondsToLighting: Bool {
+        get { self.rui.respondsToLighting }
+        set {
+            if self.rui.respondsToLighting == newValue { return }
+            self.rui.respondsToLighting = newValue
+            (self as? HasRUIMaterials)?.materialsShouldChange()
+        }
     }
-  }
 
-  /// Replace the current RUIComponent
-  /// - Parameter RUI: new RUIComponent
-  func replaceRUI(with RUI: RUIComponent) {
-    self.RUI = RUI
-    (self as? HasRUIMaterials)?.materialsShouldChange()
-  }
+    /// Replace the current RUIComponent
+    /// - Parameter rui: new RUIComponent
+    func replaceRUI(with rui: RUIComponent) {
+        self.rui = rui
+        (self as? HasRUIMaterials)?.materialsShouldChange()
+    }
 
-  /// RealityUI Component for the entity.
-  internal(set) var RUI: RUIComponent {
-    get {
-      if let ruiComp = self.components[RUIComponent.self] as? RUIComponent {
-        return ruiComp
-      } else {
-        self.components[RUIComponent.self] = RUIComponent()
-        return self.components[RUIComponent.self]!
-      }
+    @available(*, deprecated, renamed: "rui")
+    internal(set) var RUI: RUIComponent {
+        get { self.rui }
+        set { self.rui = newValue }
     }
-    set {
-      self.components[RUIComponent.self] = newValue
+    /// RealityUI Component for the entity.
+    internal(set) var rui: RUIComponent {
+        get {
+            if let ruiComp = self.components[RUIComponent.self] as? RUIComponent {
+                return ruiComp
+            } else {
+                self.components[RUIComponent.self] = RUIComponent()
+                return self.components[RUIComponent.self]!
+            }
+        }
+        set {
+            self.components[RUIComponent.self] = newValue
+        }
     }
-  }
 
 }
 
 internal extension HasRUI {
-  func getModel(part: String) -> ModelEntity? {
-    self.findEntity(named: part) as? ModelEntity
-  }
-  func ruiOrientation() {
-    if let startOrient = RealityUI.startingOrientation {
-      self.orientation = startOrient
+    func getModel(part: String) -> ModelEntity? {
+        self.findEntity(named: part) as? ModelEntity
+    }
+    func ruiOrientation() {
+        if let startOrient = RealityUI.startingOrientation {
+            self.orientation = startOrient
+        }
     }
-  }
-  func addModel(part: String) -> ModelEntity {
-    if let modelPart = self.getModel(part: part) {
-      return modelPart
+    func addModel(part: String) -> ModelEntity {
+        if let modelPart = self.getModel(part: part) {
+            return modelPart
+        }
+        let newModelPart = ModelEntity()
+        newModelPart.name = part
+        self.addChild(newModelPart)
+        return newModelPart
     }
-    let newModelPart = ModelEntity()
-    newModelPart.name = part
-    self.addChild(newModelPart)
-    return newModelPart
-  }
 }
 
 /// An interface used for RealityUI entities that have materials generated from colours
-/// These materials change with ruiEnabled and `self.RUI.respondsToLighting`.
+/// These materials change with ``HasRUI/ruiEnabled`` and ``HasRUI/respondsToLighting``.
 public protocol HasRUIMaterials: HasRUI {
-  /// All RealityUI Entities should have a method for updating all the materials
-  /// This is in case of disabling entities or changing their responsiveness to light.
-  /// This method does not need to be called by outside of a RealityUI class.
-  func updateMaterials()
+    /// All RealityUI Entities should have a method for updating all the materials
+    /// This is in case of disabling entities or changing their responsiveness to light.
+    /// This method does not need to be called by outside of a RealityUI class.
+    func updateMaterials()
 }
 extension HasRUIMaterials {
-  fileprivate func materialsShouldChange() {
-    self.updateMaterials()
-  }
-  func getMaterial(with color: Material.Color) -> Material {
-    var alpha: CGFloat = 0
-    #if os(macOS)
-    alpha = color.alphaComponent
-    #else
-    color.getWhite(nil, alpha: &alpha)
-    #endif
-    let adjustedColor = color.withAlphaComponent(alpha * (self.ruiEnabled ? 1 : 0.5))
-    if self.RUI.respondsToLighting {
-      return SimpleMaterial(color: adjustedColor, isMetallic: false)
+    fileprivate func materialsShouldChange() {
+        self.updateMaterials()
+    }
+    func getMaterial(with color: Material.Color) -> Material {
+        var alpha: CGFloat = 0
+#if os(macOS)
+        alpha = color.alphaComponent
+#else
+        color.getWhite(nil, alpha: &alpha)
+#endif
+        let adjustedColor = color.withAlphaComponent(alpha * (self.ruiEnabled ? 1 : 0.5))
+        if self.rui.respondsToLighting {
+            return SimpleMaterial(color: adjustedColor, isMetallic: false)
+        }
+        return UnlitMaterial(color: adjustedColor)
     }
-    return UnlitMaterial(color: adjustedColor)
-  }
 }