ヽ|∵|ゝ(Fantom) の 開発blog? ホーム »Unityプラグイン
このページの記事一覧

【Unity】カスタムダイアログを簡単に生成するプレファブを作ってみた(CustomDialogController)  


 どちらかと言うとこのプラグインはプログラマ向けという感じだったが、Unity は GUIツールでもあるので、プログラムに詳しくない人でも扱えるように、今回のアップデートではなるべくコードを書かずに、ダイアログなどを簡単に生成できるプレファブを作ってみた。しかし、大抵のものは楽に使えると思うが、カスタムダイアログだけは与えるパラメータが最も多く、扱いが難しく感じるので、ここでは各アイテムの設定などを含めて解説しておくことにした。方法だけわかってしまえば、わりと簡単に扱えるようになると思う。

>>プラグイン&サンプルをダウンロード
(Google Drive を利用。画面右上にあるダウンロードアイコンを押す)


 プラグインのインポートからはじめる場合は以前の記事を参照して欲しい。実際にセットアップしてあるサンプルシーンは「Assets/_Test/Scenes/DialogExTest」となる。プレファブをコピペして使うのも良いだろう。


(※) Unity 5.6.3p1, 2017.3.0f3 / Windows10(x64) / Galaxy S7 Edge (Android 7.0) で確認



■カスタムダイアログの概要と使い方

 簡単に言うと、カスタムダイアログとは「分割線」「テキスト」「スイッチ」「スライダー」「トグルボタン(グループ)」を自由に追加できるダイアログである。「分割線」「テキスト」は戻り値を持たないが、「スイッチ」「スライダー」「トグルボタン(グループ)」はキーを設定することによって、そのキーに関連づけられた値を辞書形式(Dictionary<string, string>: key, value)で受け取ることができる(※キーの重複はできない)。ただし、値は全て文字列型になので、適宜キーで判別するなどして変換して使うことになる。プラグイン内にはスイッチ(SwitchDialog)スライダー(SliderDialog)を並べたダイアログなどもあるが、それらの各アイテムを自分でカスタマイズできるダイアログと考えれば良い。

 使い方は「AndroidPlugin.ShowCustomDialog()」に各アイテムのパラメータ(DialogItem)の配列を渡せば良いが、ここではそれらを少し簡単にまとめた「CustomDialogController」のプレファブを中心に扱うことをやってみよう。プレファブは「Assets/FantomLib/Prefabs/Dialogs/CustomDialogController.prefab」にある。これをヒエラルキーに置き、そのオブジェクトの子要素として(「Find Items In Child」がオンのとき)、各アイテムのプレファブ「DialogItemDivisor」「DialogItemText」「DialogItemSwitch」「DialogItemSlider」「DialogItemToggles」(「DialogItems」フォルダにまとめてある)を配置することで生成することができる(上から順にダイアログ内に配置される)。なお、孫要素までは探さない。また「Find Items In Child」がオフのときは自分で「Items」の「Size」を設定し、そこに各アイテムのプレファブなどを登録すれば良い。




 結果の受け取り方は、インスペクタのコールバックにメソッドを登録することにより受信できる。コールバックには2種類あって「On Result」はダイアログで「OK」ボタンを押したときの最終的な結果を辞書(Dictionary<strring, string>)でキーと値のペア(文字列型)で受け取ることができる。もう1つのコールバック「On Value Changed」はダイアログ表示中に「スイッチ」「スライダー」「トグルボタン(グループ)」が押されたときにリアルタイムで値を受け取ることができるものだ(こちらはキーと値がそれぞれ文字列型で返される)。プレビューなどに使うと良い。


(※) インスペクタでのコールバックの登録方法がわからない場合は以下の記事を参考にして欲しい。
【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録

 また「Save Value」はそれら結果を PlayerPrefs に自動保存しておく機能だ。「Save Key」で保存名(PlayerPrefs のキー)を指定することもできる。空の場合、その GameObject 名+"_values" のような名前で保存される(PlayerPrefsキー名はプロパティの「SaveKey」で取得できる)。またプロパティの「CurrentValue」でいつでも値を取得・変更することもできる(Dictionary<string, string> 形式)。ただし、保存タイミングは「OK」ボタンで決定したときなので注意しよう(OnValueChanged では保存されない。保存したいときは手動で CurrentValue で値をセットし、SavePrefs() メソッドで保存する必要がある)。

 各アイテムの設定は「DialogItemParameter」というクラス(便宜上すべてのアイテムのパラメータをまとめたクラス。実行時には DialogItem の派生クラスに変換される)に代入することになるが、各アイテムによって必要なパラメータは異なるので、以下に順に解説しておこう。



■分割線の設定(DialogItemDivisor)


 「分割線」とはただの区切り線である。キーを持たず、特に機能はない。使用するにはまず「Item Type」を「Divisor」にする。あとは以下にパラメータの説明をまとめて置いたので、任意に設定して欲しい。

