Skip to content

Improve InputView haptics #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve InputView haptics #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions DeltaCore/UI/Controller/ButtonsInputView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ class ButtonsInputView: UIView

private let imageView = UIImageView(frame: .zero)

private let feedbackGenerator = UIImpactFeedbackGenerator(style: .medium)
private let lightFeedbackGenerator = UIImpactFeedbackGenerator(style: .light)
private let mediumFeedbackGenerator = UIImpactFeedbackGenerator(style: .medium)

private var touchInputsMappingDictionary: [UITouch: Set<AnyInput>] = [:]
private var previousTouchInputs = Set<AnyInput>()
Expand All @@ -46,7 +47,8 @@ class ButtonsInputView: UIView

self.isMultipleTouchEnabled = true

self.feedbackGenerator.prepare()
self.lightFeedbackGenerator.prepare()
self.mediumFeedbackGenerator.prepare()

self.imageView.translatesAutoresizingMaskIntoConstraints = false
self.addSubview(self.imageView)
Expand Down Expand Up @@ -199,15 +201,25 @@ private extension ButtonsInputView
{
switch UIDevice.current.feedbackSupportLevel
{
case .feedbackGenerator: self.feedbackGenerator.impactOccurred()
case .feedbackGenerator: self.mediumFeedbackGenerator.impactOccurred()
case .basic, .unsupported: UIDevice.current.vibrate()
}
}
}

// Just like with thumbstick, have a haptic on release
if !deactivatedInputs.isEmpty
{
self.deactivateInputsHandler?(deactivatedInputs)

if self.isHapticFeedbackEnabled
{
switch UIDevice.current.feedbackSupportLevel
{
case .feedbackGenerator: self.lightFeedbackGenerator.impactOccurred()
case .basic, .unsupported: UIDevice.current.vibrate()
}
}
}
}
}
153 changes: 89 additions & 64 deletions DeltaCore/UI/Controller/ThumbstickInputView.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,6 @@
import UIKit
import simd

extension ThumbstickInputView
{
private enum Direction
{
case up
case down
case left
case right

init?(xAxis: Double, yAxis: Double, threshold: Double)
{
let deadzone = -threshold...threshold
switch (xAxis, yAxis)
{
case (deadzone, deadzone): return nil
case (...0, deadzone): self = .left
case (0..., deadzone): self = .right
case (deadzone, ...0): self = .down
case (deadzone, 0...): self = .up
default: return nil
}
}
}
}

