Swift
A library to empower iOS app control through head gaze without a finger touch

HeadGazeLib

What is the Project

HeadGazeLib is a pure Swift library to empower iOS app control through head gaze without a finger touch.
See the story behind it here

The above teaser is available at example/demo.

Who May Wish to Use the Project

Any iOS developer who would like to introduce head-based control to their app. Ideal for accessibility and game control.

Dependencies

iPhone X, iOS 11, Swift 4

How to use the library

1. Simply copy and paste the entire folder HeadGazeLib to your xcode project.
2. Extend your ViewController from UIHeadGazeViewController and change the button outlet reference class from UIButton to UIHoverableButton or UIBubbleButton

class MyViewController: UIHeadGazeViewController{
    @IBOutlet weak var myButton: UIBubbleButton! // UIButton!
}

3. Similarily, change the button class from UIButton to UIHoverableButton or UIBubbleButton in the identity inspector of storyboard

4. Define head gaze event handler through UIHeadGazeRecognizer instance in MyViewController class

class MyViewController: UIHeadGazeViewController{
//.....
  private var headGazeRecognizer: UIHeadGazeRecognizer? = nil

  override func viewDidLoad() {
    super.viewDidLoad()
    setupGestureRecognizer()
  }
  private func setupGestureRecognizer() {
    // set button dwell duration
    self.myButton.dwellDuration = 1 // in second
    
    // add head gaze recognizer to handle head gaze event
    self.headGazeRecognizer = UIHeadGazeRecognizer()
    
    //Between [0,9]. Stablize the cursor reducing the wiggling noise.
    //The higher the value the more smoothly the cursor moves.
    super.virtualCursorView?.smoothness = 9
    
    super.virtualCursorView?.addGestureRecognizer(headGazeRecognizer)
    self.headGazeRecognizer?.move = { [weak self] gaze in

        self?.buttonAction(button: (self?.myButton)!, gaze: gaze)

    }
  }
  private func buttonAction(button: UIButton, gaze: UIHeadGaze){
    guard let button = button as? UIHoverableButton else { return }
    // The button instance would trigger TouchUpInside event after user specified seconds
    button.hover(gaze: gaze) 
  }
  
  @IBAction func myBtnTouchUpInside(_ sender: UIBubbleButton) {
     print("Button clicked by head gaze.")
  }
//....
}

For working demo, we have prepared three examples:

1. demo: A simple jump start example showing how to empower a regular iOS app with head control with minimum code change.
2. HeadSwipe: A more serious example - swipe daily deal on eBay with head control
3. Sensitivity: An example on how to use UIMultiFuncButton to track the location and timestamp of the cursor as user is "clicking" the button. Useful for sensitivity analysis.

License

Copyright 2018 eBay Inc.
HeadGazeLib is available under the MIT license. See the LICENSE file for more info.

Developers

Jinrong Xie, Muratcan Cicek, Robinson Piramuthu