●引数
Line Height線の太さ。単位は Android の dp となる。
Line Color線の色。ただし、無色透明(#00000000)を与えると指定なし(デフォルト=灰色)となる。





■テキストの設定(DialogItemText)


 「テキスト」とはただの文字列表示である。キーを持たず、特に機能はない。使用するにはまず「Item Type」を「Text」にする。あとは以下にパラメータの説明をまとめて置いたので、任意に設定して欲しい。

●引数
Text表示するテキスト文字列。
Text Colorテキストの色。ただし、無色透明(#00000000)を与えると指定なし(デフォルト=薄い黒)となる。
Background Colorテキストの背景色。ただし、無色透明(#00000000)を与えると指定なし(デフォルト=なし[システムによる])となる。
Align文字揃え。「Left」で左寄せ、「Center」で中央寄せ、「Right」で右寄せ、「None」で指定なし(デフォルト=左寄せ[システムによる])。





■スイッチの設定(DialogItemSwitch)


 「スイッチ」とはオン・オフを切り替えることによって「true」または「false」の値(ただし文字列型)を返すウィジェットである。キーを持ち、その値はキーに紐付けられて返される。使用するにはまず「Item Type」を「Switch」にする。あとは以下にパラメータの説明をまとめて置いたので、任意に設定して欲しい。

●引数
Key値に紐付けするキー。コールバックで返される値(辞書:Dictionary<string, string>)では result["key"]="true" または result["key"]="false"(※値は文字列型なので注意)の形式で返される。キーは重複できない。
Text表示するテキスト文字列。
isOnスイッチの初期値。オン = true, オフ = false
Text Colorテキストの色。ただし、無色透明(#00000000)を与えると指定なし(デフォルト=薄い黒)となる。





■スライダーの設定(DialogItemSlider)


 「スライダー」(Android ではシークバーと呼ばれる)とはスライダーを動かすことによって値を変化させるウィジェットである(ただし文字列型)。キーを持ち、その値はキーに紐付けられて返される。使用するにはまず「Item Type」を「Slider」にする。あとは以下にパラメータの説明をまとめて置いたので、任意に設定して欲しい。

●引数
Key値に紐付けするキー。コールバックで返される値(辞書:Dictionary<string, string>)では result["key"]="value"(※値は文字列型なので注意)の形式で返される。キーは重複できない。
Text表示するテキスト文字列。
Value初期値(整数部分6桁+小数点以下3桁まで)。
Min Value取り得る最小値(整数部分6桁+小数点以下3桁まで)。
Max Value取り得る最大値(整数部分6桁+小数点以下3桁まで)。
Digit小数点以下桁数(0:整数, 1~3:小数点以下桁数)。
Text Colorテキストの色。ただし、無色透明(#00000000)を与えると指定なし(デフォルト=薄い黒)となる。






■トグルボタン(グループ)の設定(DialogItemToggles)


 「トグルボタン(グループ)」(Android ではラジオボタンと呼ばれる)とはグループ内のアイテムを唯一選択するウィジェットである。キーを持ち、その値はキーに紐付けられて返される。その選択肢は「Toggle Items」にまとめられ、それぞれのアイテムの値(Value)が設定されたキーに紐付けられる(key=value1 または key=value2, … のように)。使用するにはまず「Item Type」を「Toggle」にする。あとは以下にパラメータの説明をまとめて置いたので、任意に設定して欲しい。

●引数
Key値に紐付けするキー。コールバックで返される値(辞書:Dictionary<string, string>)では result["key"]="value" の形式で返される。キーは重複できない。
Toggle Items[]選択肢の文字列と値の配列。「Text」は表示文字列で、「Value」が選択された場合の戻り値となる。
Selected Index初期値(選択)のインデクス(0~)。
Text Colorテキストの色。ただし、無色透明(#00000000)を与えると指定なし(デフォルト=薄い黒)となる。




 これらは以前に書いたコードでの機能と同じものなので(というより、コードをなるべく書かないで済むようにプレファブを作っただけのもの)、コードで書きたい場合は以前の記事を参考にして欲しい。



■更新履歴

 今回のアップデートを簡単に説明しておくと以下のようになる。[⇒全体の更新履歴はこちら]

・おおよそ全ての機能のプレファブ&「~Controller」スクリプトを追加。
単一選択(SingleChoiceDialog)複数選択(MultiChoiceDialog)スイッチダイアログ(SwitchDialog)カスタムダイアログのアイテムに値変化のコールバックを追加。
・XDebug の自動改行フラグ(newline)が無視されていた不具合を修正。また、行数制限を使用しているときに、OnDestory() でテキストのバッファ(Queue)をクリアするようにした。

※以前のバージョン上書きでも問題なく動作すると思います。


(関連記事)
【Unity】Androidでカスタマイズしたダイアログを動的生成できるプラグインを作ってみた
【Unity】Androidのトーストやダイアログ、通知、音声認識、ハード音量操作など基本的な機能を使えるプラグインを作ってみた
【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録


スポンサーサイト

category: Unity

thread: ゲーム開発

janre: コンピュータ

tag: Unityライブラリ  Unityプラグイン 
tb: 0   cm: --

【Unity】【C#】SmoothFollow3(SmoothFollow に回転・遠近・高さ操作とピンチ・スワイプとの連携機能を付けた拡張版)  


 実は非常に好評だったりする「SmoothFollow2」の後継版。基本的には以前の内容と変わらないのだが、せっかく「ピンチ」「スワイプ」といった機能も作ったので、それらも連携できるようにしてみた。モバイル操作対応版という感じでもあるかな。ただ「SmoothFollow2」でもかなりパラメタ(フィールド)が多かったので、今回のバージョンからは少し機能ごとにまとめたため、変数名は変更した(機能はそのまま)。

SmoothFollow3PinchInput を利用してる


 自分で作るのが面倒な人はプラグイン内にデモとして使用しているので、ダウンロードしてコピペで利用して欲しい。


>>プラグイン&サンプルをダウンロード
(Google Drive を利用。画面右上にあるダウンロードアイコンを押す)



(※) Unity 5.6.3p1 / Windows10(x64) / Galaxy S7 Edge (Android 7.0) で確認



●SmoothFollow3(StanardAssets の SmoothFollow に回転・遠近・高さ操作とピンチ・スワイプとの連携機能を付けた拡張版)

using System;
using UnityEngine;

namespace FantomLib
{
/// <summary>
/// SmoothFollow に左右回転アングルと高さと距離の遠近機能を追加したもの ver.3
/// 2018/01/09 Fantom (Unity 5.6.3p1)
/// http://fantom1x.blog130.fc2.com/blog-entry-289.html
/// (SmoothFollow2 からの変更点)
/// http://fantom1x.blog130.fc2.com/blog-entry-163.html
///・SwipeInput のコールバックでのスワイプで一定角度の旋回を追加。
///・PinchInput のコールバックでのピンチで距離の操作を追加(モバイル用)。
///・起動時に設定された対象(target)から、距離(distance)、高さ(height)、角度(preAngle)を算出するオプションを追加。
///・初期状態へのリセットメソッド(ResetOperations())を追加。
///・ドラッグの認識する画面上の領域(validArea)を追加。
///・各設定をクラスで分けたので、変数名が変更された(機能は全て同じ)。
///(使い方)
///・カメラなどの GameObject にアタッチして、インスペクタから target に視点となるオブジェクトを登録すれば使用可。
///(仕様説明)
///・画面全体を(0,0)-(1,1)とし、有効領域内(Valid Area)でタッチまたはマウスでクリックしたとき認識する。
///・タッチ操作は指1本のみ(かつ最初の1本)の操作が有効となる(2本以上→1本になったときは認識しない)。
///・指でのドラッグとスワイプ操作を分けるため、AngleOperation.dragWidthLimit の値(画面幅による比率)より大きいときは(=指を素早く動かしたときは)ドラッグとして認識しない
/// (スワイプは SwipeInput.validWidth の値で認識)。
///・タッチデバイスを UNITY_ANDROID, UNITY_IOS としているので、他のデバイスも加えたい場合は #if の条件文にデバイスを追加する(Input.touchCount が取得できるもののみ)。
/// </summary>
public class SmoothFollow3 : MonoBehaviour
{
public Transform target; //追従するオブジェクト

public bool autoInitOnPlay = true; //distance, height, preAngle を起動時に target 位置から自動算出する
public float distance = 2.0f; //XZ平面の距離
public float height = 0f; //Y軸の高さ
public float preAngle = 0f; //カメラアングル初期値

public bool widthReference = true; //画面幅(Screen.width)サイズを比率の基準にする(false=高さ(Screen.height)を基準)

//認識する画面上の領域
public Rect validArea = new Rect(0, 0, 1, 1); //認識する画面領域(0.0~1.0)[(0,0):画面左下, (1,1):画面右上]


//回転操作
[Serializable]
public class AngleOperation
{
public float damping = 3.0f; //左右回転のスムーズ移動速度

//キー入力
public bool keyEnable = true; //回転のキー操作の ON/OFF
public float keySpeed = 45f; //左右回転速度
public KeyCode keyLeft = KeyCode.Z; //左回転キー
public KeyCode keyRight = KeyCode.X; //右回転キー

//ドラッグ
public bool dragEnable = true; //回転のドラッグ操作の ON/OFF
public float dragSpeed = 10f; //ドラッグ操作での回転速度
public float dragWidthLimit = 0.1f; //ドラッグとして認識できる幅(0 のとき制限なし ~ 1 のとき画面幅)。この幅以上は認識しない(スワイプと区別するため)。
}
public AngleOperation angleOperation;


//旋回(一定角度回転)
[Serializable]
public class TurnOperation
{
public float angle = 90f; //旋回の角度

//キー入力
public bool keyEnable = true; //旋回キーの ON/OFF
public KeyCode keyLeft = KeyCode.KeypadMinus; //左旋回キー
public KeyCode keyRight = KeyCode.KeypadPlus; //右旋回キー

//スワイプ
public bool swipeEnable = true; //スワイプで旋回の ON/OFF
}
public TurnOperation turnOperation;


//高さの操作
[Serializable]
public class HeightOperation
{
public float damping = 2.0f; //上下高さのスムーズ移動速度

//キー入力
public bool keyEnable = true; //高さのキー操作の ON/OFF
public float keySpeed = 1.5f; //キー操作での移動速度
public KeyCode keyUp = KeyCode.C; //高さ上へキー
public KeyCode keyDown = KeyCode.V; //高さ下へキー

//ドラッグ
public bool dragEnable = true; //高さのドラッグ操作での ON/OFF
public float dragSpeed = 0.5f; //ドラッグ操作での高さ移動速度
}
public HeightOperation heightOperation;


//距離の操作
[Serializable]
public class DistanceOperation
{
public float damping = 1.0f; //距離のスムーズ移動速度(キーとホイール)
public float min = 1.0f; //XZ平面での最小距離

//キー入力
public bool keyEnable = true; //距離のキー操作の ON/OFF
public float keySpeed = 0.5f; //距離の移動速度
public KeyCode keyNear = KeyCode.B; //近くへキー
public KeyCode keyFar = KeyCode.N; //遠くへキー

//ホイール
public bool wheelEnable = true; //距離のホイール操作の ON/OFF
public float wheelSpeed = 7f; //ホイール1目盛りの速度

//ピンチ
public bool pinchEnable = true; //ピンチで距離を操作する
public float pinchDamping = 5f; //ピンチでの距離のスムーズ移動速度(キーとホイールでの操作と分けるため)
public float pinchSpeed = 40f; //ピンチでの距離の変化速度
}
public DistanceOperation distanceOperation;


//初期状態リセット操作
[Serializable]
public class ResetOperation
{
public bool keyEnable = true; //初期状態リセットキーの ON/OFF
public KeyCode key = KeyCode.KeypadPeriod; //初期状態リセットキー
}
public ResetOperation resetOperation;


//Local Values
float angle; //カメラアングル(XZ平面)
Vector3 startPos; //マウス移動始点
float wantedDistance; //変化先距離
float resetDistance; //初期距離保存用
float resetHeight; //初期位置高さ保存用
bool pinched = false; //ピンチで操作したフラグ(distanceDamping と pinchDistanceDamping を切り替える)
bool dragging = false; //ドラッグの操作中フラグ


// Use this for initialization
void Start()
{
if (autoInitOnPlay && target != null)
{
height = transform.position.y - target.position.y;
Vector3 dir = Vector3.ProjectOnPlane(target.position - transform.position, Vector3.up);
distance = dir.magnitude;
preAngle = AngleXZWithSign(target.forward, dir);
}

angle = preAngle;
resetDistance = wantedDistance = distance;
resetHeight = height;
}

// Update is called once per frame
void Update()
{
#if !UNITY_EDITOR && (UNITY_ANDROID || UNITY_IOS) //タッチで取得したいプラットフォームのみ(モバイル等)
if (Input.touchCount != 1 || Input.touches[0].fingerId != 0) //最初の指1本の操作に限定する
{
dragging = false;
return;
}
#endif

//回転のキー操作
if (angleOperation.keyEnable)
{
if (Input.GetKey(angleOperation.keyLeft))
angle = Mathf.Repeat(angle + angleOperation.keySpeed * Time.deltaTime, 360f);

if (Input.GetKey(angleOperation.keyRight))
angle = Mathf.Repeat(angle - angleOperation.keySpeed * Time.deltaTime, 360f);
}

//旋回(一定角度回転)キー操作
if (turnOperation.keyEnable)
{
if (Input.GetKeyDown(turnOperation.keyLeft))
TurnLeft();

if (Input.GetKeyDown(turnOperation.keyRight))
TurnRight();
}

//高さのキー操作
if (heightOperation.keyEnable)
{
if (Input.GetKey(heightOperation.keyUp))
height += heightOperation.keySpeed * Time.deltaTime;

if (Input.GetKey(heightOperation.keyDown))
height -= heightOperation.keySpeed * Time.deltaTime;
}

//ドラッグ操作
if (angleOperation.dragEnable || heightOperation.dragEnable)
{
Vector3 movePos = Vector3.zero;

if (!dragging && Input.GetMouseButtonDown(0))
{
startPos = Input.mousePosition;
if (validArea.xMin * Screen.width <= startPos.x && startPos.x <= validArea.xMax * Screen.width &&
validArea.yMin * Screen.height <= startPos.y && startPos.y <= validArea.yMax * Screen.height)
{
dragging = true;
}
}
else if (dragging)
{
if (Input.GetMouseButton(0))
{
movePos = Input.mousePosition - startPos;
startPos = Input.mousePosition;

//ドラッグ幅で制限する(スワイプと分別するため)
if (angleOperation.dragWidthLimit > 0)
{
float limit = (widthReference ? Screen.width : Screen.height) * angleOperation.dragWidthLimit;
float d = Mathf.Max(Mathf.Abs(movePos.x), Mathf.Abs(movePos.y)); //大きい方で判定
if (d > limit)
{
movePos = Vector3.zero; //操作を無効にする
dragging = false;
}
}
}
else //Input.GetMouseButtonUp(0), exit
{
dragging = false;
}
}

if (movePos != Vector3.zero)
{
//回転のドラッグ操作
if (angleOperation.dragEnable)
angle = Mathf.Repeat(angle + movePos.x * angleOperation.dragSpeed * Time.deltaTime, 360f);

//高さのドラッグ操作
if (heightOperation.dragEnable)
height -= movePos.y * heightOperation.dragSpeed * Time.deltaTime;
}
}

//距離のキー操作
if (distanceOperation.keyEnable)
{
if (Input.GetKey(distanceOperation.keyNear))
{
wantedDistance = Mathf.Max(distanceOperation.min, distance - distanceOperation.keySpeed);
pinched = false;
}

if (Input.GetKey(distanceOperation.keyFar))
{
wantedDistance = distance + distanceOperation.keySpeed;
pinched = false;
}
}

//距離のホイール遠近
if (distanceOperation.wheelEnable)
{
float mw = Input.GetAxis("Mouse ScrollWheel");
if (mw != 0)
{
wantedDistance = Mathf.Max(distanceOperation.min, distance - mw * distanceOperation.wheelSpeed); //0.1 x N倍
pinched = false;
}
}

//初期状態リセット
if (resetOperation.keyEnable)
{
if (Input.GetKeyDown(resetOperation.key))
ResetOperations();
}
}

void LateUpdate()
{
if (target == null)
return;

//追従先位置
float wantedRotationAngle = target.eulerAngles.y + angle;
float wantedHeight = target.position.y + height;

//現在位置
float currentRotationAngle = transform.eulerAngles.y;
float currentHeight = transform.position.y;

//追従先へのスムーズ移動距離(方向)
currentRotationAngle = Mathf.LerpAngle(currentRotationAngle, wantedRotationAngle,
angleOperation.damping * Time.deltaTime);
currentHeight = Mathf.Lerp(currentHeight, wantedHeight, heightOperation.damping * Time.deltaTime);
distance = Mathf.Lerp(distance, wantedDistance,
(pinched ? distanceOperation.pinchDamping : distanceOperation.damping) * Time.deltaTime);

//カメラの移動
var currentRotation = Quaternion.Euler(0, currentRotationAngle, 0);
Vector3 pos = target.position - currentRotation * Vector3.forward * distance;
pos.y = currentHeight;
transform.position = pos;

transform.LookAt(target);
}


//状態リセット(初期状態に戻す)
public void ResetOperations()
{
height = resetHeight;
distance = wantedDistance = resetDistance;
angle = preAngle;
}


//ピンチで距離を操作(モバイル等)
//http://fantom1x.blog130.fc2.com/blog-entry-288.html
//・PinchInput を使用して距離を操作する。
//width: ピンチ幅, delta: 直前のピンチ幅の差, ratio: ピンチ幅の開始時からの伸縮比(1:ピンチ開始時, 1以上拡大, 1より下(1/2,1/3,...)縮小)
public void OnPinch(float width, float delta, float ratio)
{
if (!distanceOperation.pinchEnable)
return;

if (delta != 0)
{
wantedDistance = Mathf.Max(distanceOperation.min, distance - delta * distanceOperation.pinchSpeed);
pinched = true;
}
}

//スワイプで旋回
//・SwipeInput を使用して旋回する。
//http://fantom1x.blog130.fc2.com/blog-entry-250.html
public void OnSwipe(Vector2 dir)
{
if (!turnOperation.swipeEnable)
return;

if (dir == Vector2.left)
TurnLeft();
else if (dir == Vector2.right)
TurnRight();
}


//左旋回
public void TurnLeft()
{
angle = Mathf.Repeat(MultipleCeil(angle - turnOperation.angle, turnOperation.angle), 360f);
}

//右旋回
public void TurnRight()
{
angle = Mathf.Repeat(MultipleFloor(angle + turnOperation.angle, turnOperation.angle), 360f);
}


//以下、static method

//より小さい倍数を求める(倍数で切り捨てられるような値)
//http://fantom1x.blog130.fc2.com/blog-entry-248.html
static float MultipleFloor(float value, float multiple)
{
return Mathf.Floor(value / multiple) * multiple;
}

//より大きい倍数を求める(倍数で繰り上がるような値)
static float MultipleCeil(float value, float multiple)
{
return Mathf.Ceil(value / multiple) * multiple;
}

//2D(XY平面)での方向ベクトル同士の角度を符号付きで返す(度)
//http://fantom1x.blog130.fc2.com/blog-entry-253.html#AngleWithSign
static float AngleXZWithSign(Vector3 from, Vector3 to)
{
Vector3 projFrom = from;
Vector3 projTo = to;
projFrom.y = projTo.y = 0; //y軸を無視する(XZ平面に投影する)
float angle = Vector3.Angle(projFrom, projTo);
float cross = CrossXZ(projFrom, projTo);
return (cross != 0) ? angle * -Mathf.Sign(cross) : angle; //2D外積の符号を反転する
}

//2Dでの外積を求める(XY平面)
//http://fantom1x.blog130.fc2.com/blog-entry-253.html#Cross2D
static float CrossXZ(Vector3 a, Vector3 b)
{
return a.x * b.z - a.z * b.x;
}
}
}

 うむ、「SmoothFollow2」より随分と簡潔に書いたつもりだが、めっちゃ長いな(笑)。セットアップや使い方などは「SmoothFollow2」と変わらないので、そちらに丸投げしよう(必要ならこちらを参照して欲しい)。また、SmoothFollow2 との主な相違点はこちらにまとめて置いた。ここでは新しく加わった要素と、モバイル対応のために追加した機能などを主に説明しておこう。

 1つ目は「autoInitOnPlay」のオプションだ。これは起動時に設定された対象(target)から、距離(distance)、高さ(height)、角度(preAngle)を自動算出するオプションで、true のときはインスペクタで設定している distance, height, preAngle は上書きされるので注意しよう。簡単に言えばこれはエディタで見えている感じをそのまま反映させるオプションである。ただし、カメラは常に LookAt(対象の方を向く)されているので、カメラ自体の回転は変わることに注意しよう。どうしてもエディタと同じような見え方にしたい場合は、あらかじめカメラの高さや方向を合わせておけば良い。そうすればオプションを true でエディタと全く同じ見え方になる。そしてその起動時に取得された距離(distance)、高さ(height)、角度(preAngle)などは「ResetOperations()」を呼び出すことで、いつでも元に戻せる

 次にドラッグなどを認識できる画面領域を設定する「validArea」を説明しておこう。これは「ピンチ」「スワイプ」「ロングタップ」に使われているものと全く同じもので、画面左下を基準に (0, 0) とし、画面右上を (1, 1) として、その中でしか操作を認識しないというものである。例えば、画面の下 1/4 ほどにはアイコンなどを置き、ドラッグなどの操作対象にしたくないときは validArea を (X, Y) = (0, 0.25), (W, H) = (1, 0.75) のように設定すれば、下の方でドラッグしても無視される(回転などはしない)。

 それ以外には「AngleOperation」と「TurnOperation」の違いを説明しておこう。「AngleOperation」の方は以前から備わっている対象を中心に自由に回転角を操作できるものだ。これに対して「TurnOperation」の方は同じように回転はするが、必ず「TurnOperation.angle」で設定された一定角度まで回転する。これはクォータービューのゲームのように常に一定角度(だいたい45度とか90度とか)で覗きたいときの回転方法だ。内部的には同じ値を参照しているので、どちらか一方を使いたい場合は「AngleOperation」と「TurnOperation」内の「~Enable」でオン・オフを設定すれば良い。

 あとはピンチ(PinchInput)スワイプ(Swipe)との連携方法だが、それらは以降を参照して欲しい。基本的にはインスペクタでセットアップするだけだ。



■スワイプ(SwipeInput)と連携して一定角度の旋回をする(TurnOperation 連携)

 ここでは以前に作った「SwipeInput」を利用して、スワイプで一定角度の旋回をする(TurnOperation 連携)するセットアップを紹介しておこう。アタッチする GameObject は任意で構わないが、インスペクタから SwipeInput.OnSwipe に SmoothFollow3.OnSwipe を登録(Dynamic の方)をすれば良いだけである。旋回の角度は「TurnOperation.angle」で設定できるので、あとは「Swipe Enable」がオンになっていることだけを確認すればOKだ(デフォルト=オン)。


 ただし、SmoothFollow3.OnSwipe() は左右のスワイプしか受け付けない。OnSwipe() 自体の引数は Vector2 なので、例えばボタンから Vector2.leftVector2.right を送れば同じように旋回できる。

 コールバックの登録の仕方がわからない場合は、以下の記事も参照して欲しい。

【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録



■ピンチ(PinchInput)と連携して遠近を操作する(DistanceOperation 連携)

 もう1つ、以前に作った「PinchInput」を利用して、ピンチで距離の遠近を操作する(DistanceOperation 連携)するセットアップを紹介しておこう。アタッチする GameObject は任意で構わないが、インスペクタから PinchInput.OnPinch に SmoothFollow3.OnPinch を登録(Dynamic の方)をすれば良いだけだ(OnPinchStart は必要ない)。遠近操作の速度は「DistanceOperation.pinchSpeed」で主に調整すれば良いだろう(pinchDamping はスムーズに移動する速度で、大きくすれば急速に移動できる)。あとは「PinchInput.isNormalized:オン」「SmoothFollow3 の Pinch Enable」がオンになっていることだけを確認すればOKだ(デフォルト=オン)。


 SmoothFollow3.OnPinch() で受け取る値は主に delta(正規化されたピンチの距離差分)でピクセル単位でないことに注意しよう(PinchInput を使用していて、isNormalized=true であれば気にする必要ない:デフォルト設定)。自分で実装する場合は、以前のピンチの記事を参照して欲しい。これは画面解像度に依存しないようにした処置なので、同じような方法を用いてるなら「DistanceOperation.pinchSpeed」を調整すれば他のスクリプトからも利用できるだろう。この値(delta)は線形的な相対量なので、例えばボタンを押し続けると一定間隔で移動量を与えるなら(符号に注意)、同じように遠近操作できる。

 コールバックの登録の仕方がわからない場合は、以下の記事も参照して欲しい。

【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録



■SmoothFollow2 との相違点・対応パラメタ一覧

 大ざっぱに「SmoothFollow2」との主な変更点は、以下のようになる。

・一定角度の回転(45度/90度ごと等の旋回:Turn Operation)機能を追加。
・SwipeInput のコールバックでのスワイプで一定角度の旋回の連携を追加。
・PinchInput のコールバックでのピンチで距離の操作の連携を追加(モバイル用)。
・起動時に設定された対象(target)から、距離(distance)、高さ(height)、角度(preAngle)を算出するオプションを追加。
・初期状態へのリセットメソッド(ResetOperations())を追加。
・ドラッグの認識する画面上の領域(validArea)を追加。
・各設定をクラスで分けたので、変数名が変更された(機能は全て同じ)。

 角度や距離、高さの仕様はそのままなので、その辺りは以前の記事の SmoothFollow2の図解 を見て欲しい。

●変更されたパラメタ一覧(インスペクタ)
SmoothFollow2SmoothFollow3
Height DampingHeight Operation>Damping
Rotation DampingAngle Operation>Damping
Distance DampingDistance Operation>Damping
Angle Key OperationAngle Operation>Key Enable
Angle Key SpeedAngle Operation>Key Speed
Angle Key LeftAngle Operation>Key Left
Angle Key RightAngle Operation>Key Right
Angle Drag OperationAngle Operation>Drag Enable
Angle Drag SpeedAngle Operation>Drag Speed
Height Key OperationHeight Operation>Key Enable
Height Key SpeedHeight Operation>Key Speed
Height Key UpHeight Operation>Key Up
Height Key DownHeight Operation>Key Down
Height Drag OperationHeight Operation>Drag Enable
Height Drag SpeedHeight Operation>Drag Speed
Distance Key OperationDistance Operation>Key Enable
Distance MinDistance Operation>Min
Distance Key SpeedDistance Operation>Key Speed
Distance Key NearDistance Operation>Key Near
Distance Key FarDistance Operation>Key Far
Distance Wheel OperationDistance Operation>Wheel Enable
Distance Wheel SpeedDistance Operation>Wheel Speed

※基本的には各機能ごとのクラスにまとめた感じ。



■ユニティちゃんがアキバ上空を飛ぶ!(Android 版)

 以前に書いた「ユニティちゃんを飛行させる!」をスマホ用にビルドしたデモです。操作パッドは StandardAssets の CrossPlatformInput を使ってます(画像だけ替えてる)。アキバモデル(秋葉原っぽい街)は多少スケールを大きくしてますね(キャラに合わせるならもっと大きい方が実寸に近いと思うが、全体を眺めたいだけなので適当)。最適化などは何もしてないので、眺める角度によってはフレーム落ちしますが、タッチ操作を試すだけなら十分でしょう(画面半分から上でドラッグ、スワイプ、ピンチなどが実装してある)。当たり判定も無いので建物は基本的に突き抜けます(笑)。

 スタート地点は「昭和通り」のバスターミナル辺りですね。現在はつくばエクスプレスの改札口もあります。たぶん全部(100個)集めるのに1時間くらいはかかります。コインの獲得数は保存されているので、無理せず暇な時にでもどうそ。どうしても全部のコインが見つからないときはマップを載せておくので参考にして下さい(見ても難しいと思う)。結構良く街の並びも再現されてますね。色んな場所を飛んでみて楽しんで下さい。

(※) Unity 2017.3.0f3 / Windows10(x64) でビルド。Galaxy S7 Edge (Android 7.0) で確認。

デモアプリのダウンロード (Google Drive を利用)


Android 4.2以上
※「提供元不明アプリのインストール」許可が必要です。



※どうしても100個見つからないときは、以下にコインの位置を示したマップを掲載して置きます。参考にして下さい。

[>>クリックでコインのマップを見る(※ネタバレ注意)]



 参考までにインスペクタの設定はこちら(クリックでキャプチャ画像表示)。一応、横長(Landscape)前提で「Width Reference」(画面の横幅を長さの基準とする)でやってしまってますが、画面をローテーションできるアプリなら、短い方に合わせた方が良いかも知れません。




(関連記事)
【Unity】【C#】SmoothFollow に回転アングルと高さと距離の遠近機能を付けてみる
【Unity】【C#】SmoothFollow を C# で書いてみる
【Unity】【C#】ピンチ操作を取得してコールバックする
【Unity】【C#】スワイプ(フリック)を判定、方向を取得してコールバックする
【Unity】【C#】長押し(ロングタップ)を取得してコールバックする
【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録
【Unity】Androidのトーストやダイアログ、通知、音声認識、ハード音量操作など基本的な機能を使えるプラグインを作ってみた


category: Unity

thread: ゲーム開発

janre: コンピュータ

tag: Unityライブラリ  Unityプラグイン  C#  カメラスクリプト 
tb: 0   cm: --

【Unity】【C#】ピンチ操作を取得してコールバックする  


 既にスワイプロングタップ(クリック)は掲載しているが、スマートフォン等はピンチという操作もよく使われるので、Androidのプラグインに同梱する形で配布することにした。プラグイン自体は Android 専用のものだが、今回のピンチや既存のスワイプロングタップは Unity 上でのスクリプトなので、iOS などでも使えると思う。

 ついでにこのピンチを使って、オブジェクトを拡大・縮小、またはカメラを近づけたり、遠ざけたりする方法(スクリプト)も書いておこう。これらはプラグインのパッケージにデモとしてセットアップされているので、自分で作るのが面倒な人はプラグインをダウンロードして、コピペで利用しても良いと思う。



>>プラグイン&サンプルをダウンロード
(Google Drive を利用。画面右上にあるダウンロードアイコンを押す)



(※) Unity 5.6.3p1 / Windows10(x64) / Galaxy S7 Edge (Android 7.0) で確認



●ピンチを取得してコールバックする

using System;
using UnityEngine;
using UnityEngine.Events;

namespace FantomLib
{
/// <summary>
/// ピンチ操作を取得してコールバックする
/// 2018/01/09 Fantom (Unity 5.6.3p1)
/// http://fantom1x.blog130.fc2.com/blog-entry-288.html
///(使い方)
///・適当な GameObject にアタッチして、インスペクタから OnPinchStart, OnPinch にコールバックする関数を登録すれば使用可。
///・またはプロパティ IsPinching, Width, Delta, Ratio をフレーム毎監視しても良い(こちらの場合は使用してない状態(IsPinching=false, Width=0, Delta=0, Ratio=1)も含まれる)。
///(仕様説明)
///・内部的には画面でタッチされた2本の指の間隔をピクセル単位で取得する。ただし戻り値は画面幅で割った正規化された値とピクセルそのもので返すかを選べる(isNormalized)。
///・ピンチの操作は1本→2本となったときのみ認識する。3本以上→2本になったときは無効。
///・タッチデバイスを UNITY_ANDROID, UNITY_IOS としているので、他のデバイスも加えたい場合は #if の条件文にデバイスを追加する(Input.touchCount が取得できるもののみ)。
/// </summary>
public class PinchInput : MonoBehaviour
{
public bool isNormalized = true; //画面幅(or 高さ)で正規化した値でコールバックする(false=ピクセル単位で返す)
public bool widthReference = true; //isNormalized=true のとき、画面幅(Screen.width)を基準にする(false=高さ(Screen.height)を基準)[単位が px/Screen.width のようになる]

//認識する画面上の領域(0.0~1.0)[(0,0):画面左下, (1,1):画面右上]
public Rect validArea = new Rect(0, 0, 1, 1);

//ピンチ検出プロパティ(フレーム毎取得用)
public bool IsPinching {
get; private set;
}

//ピンチ幅(距離) プロパティ(フレーム毎取得用)
public float Width {
get; private set;
}

//ピンチ幅(距離)の直前との差分 プロパティ(フレーム毎取得用)
public float Delta {
get; private set;
}

//ピンチ幅(距離)の変化比 プロパティ(フレーム毎取得用)
public float Ratio {
get; private set;
}


//ピンチ開始コールバック
[Serializable]
public class PinchStartHandler : UnityEvent<float, Vector2> { } //Width, center(2指間の中心座標)が返る
public PinchStartHandler OnPinchStart;

//ピンチ中コールバック(伸縮率とその差分)
[Serializable]
public class PinchHandler : UnityEvent<float, float, float> { } //Width, Delta, Ratio が返る
public PinchHandler OnPinch;


//Local Values
float startDistance; //ピンチ開始時の指の距離(px)
float oldDistance; //直前の伸縮距離(px)


//アクティブになったら、初期化する(アプリの中断などしたときはリセットする)
void OnEnable()
{
IsPinching = false;
}

// Update is called once per frame
void Update()
{
//プロパティはフレーム毎にリセット
Width = 0; Delta = 0; Ratio = 1;

#if !UNITY_EDITOR && (UNITY_ANDROID || UNITY_IOS) //タッチで取得したいプラットフォームのみ
if (Input.touchCount == 2) //ピンチでの操作(2本指のみ)
{
//※fingerId と touches[] のインデクスは必ずしも一致しないらしいので fingerId=1 となっている方を取得(指1本→2本になったとき可能とするため)
Touch touch = (Input.touches[1].fingerId == 1) ? Input.touches[1] : Input.touches[0];
if (!IsPinching && touch.phase == TouchPhase.Began) //新しく認識したときのみ
{
//認識する画面上の領域内か?(2本の指の中心の座標を基準にする)
Vector2 center = (Input.touches[0].position + Input.touches[1].position) / 2;
if (validArea.xMin * Screen.width <= center.x && center.x <= validArea.xMax * Screen.width &&
validArea.yMin * Screen.height <= center.y && center.y <= validArea.yMax * Screen.height)
{
IsPinching = true; //ピンチ開始

//fingerId=0~1 のみ(必ず最初と2本目の指)。指3本→2本(0-2 など)は不可とする。
Width = startDistance = oldDistance = Vector2.Distance(Input.touches[0].position, Input.touches[1].position);
if (isNormalized)
{
float unit = widthReference ? Screen.width : Screen.height;
Width /= unit; //画面幅で正規化すれば、解像度に依存しなくなる
center /= unit;
}

if (OnPinchStart != null)
OnPinchStart.Invoke(Width, center); //開始時は必ず Delta=0, Ratio=1 となる
}
}
else if (IsPinching) //既に認識されているときのみ:3本→2本になったときは無効になる
{
float endDistance = Vector2.Distance(Input.touches[0].position, Input.touches[1].position);
Width = endDistance;
Delta = endDistance - oldDistance; //直前との差分
Ratio = endDistance / startDistance; //開始時のピンチ幅(px距離)を基準にした倍率になる
oldDistance = endDistance;

if (isNormalized)
{
float unit = widthReference ? Screen.width : Screen.height;
Width /= unit; //画面幅で正規化すれば、解像度に依存しなくなる
Delta /= unit;
}

if (OnPinch != null)
OnPinch.Invoke(Width, Delta, Ratio);
}
}
else //タッチが2つでないときは全て無効にする
#endif
{
IsPinching = false;
}
}
}
}

 ピンチ検出の簡単な解説をしておくと、スマホなどのタッチデバイスで指を2本置いたとき、それぞれの座標からそれらの距離を取得し、指を動かすことによってその座標間の距離の差分でピンチと認識するというものである。

 ただこのスクリプトではもう少し細かく検出されていて、例えば指が1本→2本となったときはピンチと認識するが、指が3本以上→2本となったときは認識しない(1本、3本以上のときは常に無視する)

 またコールバックの引数で返ってくる値は「現在のピンチの幅(距離)」「直前のピンチ幅との差分」「ピンチ開始したときの比率」と3つの値を返す。そしてそれらは実機により画面解像度が違うため、正規化オブション(isNormalized = true)により、端末の解像度で割った値を返すようにしてある(isNormalized = false にするとピクセル単位で返ってくる)。

 他にもフレーム毎で取得したいときのプロパティ(IsPinching, Width, Delta, Ratio)や認識できる画面領域(validArea)などは以前に書いたスワイプロングタップと同じ仕様だ。実際にこれらスクリプトを同時に使用しても問題ないように作ってある。

 プラットフォームに関しては、タッチデバイスとして Android と iOS しか考えてないので、必要あればプリプロセッサ(#if 文)に条件を追加して欲しい。これらは Input.touchCount が取得できるものに限られる。しかしこのスクリプトの場合、Update() での検出部分は Input.touchCount で囲まれているので、スマホで使うこと前提なら、プリプロセッサ(#if 文)をコメントアウトしても良いだろう(Input.touchCount は PCなどでは無効になるため)。

 あと、コールバックイベントはインスペクタで設定(UnityEvent)するようにしてあるが、コードだけにしたいなら、Action を使ったコールバックや、直接 delegate でコールバックするように書き換えても良いだろう。もちろんそのままで UnityEvent.AddListener を使ってコードから追加する方法もある。自由に改造して使って欲しい(※Unity でのコールバック実装は以下を参照)。

【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録



■ピンチでオブジェクトを拡大・縮小する

 ここからは上記の「PinchInput」を使って、実際にオブジェクトの拡大・縮小の操作をやってみよう。このスクリプトは使い回しできるのでライブラリとして追加もしてある。考え方を理解すれば他のものに利用することも可能だろう。
●ピンチでオブジェクトを拡大・縮小する
using UnityEngine;

namespace FantomLib
{
/// <summary>
/// ピンチでスケールを変化させる(ローカルスケール)
/// 2018/01/09 Fantom (Unity 5.6.3p1)
/// http://fantom1x.blog130.fc2.com/blog-entry-288.html
///(使い方)
///・伸縮したい GameObject にアタッチして、インスペクタから PinchInput のコールバックを登録すれば使用可。
/// </summary>
public class PinchToScale : MonoBehaviour
{
public Transform target; //スケール変化させるオブジェクト

//Local Values
Vector3 startScale; //ピンチ開始時スケール
Vector3 initScale; //起動初期スケール(リセット用)


// Use this for initialization
private void Start()
{
if (target == null)
target = gameObject.transform; //指定がないときは自身を対象とする

initScale = target.localScale;
}

//width: ピンチ幅, center: ピンチの2本指の中心の座標
public void OnPinchStart(float width, Vector2 center)
{
if (target != null)
startScale = target.localScale;
}

//width: ピンチ幅, delta: 直前のピンチ幅の差, ratio: ピンチ幅の開始時からの伸縮比(1:ピンチ開始時, 1以上拡大, 1より下(1/2,1/3,...)縮小)
public void OnPinch(float width, float delta, float ratio)
{
if (target != null)
target.localScale = startScale * ratio;
}

//スケールを元に戻す
public void ResetScale()
{
if (target != null)
target.localScale = initScale;
}
}
}


 仮に拡大・縮小するオブジェクトを「Cube」としたとき、インスペクタでの設定は上のようにしよう。スクリプト自体は他の GameObject にアタッチしても構わないが、「PinchToScale」の「Target」には対象となるオブジェクトを指定し、「PinchInput」のピンチ開始時のコールバック「OnPinchStart」に「PinchToScale.OnPinchStart」を登録(Dynamicの方)、ピンチ中のコールバック「OnPinch」には「PinchToScale.OnPinch」を登録(Dynamicの方)する。あとは「PinchInput」の「isNormalize」がオンになっているのを確認すればOKだ(デフォルト=オン)。

 スクリプトの簡単な解説をしておくと、ピンチ開始時のコールバック(OnPinchStart)のときのピンチ幅(指と指の距離)を記録し、ピンチ中は指の開閉による距離の比率(指を開くと 2, 3, 4...倍[小数も含む]となり、指を閉じると 1/2, 1/3, 1/4,..倍[実際には小数=0.5, 0.3, 0.25,...など])で拡大・縮小を行っている。この操作には主にコールバック引数の「ratio」(比率)を使っている。また、スケール操作はローカルスケール(transform.localScale)になる。ただ1つだけ注意して欲しいのは、物理的に指を3倍、4倍と開くのはキツイけど、指を1/3, 1/4 倍と閉じるのは簡単だということだ。指の間隔を比率ではなく、線形的な差分にしたいなら、コールバック引数の「delta」(距離差分)を使っても良いが、実際に試してみると ratio(比率)の方が人間の感覚・見た目には合ってるようだ。線形でやりたい場合はカーブを間に挟んだ方が良い感じになるかも知れない。その辺りは自分で工夫してみて欲しい。



■ピンチでカメラの遠近を操作する

 次に上記の「PinchInput」を使って、視点となるオブジェクトの遠近操作をやってみよう。このスクリプトは使い回しできるのでライブラリとして追加もしてある。考え方を理解すれば他のものに利用することも可能だろう。
●ピンチでオブジェクトとの距離を操作する
using System;
using UnityEngine;

namespace FantomLib
{
/// <summary>
/// ピンチで距離を操作する
/// 2018/01/09 Fantom (Unity 5.6.3p1)
/// http://fantom1x.blog130.fc2.com/blog-entry-288.html
///(使い方)
///・カメラなどの GameObject にアタッチして、インスペクタから PinchInput のコールバックを登録すれば使用可。
///・距離は target からの直線距離となる。
/// </summary>
public class PinchToDistance : MonoBehaviour
{
public Transform target; //視点となるオブジェクト
public float speed = 2f; //変化速度
public float minDistance = 1.0f; //近づける最小距離
public bool lookAt = true; //オブジェクトの方を向く

//LocalValues
float initDistance; //起動初期距離(リセット用)


// Use this for initialization
private void Start()
{
if (target != null)
{
Vector3 dir = target.position - transform.position;
initDistance = dir.magnitude;
if (lookAt)
transform.LookAt(target.position);
}
}

//width: ピンチ幅, delta: 直前のピンチ幅の差, ratio: ピンチ幅の開始時からの伸縮比(1:ピンチ開始時, 1以上拡大, 1より下(1/2,1/3,...)縮小)
public void OnPinch(float width, float delta, float ratio)
{
if (target == null)
return;

Vector3 dir = target.position - transform.position;
float distance = Math.Max(minDistance, dir.magnitude - delta * speed);
Vector3 pos = target.position - dir.normalized * distance;
transform.position = pos;
if (lookAt)
transform.LookAt(target.position);
}

//初期の距離に戻す
public void ResetDistance()
{
if (target == null)
return;

Vector3 dir = target.position - transform.position;
Vector3 pos = target.position - dir.normalized * initDistance;
transform.position = pos;
if (lookAt)
transform.LookAt(target.position);
}
}
}


 仮に視点先となるオブジェクトを「Cube」としたとき、インスペクタでの設定は上のようにしよう。スクリプト自体は他の GameObject にアタッチしても構わないが、「PinchToDistance」の「Target」には対象となるオブジェクトを指定し、「PinchInput」のピンチ開始時のコールバック「OnPinchStart」に「PinchToDistance.OnPinchStart」を登録(Dynamicの方)、ピンチ中のコールバック「OnPinch」には「PinchToDistance.OnPinch」を登録(Dynamicの方)する。あとは「PinchInput」の「isNormalize」がオンになっているのを確認すればOKだ(デフォルト=オン)。

 スクリプトの簡単な解説をしておくと、ピンチ開始時のコールバック(OnPinchStart)は使ってないのだが、ピンチ中は指の開閉による直線の距離の差分(指を開くと正の値が、指を閉じると負の値が返る)で遠近操作を行っている。この操作には主にコールバック引数の「delta」(距離差分)を使っていて、直前の指と指の距離との差を利用し、オブジェクトとの距離を加減算することによって、カメラを移動する感じだ(ただし指を開いたときに近づくには距離をマイナス、指を閉じたときは遠くにするには距離をプラスなので、符号は逆)。これは「ratio」(比率)とは違って線形な値になるので、指を開くときも閉じるときも同じような相対量になる(「ratio」(比率)の解説は PinchToScale を参照)。

 具体的な値については「isNormalize」がオンになっているときは画面幅で正規化(widthReference=falseのときは画面の高さで正規化)された値が返り、オフになっているときはピクセル単位で返ってくる。それは例えば、画面解像度の幅が 800px の機種と 960px の機種があったとき、ピクセル単位だと画面の半分を移動したときそれぞれ、400px と 480px と異なった値になってしまうからだ。なので、端末の画面幅で割っておけば(=正規化する)どちらも 0.5 (= 400/800, 480/960)となり、画面解像度に依存しなくなる。しかし実際のピクセル座標で欲しいときは isNormalize=false にするか、正規化された値×解像度でもピクセル単位に変換できるので、好きな方を使うと良いだろう。



(関連記事)
【Unity】【C#】スワイプ(フリック)を判定、方向を取得してコールバックする
【Unity】【C#】長押し(ロングタップ)を取得してコールバックする
【Unity】【C#】UnityEvent, Action, delegate, interface でのコールバック実装方法とインスペクタでの登録
【Unity】Androidのトーストやダイアログ、通知、音声認識、ハード音量操作など基本的な機能を使えるプラグインを作ってみた


category: Unity

thread: ゲーム開発

janre: コンピュータ

tag: Unityライブラリ  Unityプラグイン  C# 
tb: 0   cm: --

【Unity】Androidで音声認識を使う  


 今回はプラグイン内に入っている音声認識を改めて Unity 側のコードを中心に書いてみよう。大まかにはダイアログを表示する方法と、自分でUIなどを用意し、コールバックメソッドを使って実装していく方法がある。用途によって使い分けるのも良いだろう。

 プラグインの内部的なコード(Java)を知りたい場合は以前の記事を参照して欲しい。プラグイン自体のセットアップからはじめる場合も以前の記事を参照。

>>プラグイン&サンプルをダウンロード
(Google Drive を利用。画面右上にあるダウンロードアイコンを押す)



(※) Unity 5.6.3p1 / AndroidStudio 2.3.3 / Windows10(x64) / Galaxy S7 Edge (Android 7.0) で確認



■音声認識する際の AndroidManifest.xml について

 プラグインのセットアップにも書いてあるが、ここではもう少し詳細に解説しておこう。Googleの音声認識など別のアプリケーションから結果を受け取る際には Unity で通常使われるアクティビティ「UnityPlayerActivity」をオーバーライドした、「ReceiveResultsOnUnityPlayerActivity」(他のアプリケーションから結果を受信するアクティビティ:プラグイン内に入っている)または「FullPluginOnUnityPlayerActivity」(プラグイン機能のすべてが入っている)を使う必要がある。これらのアクティビティ(Activity)はこのプラグイン独自のアクティビティで、他のアプリケーションから何らかのメッセージを受信できるコードが含まれている(Java コードは以前の記事に掲載してある)。インポートした「Assets/Plugins/Android/」にはマニフェストファイルのテンプレとして「AndroidManifest-Speech~.xml」または「AndroidManifest-FullPlugin~.xml」が含まれているので、これらの中から適切なものを選んで(「縦置き・横置き」とか「API Level」とか)、「AndroidManifest.xml」にリネームしてビルドすることで利用することが可能になる。


 なお、ダイアログを表示せず、音声認識のコールバックイベントを実装して結果を受信するなら、オーバーライドしたアクティビティを使う必要はない。具体的には例えば、後述する「StartSpeechRecognizer()」を使って音声認識の音声待機・開始・結果取得・エラーのコールバックを実装するなら、これらマニフェストファイルは必要ない(Unity がデフォルトのマニフェストファイルを用意してくれる)。Unity ではキャラなどを出したいことも多いと思うので、少し大変だが、コールバックイベントを実装していく方法はオススメだ。

(※) 音声認識にはマニフェストファイルに録音パーミッション "RECORD_AUDIO" が必要(「AndroidManifest-Speech~.xml」または「AndroidManifest-FullPlugin~.xml」には含まれている)。

(※) 独自のマニフェストファイルでビルドすると警告「Unable to find unity activity in manifest. You need to make sure orientation attribute is set to sensorPortrait manually.」が出るが、「UnityPlayerActivity」以外のアクティビティを使うと出るものなので気にしなくて良い(orientation=画面回転はUnity側のアプリの設定に合わせた方が良い)。



■ダイアログを使用した音声認識の利用方法


 サンプルシーン「SpeechRecognizerTest」には2つの方法が含まれているが、こちらは「Speech Dialog」のボタンを押したとき出てくる Googleの音声認識ダイアログを利用する方法だ。簡単に言えば、このダイアログは別のアプリケーションであって、それを呼び出して結果だけを受け取る方法であり、音声認識中の待機や開始、失敗(エラー)のときなどは任せっきりで、結果を受け取るだけなので実装は非常に楽だ。しかし、前述した「別のアプリケーションから結果を受け取る特別なアクティビティ」が必要なのと、ダイアログの性質上、画面にオーバーレイで重ねられて表示されるので、Unity でキャラなどが表示されている場合見えなくなってしまうのがデメリットだ。なので、InputField の文字入力の代わりに使うなど、見た目を気にする必要がないときに利用する方が良いだろう(受信する結果などは後述するコールバックの方法と何ら変わりはない)。

 それでは、音声認識のダイアログを呼び出す所からやってみよう。

●Unity から音声認識ダイアログを呼び出す
using FantomLib;

#if UNITY_ANDROID && !UNITY_EDITOR
AndroidPlugin.ShowSpeechRecognizer(callbackGameObject, resultCallbackMethod, message);
#endif

●引数
callbackGameObject音声認識が成功した際、結果をコールバックするヒエラルキーにある GameObject の名前。
resultCallbackMethod音声認識が成功した際、結果をコールバックするメソッドの名前(callbackGameObject 内)。引数に string 型を1つとる。
messageダイアログに表示されるメッセージ文字列。省略すると(=空文字("")) "なんでも話してみてください" になる(システム/バージョンによるかも)。

 認識された音声は "候補1\n候補2\n候補3" のように改行区切り("\n") でヒエラルキーにある GameObject(callbackGameObject)にあるメソッド(resultCallbackMethod)の引数(string 型)として1つづきの文字列として送られてくる。メソッドの名前は任意だが、シグニチャが違っていると無視されてしまうので気をつけよう。例えば結果のコールバックメソッドの名前を "OnResult" と名付けたとすると、以下のように書けば、認識された1つ1つの候補が列挙できる。

●音声認識された文字列を受信するコード
private void OnResult(string result)
{
string[] words = result.Split('\n');
foreach (var item in words)
{
Debug.Log(item); //各候補の文字列
}
}

 ここでは foreach で認識された各候補を表示しているだけだが、ここであらかじめ作っておいた辞書などと照合して処理を分岐したり、プラグインの選択ダイアログを使ってユーザーに絞り込んで貰って、文字列を InputField に代入して利用するなどでも良いだろう。

 サンプルコード「SpeechRecognizerTest.cs」では「ShowSpeechRecognizer()」「ResultSpeechRecognizer()」になるので、コピペなどして使えば難しくはないだろう。シーン「SpeechRecognizerTest」内で「Web Search」のチェックをオンにしたときには選択ダイアログが出るようにしてあるので、絞り込みをしたいときはこの辺りをまるっとコピペすれば簡単に使えると思う。



■コールバックを実装した音声認識の利用方法


 こちらは前述のダイアログを使用した方法とは異なり、Unity でダイアログを介さずに音声認識の結果やエラーなどを受信する方法となる。サンプルシーン「SpeechRecognizerTest」では「Speech Here」のボタンを押したときがそれだ。少し大変かも知れないが、ダイアログを使うより自由度は高いので、Unity などビジュアルが中心のコンテンツには合っている(ビジネスツールみたいなものは、かえってダイアログを出したほうがわかりやすい気がする)。「一択彼女(加藤恵)」みたいなアプリも内部的には同じものを使ってると思う(このプラグインとは関係ないです)。ちなみに音声認識中の "ピロ♪" という音は消せないそうだ。

 なお、こちらのコールバックを実装する方法では前述した特別なアクティビティは必要ないが、録音パーミッション("RECORD_AUDIO")だけは必要だ。

 それではダイアログなしの音声認識を開始するコードを書いてみよう。また未確認だが、機種によって微妙に挙動が異なるとの話もあるので、実機があるのなら色々テストしておいた方が良いかも知れない。

●Unity からコールバックを実装した音声認識を開始する
using FantomLib;

#if UNITY_ANDROID && !UNITY_EDITOR
AndroidPlugin.StartSpeechRecognizer(callbackGameObject, resultCallbackMethod, errorCallbackMethod,
readyCallbackMethod, beginCallbackMethod);
#endif

●引数
callbackGameObject音声認識の結果やエラーなどをコールバックするヒエラルキーにある GameObject の名前。
resultCallbackMethod音声認識が成功した際、結果をコールバックするメソッドの名前(callbackGameObject 内)。引数に string 型を1つとる(結果が返る)。
errorCallbackMethod音声認識が失敗した際、エラーをコールバックするメソッドの名前(callbackGameObject 内)。引数に string 型を1つとる。主なエラーは以下を参照
readyCallbackMethod音声認識が開始され、声の待機をはじめたときコールバックするメソッドの名前(callbackGameObject 内)。UI などを変化させて音声認識がオンになった状態がユーザーにわかるようにしてあげると良い。引数に string 型を1つとる。値は必ず "onReadyForSpeech" になる。タイミングをとるためだけのコールバック。省略可。
beginCallbackMethod音声認識が開始→待機から、はじめの声がマイクに入ったときコールバックするメソッドの名前(callbackGameObject 内)。UI などを変化させて認識中であることをユーザーにわかるようにしてあげると良い。引数に string 型を1つとる。値は必ず "onBeginningOfSpeech" になる。タイミングをとるためだけのコールバック。省略可。

 コールバックは色々あって大変なのだが、特に重要なものは結果(resultCallbackMethod)とエラー(errorCallbackMethod)のコールバックだ。以下に例を載せておこう。

 例えば結果のコールバックメソッド(resultCallbackMethod)の名前を "OnResult" と名付けたとすると、以下のように書けば、認識された1つ1つの候補が列挙できる。

●音声認識された文字列を受信するコード
private void OnResult(string result)
{
string[] words = result.Split('\n');
foreach (var item in words)
{
Debug.Log(item); //各候補の文字列
}
}

 認識された音声は "候補1\n候補2\n候補3" のように改行区切り("\n") でヒエラルキーにある GameObject(callbackGameObject)にあるメソッド(resultCallbackMethod)の引数(string 型)として1つづきの文字列として送られてくる。メソッドの名前は任意だが、シグニチャが違っていると無視されてしまうので気をつけよう。

 ここでは foreach で認識された各候補を表示しているだけだが、ここであらかじめ作っておいた辞書などと照合して処理を分岐したり、プラグインの選択ダイアログを使ってユーザーに絞り込んで貰うのも良いだろう。

 次にエラー時のコールバックメソッド(errorCallbackMethod)の名前を "OnError" と名付けたとすると、以下のように書けば、エラーでの分岐ができる。

●音声認識で失敗したときのエラーを受信するコード
private void OnError(string errmes)
{
switch (errmes) {
case "ERROR_NO_MATCH":
Debug.Log("認識失敗");
break;
case "ERROR_SPEECH_TIMEOUT":
Debug.Log("タイムアウト");
break;
case "ERROR_NETWORK":
Debug.Log("ネットワークに繋がらない");
break;
case "ERROR_AUDIO":
Debug.Log("録音パーミッションがない");
break;
・・・(略)・・・
}
}

 引数で返ってくる値はエラーコードの文字列となる。エラーコードは公式のデベロッパーサイトも参照して欲しいが主に以下のものが出ると考えて良いだろう。

●音声認識でよく出るエラー
ERROR_NO_MATCH音声認識できなかったときに出るエラー。1音のような短いときや、声量が小さすぎるとき、周りの騒音が邪魔で聴き取れないときなどに出やすい。
ERROR_SPEECH_TIMEOUT音声認識が開始→待機中に時間切れしたときに出るエラー。周りの騒音が邪魔で聴き取れないときなどにも出ることがある。
ERROR_NETWORK認識された語句をネットワーク上のデータベースと照合する際に接続できなかったときのエラー。他のアプリがネットワークを専有してたり、何からの理由でネットワークがブロックされているときにも出る。
ERROR_AUDIOマニフェストファイル(AndroidManifest.xml)に録音パーミッション("RECORD_AUDIO")が無いときに出るエラー。パーミッションタグを挿入して再ビルドするしかない。

 他のエラーは以下を参照。
SpeechRecognizer

 その他には音声認識の起動のコールバック(readyCallbackMethod)、声の取得開始(beginCallbackMethod)があるが、それぞれ必ず "onReadyForSpeech", "onBeginningOfSpeech" の文字列が返る。これらはタイミングをとるためのコールバックなので、ここで UI を変化させたり、アニメーションを開始したりすると良いだろう。

 これらのサンプルコードは「SpeechRecognizerTest.cs」の「StartSpeechRecognizer()」「OnReady」「OnBegin」「OnResult」「OnError」とほぼ同じだ。コピペして中身だけ入れ替えれば簡単に利用できるだろう。

 もう1つ、中断する方法を書いておこう、これはリリース(オブジェクト解放)と同じものになる。未確認だが、この中断の挙動が実機の機種によって微妙に違うという話を見たので、使う際は気をつけた方が良いかも知れない。基本的にこの音声認識は放っておいても認識失敗("ERROR_NO_MATCH")かタイムアウト("ERROR_SPEECH_TIMEOUT")で停止するので、必要ないなら中断機能を付けないのも手だ。ともあれ、とりえあず例を載せておこう。といっても音声認識のオブジェクトをリリースするだけだ。

●音声認識を中断・リリースする
using FantomLib;

#if UNITY_ANDROID && !UNITY_EDITOR
AndroidPlugin.ReleaseSpeechRecognizer();
#endif

 内部的なコード(Java)には「SpeechRecognizer.destroy()」を使っている。他にも「SpeechRecognizer.cancel()」とか「SpeechRecognizer.stopListening()」も試してみたが、なぜか私の環境(Galaxy S7 Edge)では上手く行かなかった。この辺りが「停止は機種によって微妙に挙動が違う」と言われる所以なのかも知れない。なので確実に停止させるためには、オブジェクトをリリースするのが一番と考えてこの方法のみを実装してある。

 中断のサンプルは「SpeechRecognizerTest.cs」の「StopSpeechRecognizer()」になるが、同時に UI を止めているくらいで、それほど見る必要もないかも知れない。



■ユニティちゃんと音声認識でじゃんけん(Android 版)

 せっかくなので、このプラグインを使って音声認識でじゃんけんゲームを作ってみた。音声認識の箇所はパッケージに入っている「Assets/_Test/Scripts/SpeechRecognizerTest.cs」をほぼそのまま使っている。具体的には、受け取った結果は改行("\n")で連結されてくるのでそれを分割し、それらの最初の1文字でグー、チョキ、パーを判定する処理(いくつか候補をデータ化してある)を追加しただけだ。

(※) Unity 2017.1.1f1 / Windows10(x64) でビルド。Galaxy S7 Edge (Android 7.0) で確認。

デモアプリのダウンロード (Google Drive を利用)


Android 4.2以上
※「提供元不明アプリのインストール」許可が必要です。


 じゃんけん自体のアルゴリズム・作成方法を知りたければ以下の書籍を参考にすると良いだろう。アイコンがそっくりなのは、実際にこの本を以前読んでいたためである(笑)(※アプリ内のアイコンは新たに作ったものです)。また音声認識は以下の本も参考にしている(※ただし少し古い。実際のビルドは AndroidStudio 2.3.3 でやった)。なのでこのサンプルは2つをミックスしただけとも言える(笑)。

(じゃんけん画像素材)
LiveMaker 指南番

(じゃんけんゲーム/音声認識 参考)



(関連記事)
【Android】【Java】音声入力(音声認識)で文字列を取得する
【Unity】Androidのトーストやダイアログ、通知、音声認識、ハード音量操作など基本的な機能を使えるプラグインを作ってみた
【Unity】Androidのテキスト読み上げ(TextToSpeech)を使う
【Unity】Androidでカスタマイズしたダイアログを動的生成できるプラグインを作ってみた
【Unity】Androidでスライダーで設定を変更するダイアログを使う
【Unity】Androidでスイッチで設定を変更するダイアログを使う
【Unity】Androidの選択ダイアログを使う
【Unity】Androidで日付・時刻選択ダイアログ(DatePicker, TimePicker)を使う
【Unity】Androidで数値・半角英数・パスワード入力ダイアログを使う
【Unity】Androidでテキスト入力ダイアログを使う


このコンテンツの一部には『ユニティちゃんライセンス』で許諾されたアセットが使用されています。
Portions of this work are licensed under Unity-Chan License


category: Unity

thread: ゲーム開発

janre: コンピュータ

tag: Unityライブラリ  Unityプラグイン  音声認識  ユニティちゃん 
tb: 0   cm: --

【Unity】Androidのハードウェア音量操作・ハードウェアキーの無効化をする  


 これは音量操作のプラグインのアップデート版となる。以前の記事にはプラグインの内部的なコード(Java)や仕様説明を書いたので、今回は Unity 側のコードやプレファブの使い方などを中心に書いておこう。プラグイン自体のセットアップからはじめる場合は、以前の記事を参照して欲しい。

>>プラグイン&サンプルをダウンロード
(Google Drive を利用。画面右上にあるダウンロードアイコンを押す)



(※) Unity 5.6.3p1 / AndroidStudio 2.3.3 / Windows10(x64) / Galaxy S7 Edge (Android 7.0) で確認



■ハードウェア音量操作する際の AndroidManifest.xml について

 プラグインのセットアップにも書いてあるが、ここではもう少し詳細に解説しておこう。ハードウェア音量ボタンを押したときのイベントを取得する際には Unity で通常使われるアクティビティ「UnityPlayerActivity」をオーバーライドした、「HardVolKeyOnUnityPlayerActivity」(ハードウェア音量イベント取得用アクティビティ:プラグイン内に入っている)または「FullPluginOnUnityPlayerActivity」(プラグイン機能のすべてが入っている)を使う必要がある。これらのアクティビティ(Activity)はこのプラグイン独自のアクティビティで、ハードウェアキーのイベントを監視するコードが含まれている(初期のバージョンではあるが、Java コードは以前の記事に掲載してある)。インポートした「Assets/Plugins/Android/」にはマニフェストファイルのテンプレとして「AndroidManifest-HardVolKey~.xml」または「AndroidManifest-FullPlugin~.xml」が含まれているので、これらの中から適切なものを選んで(「縦置き・横置き」とか「API Level」とか)、「AndroidManifest.xml」にリネームしてビルドすることで利用することが可能になる。音量の取得・増減だけなら特別な権限はいらないので、使用するアクティビティさえ指定すれば、独自に書き換えても構わない。


 なお、ハードウェアボタンのイベントを受け取らず、Unity から一方的に音量を設定するだけなら、オーバーライドしたアクティビティを使う必要はない。具体的には例えば、後述する「GetMediaVolume()」「SetMediaVolume()」「AddMediaVolume()」(ハードウェア音量[メディア音量のみ]の取得と設定)のみの使用なら、これらマニフェストファイルは必要ない(Unity がデフォルトのマニフェストファイルを用意してくれる)。

(※) 独自のマニフェストファイルでビルドすると警告「Unable to find unity activity in manifest. You need to make sure orientation attribute is set to sensorPortrait manually.」が出るが、「UnityPlayerActivity」以外のアクティビティを使うと出るものなので気にしなくて良い(orientation=画面回転はUnity側のアプリの設定に合わせた方が良い)。



■HardVolumeController(プレファブ)の使い方

 サンプルシーンにも含まれている「HardVolumeController.prefab」はスクリプト「HardVolumeController.cs」をアタッチしたハードウェア音量操作をするプレファブである。同じように「HardVolumeControllerWithToast.prefab」「HardVolumeControllerWithToast.cs」というものも入っているが、これらは音量が操作されたときにプラグインでトースト(Toast)で現在音量を表示する機能を追加しただけのものである。つまり音量の表示方法以外は内容的に変わらないので、例ではどちらの場合でも置き換えて考えて欲しい。

 端末と連携してこれらプレファブを利用するには、オプションの設定とコールバックを上手く使う必要がある。少しその辺は紛らわしいので、その解説と設定例などをなるべく詳細に書いておこう。


●オプション設定やコールバックの説明
Enable Hard Keyこのスクリプトからは常にハードウェアの音量操作はできるのだが(Unity → Android)、端末のハードボタンを押したときにもスクリプトを利用するか否かの設定(Android → Unity[→何らかの動作])をするオプションとなる。別の言い方をすれば、「端末のハードボタンを押したときのイベントを受け取るか否か」と同義だ。端末のハードボタンと連携したいときはオンにする必要がある。オンにしたとき、端末のハードボタンで音量大を押すと Android → Unity へ "VolumeUp" メッセージ(文字列)が送られ、コールバック:OnHardVolumeKeyUp() が呼ばれる。同じようにハードボタンで音量小を押したときは Android → Unity へ "VolumeDown" メッセージが送られ、コールバック:OnHardVolumeKeyDown() が呼ばれる。インスペクタでこれらコールバックに何らかのメソッドを登録しておけば、端末のハードボタンを操作したとき独自のアクションが設定できる。オフにしたときは、端末のハードボタンのイベントを無視するので、端末側で操作したときの影響は受けない(端末での操作とは別々になる)。デフォルトはオフ(Unityでの操作、端末での操作は別々に行える)。
Hard Operation端末のハードボタンを押したとき、端末自身での音量操作をするか否かのオプション。オフにすると端末自身での音量操作は無効となり、Unity 側だけの音量操作となる。「Enable Hard Key」をオンにすることでハードボタン押下のイベントは受け取れるので、「Hard Operation=オフ+Enable Hard Key=オン」の組み合わせで「Android 端末で音量無効→イベントだけUnityで受け取る→コールバックでUIなどを表示→UnityからAndroidへ音量設定」のような流れを作ることで Unity 側でのハード音量操作を完全に制御できる。逆に「Hard Operation=オフ+Enable Hard Key=オフ」にするとユーザーは音量操作が全くできなくなってしまうので注意。デフォルトはオン(Android端末側でも音量操作は可能)。
Show UIUnity で音量操作を行ったとき、端末のシステムUIを表示するか否かのオプション。あくまで Unity 側からの操作のときのみなので、端末自身のハードボタンで操作したときには影響しない。
On Volume Called(int)
(コールバック)
音量の増減操作や現在の音量取得をしたときのコールバック。通常は UI などの呼び出しに使うと良い。「HardVolumeControllerWithToast」はこのコールバックでトースト(Toast)を呼び出すセットアップがされている。独自の UI などを作成したときはここにその表示メソッドを登録すれば良いだろう。引数の値(整数)は操作後の音量となる。
On Hard Key Volume Up
(コールバック)
端末のハードボタンで音量が上げられたときのコールバック。ハードボタン押下のイベントを受け取る必要があるので「Enable Hard Key=オン」である必要がある。「Hard Operation=オフ」のときは、端末自身で音量操作ができなくなるため、ここに音量アップのメソッドを登録すると良い(HardVolumeController.VolumeUp() でも良い)。「Hard Operation=オン」のときは、端末自身で音量操作ができるため、現在音量の表示だけで良いだろう(HardVolumeController.VolumeNow() 等)。逆にハードボタンを無視するならば登録する必要はない。
On Hard Key Volume Down
(コールバック)
端末のハードボタンで音量が下げられたときのコールバック。ハードボタン押下のイベントを受け取る必要があるので「Enable Hard Key=オン」である必要がある。「Hard Operation=オフ」のときは、端末自身で音量操作ができなくなるため、ここに音量アップのメソッドを登録すると良い(HardVolumeController.VolumeDown() でも良い)。「Hard Operation=オン」のときは、端末自身で音量操作ができるため、現在音量の表示だけで良いだろう(HardVolumeController.VolumeNow() 等)。逆にハードボタンを無視するならば登録する必要はない。




■HardVolumeController のセットアップ例

 言葉で説明すると少し難しく感じるので、簡単なセットアップ例を掲載しておこう。サンプルのシーンには微妙に異なったセットアップのプレファブが配置してあるので、動作確認して自分の使いたい機能に近いものを利用するのも良いだろう。

(例1)端末自身のハードボタン・Unity ともに音量操作をしたとき、端末のシステムUIとトースト(Toast)が表示されるセットアップ。
(※)サンプルのシーン「Assets/_Test/Scenes/PluginTest」に配置してある。


Enable Hard Key → ハードボタンのイベントを受け取る。
Hard Operation → 端末自身での音量操作も可能とする。
Show UI → Unity で音量操作をしたときも端末のシステムUIを表示する。
On Volume Called → Unity, 端末自身ともに音量操作したとき、トーストを表示する。
On Hard Key Volume Up →ハードボタンで音量を上げるイベントを受信したとき、現在音量を表示する(→トーストで表示される)。
On Hard Key Volume Down → ハードボタンで音量を下げるイベントを受信したとき、現在音量を表示する(→トーストで表示される)。



(例2)端末のハードボタンが押されたとき、Unity で独自の UI にて現在音量を表示し音量操作をする。また端末のシステムUIは表示しないセットアップ。
(※)サンプルのシーン「Assets/_Test/Scenes/DialogExTest」に配置してある。


(※)「VolumeUI」は独自のUI(uGUI)

Enable Hard Key → ハードボタンのイベントを受け取る。
Hard Operation → 端末自身での音量操作を無効化する(システムUIを表示させない)。
Show UI → Unity で音量操作をしたときに端末のシステムUIを表示しない。
On Volume Called → Unity, 端末自身ともに音量操作したとき、独自UIを表示する。
On Hard Key Volume Up → ハードボタンで音量を上げるイベントを受信したとき、Unity で端末の音量を上げる。
On Hard Key Volume Down → ハードボタンで音量を下げるイベントを受信したとき、Unity で端末の音量を下げる。




■スクリプトでハードウェア音量操作・取得などをする [メディア音量のみ]

 以前の記事にもコードは掲載してあるが、ここでは改めて機能ごとに分けて書いておこう。

●ハードウェア音量を取得する [メディア音量のみ]
using FantomLib;

#if UNITY_ANDROID && !UNITY_EDITOR
int vol = AndroidPlugin.GetMediaVolume(); //現在音量の取得
int max = AndroidPlugin.GetMediaMaxVolume(); //最大音量の取得
#endif

//HardVolumeController を使用するなら(内容は全く同じ)
HardVolumeController hardVolumeController = FindObjectOfType<HardVolumeController>();
int vol = hardVolumeController.volume; //現在音量の取得
int max = hardVolumeController.maxVolume; //最大音量の取得


●ハードウェア音量を設定・増減をする [メディア音量のみ]
using FantomLib;

#if UNITY_ANDROID && !UNITY_EDITOR
int vol = AndroidPlugin.SetMediaVolume(4, showUI); //音量=4
vol = AndroidPlugin.SetMediaVolume(0, showUI); //ミュート:音量=0
vol = AndroidPlugin.AddMediaVolume(1, showUI); //現在の音量+1
vol = AndroidPlugin.AddMediaVolume(-1, showUI); //現在の音量-1
#endif

//HardVolumeController を使用するなら(内容は全く同じ)
HardVolumeController hardVolumeController = FindObjectOfType<HardVolumeController>();
hardVolumeController.volume = 4; //音量=4
hardVolumeController.VolumeMute(); //ミュート:音量=0
hardVolumeController.VolumeUp(); //現在の音量+1
hardVolumeController.VolumeDown(); //現在の音量-1


●ハードウェアボタン押下による、端末自身での音量操作を有効/無効化する
using FantomLib;

#if UNITY_ANDROID && !UNITY_EDITOR
AndroidPlugin.HardKey.SetVolumeOperation(true); //端末自身での音量操作が可能
AndroidPlugin.HardKey.SetVolumeOperation(false); //端末自身での音量操作を無効化
#endif

//HardVolumeController を使用するなら(内容は全く同じ)
HardVolumeController hardVolumeController = FindObjectOfType<HardVolumeController>();
hardVolumeController.HardOperation = true; //端末自身での音量操作が可能
hardVolumeController.HardOperation = false; //端末自身での音量操作を無効化


●ハードウェアボタン押下のイベントを取得するリスナーを登録する
using FantomLib;

void OnEnable() //MonoBehaviour イベント
{
#if UNITY_ANDROID && !UNITY_EDITOR
//ハードウェア音量キーのリスナー登録("HardVolumeKeyChange"はコールバックハンドラ)
AndroidPlugin.HardKey.SetKeyVolumeUpListener(gameObject.name, "HardVolumeKeyChange", "VolumeUp");
AndroidPlugin.HardKey.SetKeyVolumeDownListener(gameObject.name, "HardVolumeKeyChange", "VolumeDown");
#endif
}

void OnDisable() //MonoBehaviour イベント
{
#if UNITY_ANDROID && !UNITY_EDITOR
//ハードウェア音量キーの全リスナー解除
AndroidPlugin.HardKey.RemoveAllListeners();
#endif
}

//ハードウェア音量キーのイベントハンドラ(Android ネイティブから呼ばれる)
void HardVolumeKeyChange(string message)
{
if (message == "VolumeUp")
{
//音量を上げる操作されたときの処理
}
else if (message == "VolumeDown")
{
//音量を下げる操作されたときの処理
}
}

//※内容は「HardVolumeController.cs」と同じもの。

 サンプルコードは「Assets/FantomLib/Scripts/Module/HardVolumeController.cs」にまとまっているので適当にコピペしたり、継承して新しいクラスを作るのも良いだろう。またプレファブ「Assets/FantomLib/Prefabs/System/HardVolumeControllerWithToast」にはトースト(Toast)で操作したときの音量を表示できるようにセットアップしてある。少し改造すればVR(Cardboard/ハコスコ)にも応用できるだろう。シーン「PluginTest」「DialogTest」「DialogExTest」にはそれぞれ異なったセットアップのプレファブが配置がされているので、自分の好みに合ったものを利用するのも良いだろう。

(※) Unity 2017.2.0f3 でビルド / Galaxy S7 Edge (Android 7.0) で確認

(その他動作確認した機器)



(関連記事)
【Unity】Androidのトーストやダイアログ、通知、音声認識、ハード音量操作など基本的な機能を使えるプラグインを作ってみた
【Unity】Androidでカスタマイズしたダイアログを動的生成できるプラグインを作ってみた
【Unity】Androidでスライダーで設定を変更するダイアログを使う
【Unity】Androidでスイッチで設定を変更するダイアログを使う
【Unity】Androidの選択ダイアログを使う
【Unity】Androidで日付・時刻選択ダイアログ(DatePicker, TimePicker)を使う
【Unity】Androidで数値・半角英数・パスワード入力ダイアログを使う
【Unity】Androidでテキスト入力ダイアログを使う
【Unity】Androidのテキスト読み上げ(TextToSpeech)を使う
【Android】【Java】AlertDialog を使ってみる


category: Unity

thread: ゲーム開発

janre: コンピュータ

tag: Unityライブラリ  Unityプラグイン  Cardboard  VR 
tb: 0   cm: --
IS<インフィニット・ストラトス> アーキタイプ・ブレイカー
キルドヤ


プロフィール

Twitter

検索フォーム

全記事一覧

カテゴリ

ユーザータグ

最新記事

リンク

PR

▲ Pagetop