class ThumbstickInputView: UIView
{
var isHapticFeedbackEnabled = true
Expand All @@ -55,13 +30,15 @@ class ThumbstickInputView: UIView
private let imageView = UIImageView(image: nil)
private let panGestureRecognizer = ImmediatePanGestureRecognizer(target: nil, action: nil)

private let lightFeedbackGenerator = UISelectionFeedbackGenerator()
private let mediumFeedbackGenerator = UIImpactFeedbackGenerator(style: .medium)
private let lightFeedbackGenerator = UIImpactFeedbackGenerator(style: .light)
private let rigidFeedbackGenerator = UIImpactFeedbackGenerator(style: .rigid)
private let softFeedbackGenerator = UIImpactFeedbackGenerator(style: .soft)

private var isActivated = false
private var wasActivated = false
private var wasAtEdge = false

private var trackingOrigin: CGPoint?
private var previousDirection: Direction?
private var previousOctant: Int?

private var isTracking: Bool {
return self.trackingOrigin != nil
Expand Down Expand Up @@ -107,7 +84,8 @@ private extension ThumbstickInputView
if self.isHapticFeedbackEnabled
{
self.lightFeedbackGenerator.prepare()
self.mediumFeedbackGenerator.prepare()
self.rigidFeedbackGenerator.prepare()
self.softFeedbackGenerator.prepare()
}

self.update()
Expand Down Expand Up @@ -154,14 +132,14 @@ private extension ThumbstickInputView

if self.isHapticFeedbackEnabled
{
self.mediumFeedbackGenerator.impactOccurred()
self.lightFeedbackGenerator.impactOccurred()
}

self.update()

self.trackingOrigin = nil
self.isActivated = false
self.previousDirection = nil
self.wasActivated = false
self.previousOctant = nil

default: break
}
Expand Down Expand Up @@ -199,59 +177,106 @@ private extension ThumbstickInputView
var adjustedY = distance * sin(angle)
adjustedY += center.y

let insetSideLength = maximumDistance / sqrt(2)
let insetFrame = CGRect(x: center.x - insetSideLength / 2,
y: center.y - insetSideLength / 2,
width: insetSideLength,
height: insetSideLength)
let innerDeadzone = 0.1
let outerDeadzone = 0.99

let threshold = 0.1
// Invert Y coordinate
var xAxis = (adjustedX / maximumDistance) - 1
var yAxis = ((adjustedY / maximumDistance) - 1) * -1

var xAxis = Double((CGFloat(adjustedX) - insetFrame.minX) / insetFrame.width)
xAxis = max(xAxis, 0)
xAxis = min(xAxis, 1)
xAxis = (xAxis * 2) - 1 // Convert range from [0, 1] to [-1, 1].
// Keep within the bounds
xAxis = getBoundedValue(xAxis)
yAxis = getBoundedValue(yAxis)

if abs(xAxis) < threshold
var magnitude = sqrt(xAxis * xAxis + yAxis * yAxis)

// This should really always be bounded, but just in case
magnitude = getBoundedValue(magnitude)

let isActivated = magnitude > innerDeadzone
let isAtEdge = magnitude > outerDeadzone

// Compare against magnitude; inner deadzone should be a circle
if !isActivated
{
xAxis = 0
yAxis = 0
}

var yAxis = Double((CGFloat(adjustedY) - insetFrame.minY) / insetFrame.height)
yAxis = max(yAxis, 0)
yAxis = min(yAxis, 1)
yAxis = -((yAxis * 2) - 1) // Convert range from [0, 1] to [-1, 1], then invert it (due to flipped coordinates).
// Play haptics when:
// - Stick is moved away from the deadzone (soft)
// - Stick is returned to the deadzone (soft)
// - Stick is released after being outside the deadzone (light)

if abs(yAxis) < threshold
if (isActivated && !self.wasActivated)
{
yAxis = 0
self.softFeedbackGenerator.impactOccurred()
}

let magnitude = simd_length(SIMD2(xAxis, yAxis))
let isActivated = (magnitude > 0.1)

if let direction = Direction(xAxis: xAxis, yAxis: yAxis, threshold: threshold)
if (!isActivated && self.wasActivated)
{
if self.previousDirection != direction && self.isHapticFeedbackEnabled
if (magnitude > 0.001)
{
self.mediumFeedbackGenerator.impactOccurred()
self.softFeedbackGenerator.impactOccurred()
}
else
{
self.lightFeedbackGenerator.impactOccurred()
}

self.previousDirection = direction
}
else

// Must covert angle, otherwise the bump between from octants 7 and 0 will have no haptic
let theta = getTheta(angle)
let octant = isActivated ? getOctant(theta) : nil
let hasOctantChanged = self.previousOctant != nil && octant != nil && self.previousOctant != octant

// Play haptics when:
// - Stick is at edge but was not previously (rigid)
// - Stick is "clicking" along the edge from one octant to another (rigid)
// - Stick is "clicking" inside the edge from one octant to another (soft)

if (isAtEdge && !self.wasAtEdge)
{
self.rigidFeedbackGenerator.impactOccurred()
}

if hasOctantChanged
{
if isActivated && !self.isActivated && self.isHapticFeedbackEnabled
if isAtEdge
{
self.lightFeedbackGenerator.selectionChanged()
self.rigidFeedbackGenerator.impactOccurred()
}
else
{
self.softFeedbackGenerator.impactOccurred()
}

self.previousDirection = nil
}

self.isActivated = isActivated
self.wasActivated = isActivated
self.wasAtEdge = isAtEdge

self.previousOctant = octant

self.imageView.center = CGPoint(x: adjustedX, y: adjustedY)
self.valueChangedHandler?(xAxis, yAxis)
}

// Bounds value from -1 to 1
private func getBoundedValue(_ value: Double) -> Double
{
var boundedValue = max(value, -1)
return min(boundedValue, 1)
}

// Converts angle bounded from (-pi, pi) to (0, 2pi)
private func getTheta(_ angle: Double) -> Double
{
return angle < 0 ? angle + (2 * Double.pi) : angle
}

// Get octant where (0, theta/4) is octant 0
private func getOctant(_ theta: Double) -> Int
{
return (Int) (4 / Double.pi * theta)
}
}