マルチタップ操作の処理

Compose を試す
Jetpack Compose は Android で推奨される UI ツールキットです。Compose でタップと入力を使用する方法について説明します。

マルチタッチ ジェスチャーとは、複数のポインタ(指)が画面を同時にタップすることです。このドキュメントでは、複数のポインタを含む操作を検出する方法について説明します。

複数のポインタのトラッキング

複数のポインタが画面を同時にタップすると、システムは次のタッチイベントを生成します。

  • ACTION_DOWN: 最初のポインタが画面をタップしたときに送信されます。これで操作が開始されます。このポインタのポインタデータは常に MotionEvent のインデックス 0 にあります。
  • ACTION_POINTER_DOWN: 最初のポインタの後に追加のポインタが画面に入ったときに送信されます。停止したポインタのインデックスは、getActionIndex() を使用して取得できます。
  • ACTION_MOVE: 任意の数のポインタを含む操作で変更が発生すると送信されます。
  • ACTION_POINTER_UP: プライマリ以外のポインタが上昇したときに送信されます。起動したポインタのインデックスは、getActionIndex() を使用して取得できます。
  • ACTION_UP: 最後のポインタが画面を離れると送信されます。
  • ACTION_CANCEL: すべてのポインタを含む操作全体がキャンセルされることを示します。

開始と終了のジェスチャー

操作は、ACTION_DOWN イベントで始まり、ACTION_UP イベントまたは ACTION_CANCEL イベントで終わる一連のイベントです。一度に実行できる操作は 1 つのみです。DOWN、MOVE、UP、CANCEL の各アクションは、ジェスチャー全体に適用されます。たとえば、ACTION_MOVE を含むイベントは、その時点ですべてのポインタが下に移動したことを示すことができます。

ポインタを追跡する

ポインタのインデックスと ID を使用して、MotionEvent 内の個々のポインタ位置をトラッキングします。

  • インデックス: MotionEvent はポインタ情報を配列に格納します。ポインタのインデックスは、この配列内の位置です。ほとんどの MotionEvent メソッドは、ポインタ ID ではなくパラメータとしてポインタ インデックスを受け取ります。
  • ID: 各ポインタには、タップイベント全体で持続する ID マッピングもあり、操作全体で個々のポインタをトラッキングできるようになります。

個々のポインタは、未定義の順序でモーション イベント内に表示されます。したがって、ポインタのインデックスはイベント間で変化する可能性がありますが、ポインタのポインタ ID はポインタがアクティブである限り一定であることが保証されます。getPointerId() メソッドを使用してポインタの ID を取得し、ジェスチャーにおける後続のモーション イベント全体でポインタをトラッキングします。次に、連続するモーション イベントについて、findPointerIndex() メソッドを使用して、そのモーション イベント内の特定のポインタ ID のポインタ インデックスを取得します。次に例を示します。

Kotlin

private var mActivePointerId: Int = 0

override fun onTouchEvent(event: MotionEvent): Boolean {
    ...
    // Get the pointer ID.
    mActivePointerId = event.getPointerId(0)

    // ... Many touch events later...

    // Use the pointer ID to find the index of the active pointer
    // and fetch its position.
    val (x: Float, y: Float) = event.findPointerIndex(mActivePointerId).let { pointerIndex ->
        // Get the pointer's current position.
        event.getX(pointerIndex) to event.getY(pointerIndex)
    }
    ...
}

Java

private int mActivePointerId;

public boolean onTouchEvent(MotionEvent event) {
    ...
    // Get the pointer ID.
    mActivePointerId = event.getPointerId(0);

    // ... Many touch events later...

    // Use the pointer ID to find the index of the active pointer
    // and fetch its position.
    int pointerIndex = event.findPointerIndex(mActivePointerId);
    // Get the pointer's current position.
    float x = event.getX(pointerIndex);
    float y = event.getY(pointerIndex);
    ...
}

