はじめに (対象読者・この記事でわかること)

この記事は、Swift を用いて iOS アプリケーション開発を行っている方、特にタッチイベントの処理を実装しようとしているものの、期待通りに touchesBegan メソッドが呼び出されないという問題に直面している方を対象としています。

この記事を読むことで、以下の点が明確になります。

  • touchesBegan が動作しない主な原因
  • UIResponder のイベント処理の仕組み
  • touchesBegan を正しく動作させるための具体的な実装方法
  • デバッグを効率化するためのヒント

Swift でのタッチイベント処理の基本を理解し、スムーズな UI 実装ができるようになることを目指します。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。 * Swift の基本的な文法 * iOS アプリ開発の基本的な流れ * UIKit フレームワークの概要

touchesBegan が反応しない！その意外な原因と落とし穴

Swift で画面上のタップなどのタッチイベントを検出するために、UIView や UIViewController のサブクラスで touchesBegan(_:with:) メソッドをオーバーライドして実装することは一般的です。しかし、コードを記述しても、なぜかこのメソッドが呼び出されないという状況に遭遇することがあります。

よくある誤解と落とし穴

touchesBegan が動かない場合、多くの開発者はコードの誤りや、イベント処理のロジックに問題があると考えがちです。しかし、実際にはそれ以外の、より根本的な部分に原因があることが少なくありません。

1. イベントの「受け取り」の問題

touchesBegan は、UIResponder クラスのメソッドであり、UIResponder チェーンを通じてイベントが伝達されます。このチェーンにおいて、イベントを最初に「受け取る」必要があるクラス（通常は UIView やそのサブクラス）が、そのイベントを適切に処理できる状態になっていないと、後続の処理にイベントが伝わりません。

2. userInteractionEnabled プロパティの盲点

最も頻繁に見られる原因の一つが、ビューの userInteractionEnabled プロパティです。このプロパティが false に設定されていると、そのビューはユーザーからのインタラクション（タッチ、ジェスチャーなど）を受け付けなくなります。touchesBegan が定義されていても、ビュー自体がイベントを受け取れないため、メソッドが呼び出されることはありません。

3. ビュー階層におけるイベントの「遮断」

複数のビューが重なっている場合、最前面にあるビューがタッチイベントを「消費」してしまうことがあります。もし、最前面のビューがタッチイベントを処理し、かつ super.touchesBegan(_:with:) を呼び出さない場合、その下の階層にあるビューにはイベントが伝達されません。

4. カスタムジェスチャーレコグナイザーによる干渉

ジェスチャーレコグナイザーをカスタムで追加している場合、そのレコグナイザーの設定によっては、ネイティブのタッチイベント処理に影響を与えることがあります。例えば、ジェスチャーレコグナイザーがタッチイベントを優先的に処理するように設定されている場合、touchesBegan の前にジェスチャーレコグナイザーのコールバックが実行され、イベントの伝達経路が変わることがあります。

調査とデバッグのヒント

これらの原因を特定するために、以下のデバッグ手法が有効です。

  • print デバッグ: touchesBegan メソッドの先頭に print("touchesBegan called!") のようなデバッグ出力を仕込み、実際にメソッドが到達しているかを確認します。
  • userInteractionEnabled の確認: ビューの userInteractionEnabled プロパティが true になっているかを、コード上またはブレークポイントで確認します。
  • ビュー階層の確認: Xcode の Interface Builder や View Debugger を使用して、ビューの重なり順や階層構造を確認します。
  • ジェスチャーレコグナイザーの無効化: 一時的にカスタムジェスチャーレコグナイザーを無効化して、問題が解消するかどうかを確認します。

touchesBegan を正しく動作させるための実践的アプローチ

touchesBegan が動かない原因が特定できたら、具体的な解決策を適用します。ここでは、上記で挙げた原因に対応する実装方法を解説します。

1. userInteractionEnabled の確認と設定

最も基本的かつ重要な確認事項です。

Swift

// 例: MyView.swift

class MyView: UIView {

    override init(frame: CGRect) {
        super.init(frame: frame)
        setupView()
    }

    required init?(coder: NSCoder) {
        super.init(coder: coder)
        setupView()
    }

    private func setupView() {
        // このビューでタッチイベントを有効にする
        self.isUserInteractionEnabled = true
        // 必要であれば背景色を設定して、ビューが画面に表示されていることを確認しやすくする
        self.backgroundColor = .systemBlue
    }

    override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
        super.touchesBegan(touches, with: event)
        print("touchesBegan has been called!")

        guard let touch = touches.first else { return }
        let location = touch.location(in: self)
        print("Tapped at: \(location)")

        // ここにタップ時の処理を記述
    }
}

この例では、setupView() メソッド内で self.isUserInteractionEnabled = true と明示的に設定しています。ストーリーボードや XIB でビューを配置している場合でも、コード上でこのプロパティが true になっているかを確認しましょう。

2. ビュー階層とイベント伝達の理解

複数のビューが重なっている場合、イベントの伝達順序を理解することが重要です。

イベント伝達の基本

  • タッチイベントは、最も前面にある、インタラクションを受け付けるビューに最初に通知されます。
  • そのビューで touchesBegan がオーバーライドされ、super.touchesBegan(_:with:) が呼び出されない場合、イベントはそれ以上伝達されません。
  • super.touchesBegan(_:with:) を呼び出すことで、イベントは UIResponder チェーンを上に（親ビューや親ビューコントローラーへ）伝達される可能性があります。

解決策：ヒットテストのカスタマイズ

特定の条件下で、重なったビューのタッチイベントを処理したい場合があります。その場合、point(inside:with:) メソッドをオーバーライドして、ビューがタッチイベントを受け取るべきかどうかをカスタマイズできます。

Swift

// 例: CustomHitTestView.swift

class CustomHitTestView: UIView {

    override init(frame: CGRect) {
        super.init(frame: frame)
        self.backgroundColor = .systemGreen
        self.isUserInteractionEnabled = true // タッチを受け付けるようにする
    }

    required init?(coder: NSCoder) {
        super.init(coder: coder)
        self.isUserInteractionEnabled = true // タッチを受け付けるようにする
    }

    // このビューの範囲外でも、特定の領域であればタッチを受け付けるようにする
    override func point(inside point: CGPoint, with event: UIEvent?) -> Bool {
        // 例: ビューの境界線から10ポイント外側までタッチを有効にする
        let expandedFrame = self.bounds.insetBy(dx: -10, dy: -10)
        return expandedFrame.contains(point)
    }

    override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
        super.touchesBegan(touches, with: event)
        print("CustomHitTestView: touchesBegan called!")
    }
}

この CustomHitTestView は、自身の bounds よりも少し大きい仮想的な矩形（expandedFrame）を定義し、その矩形内にタッチポイントが含まれていれば true を返します。これにより、ビューの見た目の領域外でもタッチイベントを受け取ることが可能になります。

解決策：hitTest(_:with:) の活用

hitTest(_:with:) メソッドは、与えられたタッチポイントがどのサブビューに属するかを判断するためにビュー階層を走査する際に、各ビューで呼び出されます。このメソッドをオーバーライドすることで、タッチイベントの伝達先をより細かく制御できます。

Swift

// 例: ParentView.swift (CustomHitTestView を配置する親ビュー)

class ParentView: UIView {

    let childView = CustomHitTestView(frame: CGRect(x: 50, y: 50, width: 100, height: 100))

    override init(frame: CGRect) {
        super.init(frame: frame)
        self.backgroundColor = .systemRed
        self.addSubview(childView)
    }

    required init?(coder: NSCoder) {
        super.init(coder: coder)
        self.addSubview(childView)
    }

    // このメソッドで、どのサブビューがタッチを受け取るかを決定する
    override func hitTest(_ point: CGPoint, with event: UIEvent?) -> UIView? {
        // まず、子ビューの hitTest(_:with:) を呼び出す
        if let hitView = childView.hitTest(point, with: event) {
            // 子ビューがタッチを処理できる場合、それを返す
            return hitView
        }
        // 子ビューがタッチを処理できない場合、親ビュー自身が処理するかどうかを判断する
        // ここでは、親ビューの範囲内であれば親ビュー自身を返す
        if self.bounds.contains(point) {
            return self
        }
        // それ以外の場合は nil を返す（タッチを受け付けない）
        return nil
    }