複数のタッチポインタをサポートするには、個々の ACTION_POINTER_DOWN および ACTION_DOWN イベント時刻に、ID を持つすべてのアクティブなポインタをキャッシュに保存します。ACTION_POINTER_UP イベントと ACTION_UP イベントでキャッシュからポインタを削除します。キャッシュに保存された ID は、他のアクション イベントを正しく処理するのに役立ちます。たとえば、ACTION_MOVE イベントを処理する場合、キャッシュに保存されたアクティブなポインタ ID ごとにインデックスを見つけ、getX() 関数と getY() 関数を使用してポインタの座標を取得してから、これらの座標をキャッシュに保存された座標と比較して、移動したポインタを見つけます。

getActionIndex() 関数は、ACTION_POINTER_UP イベントと ACTION_POINTER_DOWN イベントでのみ使用します。ACTION_MOVE イベントでは常に 0 を返すため、この関数は使用しないでください。

MotionEvent 件のアクションを取得する

MotionEvent のアクションを取得するには、getActionMasked() メソッドまたは互換性バージョン MotionEventCompat.getActionMasked() を使用します。以前の getAction() メソッドとは異なり、getActionMasked() は複数のポインタで動作するように設計されています。ポインタ インデックスなしでアクションを返します。有効なポインタ インデックスを持つアクションの場合は、次のスニペットに示すように、getActionIndex() を使用してアクションに関連付けられたポインタのインデックスを返します。

Kotlin

val (xPos: Int, yPos: Int) = MotionEventCompat.getActionMasked(event).let { action ->
    Log.d(DEBUG_TAG, "The action is ${actionToString(action)}")
    // Get the index of the pointer associated with the action.
    MotionEventCompat.getActionIndex(event).let { index ->
        // The coordinates of the current screen contact, relative to
        // the responding View or Activity.
        MotionEventCompat.getX(event, index).toInt() to MotionEventCompat.getY(event, index).toInt()
    }
}

if (event.pointerCount > 1) {
    Log.d(DEBUG_TAG, "Multitouch event")

} else {
    // Single touch event.
    Log.d(DEBUG_TAG, "Single touch event")
}

...

// Given an action int, returns a string description.
fun actionToString(action: Int): String {
    return when (action) {
        MotionEvent.ACTION_DOWN -> "Down"
        MotionEvent.ACTION_MOVE -> "Move"
        MotionEvent.ACTION_POINTER_DOWN -> "Pointer Down"
        MotionEvent.ACTION_UP -> "Up"
        MotionEvent.ACTION_POINTER_UP -> "Pointer Up"
        MotionEvent.ACTION_OUTSIDE -> "Outside"
        MotionEvent.ACTION_CANCEL -> "Cancel"
        else -> ""
    }
}

Java

int action = MotionEventCompat.getActionMasked(event);
// Get the index of the pointer associated with the action.
int index = MotionEventCompat.getActionIndex(event);
int xPos = -1;
int yPos = -1;

Log.d(DEBUG_TAG,"The action is " + actionToString(action));

if (event.getPointerCount() > 1) {
    Log.d(DEBUG_TAG,"Multitouch event");
    // The coordinates of the current screen contact, relative to
    // the responding View or Activity.
    xPos = (int)MotionEventCompat.getX(event, index);
    yPos = (int)MotionEventCompat.getY(event, index);

} else {
    // Single touch event.
    Log.d(DEBUG_TAG,"Single touch event");
    xPos = (int)MotionEventCompat.getX(event, index);
    yPos = (int)MotionEventCompat.getY(event, index);
}
...

// Given an action int, returns a string description
public static String actionToString(int action) {
    switch (action) {

        case MotionEvent.ACTION_DOWN: return "Down";
	case MotionEvent.ACTION_MOVE: return "Move";
	case MotionEvent.ACTION_POINTER_DOWN: return "Pointer Down";
	case MotionEvent.ACTION_UP: return "Up";
	case MotionEvent.ACTION_POINTER_UP: return "Pointer Up";
	case MotionEvent.ACTION_OUTSIDE: return "Outside";
	case MotionEvent.ACTION_CANCEL: return "Cancel";
    }
    return "";
}
図 1.マルチタッチの描画パターン

参考情報

入力イベントの詳細については、次のリファレンスをご覧ください。