    override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
        super.touchesBegan(touches, with: event)
        print("ParentView: touchesBegan called!")
    }
}

この ParentView の hitTest(_:with:) メソッドでは、まず子ビューである childView の hitTest を呼び出します。もし childView がタッチを受け取ると判断した場合、childView を返します。そうでなければ、ParentView 自身がタッチを受け取るかを判断します。

3. ジェスチャーレコグナイザーとの連携

カスタムジェスチャーレコグナイザーを追加している場合、touchesBegan の動作に影響を与えないように設定することが重要です。

解決策：UIGestureRecognizerDelegate の活用

ジェスチャーレコグナイザーは、デフォルトでは touchesBegan よりも先にイベントを受け取ることがあります。touchesBegan の処理も同時に行いたい場合は、UIGestureRecognizerDelegate プロトコルを使用し、gestureRecognizer(_:shouldRecognizeSimultaneouslyWith:) メソッドを実装します。

Swift

// 例: ViewController.swift

class ViewController: UIViewController {

    let myView = MyView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))
    let tapGesture = UITapGestureRecognizer()

    override func viewDidLoad() {
        super.viewDidLoad()
        view.backgroundColor = .white

        myView.center = view.center
        view.addSubview(myView)

        // ジェスチャーレコグナイザーの設定
        tapGesture.delegate = self // デリゲートを設定
        tapGesture.addTarget(self, action: #selector(handleTap(_:)))
        myView.addGestureRecognizer(tapGesture)
    }

    @objc func handleTap(_ sender: UITapGestureRecognizer) {
        print("GestureRecognizer: Tap recognized!")
        // ジェスチャーレコグナイザーでの処理
    }
}

// MARK: - UIGestureRecognizerDelegate

extension ViewController: UIGestureRecognizerDelegate {
    // 複数のジェスチャーレコグナイザーが同時に認識されることを許可する
    func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldRecognizeSimultaneouslyWith otherGestureRecognizer: UIGestureRecognizer) -> Bool {
        // tapGesture と他のジェスチャーが同時に認識されることを許可する
        // ここで `gestureRecognizer` と `otherGestureRecognizer` を適切に条件分岐させることで、
        // 特定のジェスチャー間でのみ同時認識を許可することも可能
        return true
    }

    // 特定のジェスチャーレコグナイザーが他のジェスチャーレコグナイザーよりも優先されるかを決定する
    // （今回は touchesBegan も動かしたいので、デフォルトの挙動で問題ないことが多い）
    // func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldBeRequiredToFailOf otherGestureRecognizer: UIGestureRecognizer) -> Bool {
    //     return false
    // }
}

この例では、ViewController が UIGestureRecognizerDelegate に準拠し、shouldRecognizeSimultaneouslyWith メソッドを true で返しています。これにより、tapGesture と myView の touchesBegan メソッドが同時に（あるいはほぼ同時に）呼び出されるようになります。

まとめ

本記事では、Swift における touchesBegan メソッドが動作しないという、iOS 開発でしばしば遭遇する問題の原因と解決策について詳細に解説しました。

  • touchesBegan が動かない主な原因として、userInteractionEnabled が false になっている、ビュー階層でイベントが遮断されている、ジェスチャーレコグナイザーが干渉している、といった点を挙げました。
  • これらの原因を特定するためのデバッグ方法として、print デバッグや View Debugger の活用を紹介しました。
  • 具体的な解決策として、userInteractionEnabled の設定、point(inside:with:) や hitTest(_:with:) を用いたイベント伝達の制御、そして UIGestureRecognizerDelegate を利用したジェスチャーレコグナイザーとの連携方法をコード例と共に示しました。

この記事を通して、touchesBegan の挙動の裏側にある UIResponder のイベント処理の仕組みと、タッチイベントを適切に制御するための実践的なアプローチを理解できたことと思います。 今後は、さらに複雑なマルチタッチイベントの処理や、カスタムジェスチャーの作成など、より発展的な内容についても掘り下げていく予定です。

参考資料