Unityの衝突判定を数値化して不安定な接触を安定化する(UniRx編)
本記事で紹介する接触判定クラスはGithub (https://github.com/nyanya-nnana/CollisionDetector)にソースをあげてあります。 よければ使用してみてください。使用するにはUniRxが必要です。UniRxを使用しないバージョンはコチラで紹介しています。 もし要望等あればお気軽に。
※ローパスフィルタの数式のと
が逆になっていたので修正しました(2017/12/03)
手っ取り早く使いたいという方は次の手順をどうぞ。
- UniRxをAsset Store (https://www.assetstore.unity3d.com/jp/#!/content/17276)からインポート
- CollisionDetectorコンポーネントを接触判定したいGameObjectにアタッチ
- 接触対象のタグをチェックする場合はCheckTargetTagをtrueにして対象のタグをTargetTagで設定
- 接触判定を使用したいスクリプトでCollisionDetectorをGetComponent
- OnCollisionEnterSmoothedAsObservableでOnCollisionEnterでしたい処理を記述
- OnCollisionStaySmoothedAsObservableでOnCollisionStayでしたい処理を記述
- OnCollisionExitSmoothedAsObservableでOnCollisionExitでしたい処理を記述
目次はコチラ
接触判定が不安定になる要因
あるゲームオブジェクトに別のゲームオブジェクトが接触が始まった時にはMonobehaviourのOnCollisionEnterを使ってその時の処理を書くと思います。 接触中の処理も同様にOnCollisionStayを使うと思います。
でも、接触してそうなのにOnCollisionEnterとOnCollisionExitを繰り返していて安定しない、そんなときがあると思います。
原因はゲームオブジェクトが衝突が繰り返されるからです。相手のゲームオブジェクトに近づいて、跳ね返って、力がかかってるからまた近づいて、これの繰り返しが原因です。
今回紹介したいのは、そういうことをしなくても衝突判定にちょっとフィルタをはさんであげればOnCollisionのイベントだけで案外安定してとれるんだよってお話です。
接触判定を安定させる原理
この項は数式が苦手な人は読み飛ばしちゃっても大丈夫です。 CollisionDetectorの実装はコチラ、使用方法はコチラ
ローパスフィルタ
接触判定の安定には1次のローパスフィルタというものを使用します。 式で表すとこんな感じ。
フィルタ処理した現在の接触判定が 、1サイクル前の接触判定が
、フィルタ処理していない生の接触判定が
です。
と、
のどちらを優先するか、定数
を使って決定します。
が大きいほど前の値を優先するので
が激しく変化していてもあまり変化しません。
定数はカットオフ周波数
とサンプリング周波数
というものを使って次のように表現します。
カットオフ周波数以上の速い動きに影響されなくなるって認識で概ね大丈夫です。
サンプリング周波数にはTime.fixedDeltaTimeが入ります。
具体的な値として
= 5Hzを入れて接触判定をとってみると次のようになります。
CollisionDetector - ローパスフィルタの効果
カットオフ周波数が低いと生の接触判定（緑色）が激しく変化しても水色の接触判定がゆるやかに追従しています。
これを使って接触判定の変化をマイルドにします。
ヒステリシス
ローパスフィルタを使うと接触判定の急激な変化をおさえられることがわかりました。
でも、それだけだと安定した接触判定は実現できません。
それはなぜかというと、次のようなことが起こるからです（ = 30Hz）。
接触していないときを0、しているときを1として、0.6以上で接触していると判断した場合の接触判定をしていますが、
0.6を上回ったり下回ったりして判定が安定しません。
そこでヒステリシスというものを用います。
CollisionDetectorクラスの実装
CollisionDetectorクラスの実装にはUniRxというライブラリを使用しています。
これを使うとイベントが起きたときの処理が簡潔に書けます。
CollisionDetectorクラスのソースコードはGithubのコチラをご覧ください。 長くなるので使用方法を知りたい方はコチラをどうぞ。
UniRxではイベントを通知するためのストリームのソースを作る方法がいくつかあります（コチラが参考になります）が、今回はSubjectとIObservableを使ってイベント通知を実装します。
// Subject：イベント発行 private Subject<Collision> _onCollisionEnterSubject = new Subject<Collision>(); private Subject<Collision> _onCollisionStaySbuject = new Subject<Collision>(); private Subject<Collision> _onCollisionExitSubject = new Subject<Collision>(); // IObservable：イベント購読 public IObservable<Collision> OnCollisionEnterSmoothedAsObservable { get { return _onCollisionEnterSubject; } } public IObservable<Collision> OnCollisionStaySmoothedAsObservable{ get { return _onCollisionStaySbuject; } } public IObservable<Collision> OnCollisionExitSmoothedAsObservable { get { return _onCollisionExitSubject; } }
SubjectはOnNextというメソッドを持っていてこれを実行すると対応するIObservableにイベントのメッセージが通知されます。
生の衝突判定とその時の衝突情報はOnCollisionEnter、Stay、Exitの処理中に更新して、これを使って衝突判定を数値化します。
// OnCollisionEnter this.OnCollisionEnterAsObservable() .Subscribe(other => { // タグが一致しない場合は何もしない if (checkOtherTag == false || other.gameObject.CompareTag(targetTag) == true) { _onCollisionRaw = true; _otherOnEnter = other; _otherOnStay = other; } }); // OnCollisionStay this.OnCollisionStayAsObservable() .Subscribe(other => { // タグが一致しない場合は何もしない if (checkOtherTag == false || other.gameObject.CompareTag(targetTag) == true) { _otherOnStay = other; } }); // OnCollisionExit this.OnCollisionExitAsObservable() .Subscribe(other => { // タグが一致しない場合は何もしない if (checkOtherTag == false || other.gameObject.CompareTag(targetTag) == true) { _onCollisionRaw = false; _otherOnExit = other; } });
OnCollisionEnterAsObservableはOnCollisionEnterをUniRx的に使えるようにしたもので、SubScribeのあとに続くブロックの中で行いたい処理を書きます。
Subscribe内ではラムダ式というものを使っていて、最初にotherと名前をつけた変数に衝突の情報が入っているようです。
衝突状態を1、していない状態を0としてFixedUpdate内で衝突判定を数値化します。_filterConstantはローパスフィルタの定数にあたります。
// 衝突しているかどうかを数値化。_filterConstantが大きいほど1サイクル前の状態を優先 _onCollisionFloat = (1.0f - _filterConstant) * onCollisionCurrent + _filterConstant * _onCollisionFloat;
次のように衝突判定の変化にヒステリシスを持たせて、
if (onCollisionPrevious) { // 1つ前のサイクルで衝突している場合、下限閾値を下回るまで状態を変化させない if (_onCollisionFloat <= detectionThresholdLower) _onCollision = false; else _onCollision = true; } else { // 1つ前のサイクルで衝突していない場合、上限閾値を上回るまで状態を変化させない if (_onCollisionFloat >= detectionThresholdUpper) _onCollision = true; else _onCollision = false; }
OnCollisionEnter、Stay、ExitになったときにOnNextを使って衝突情報を持ったイベントを通知します。
// OnCollisionEnterか、Stayか、Exitか判定 if (_onCollision == onCollisionPrevious) { _onCollisionEnter = false; _onCollisionExit = false; } else { if (_onCollision) { // OnNextでイベント通知 _onCollisionEnter = true; _onCollisionEnterSubject.OnNext(_otherOnEnter); } else { // OnNextでイベント通知 _onCollisionExit = true; _onCollisionExitSubject.OnNext(_otherOnExit); } } _onCollisionStay = _onCollision; // OnNextでイベント通知 if (_onCollisionStay) _onCollisionStaySbuject.OnNext(_otherOnStay);
以上がCollisionDetectorの主な処理です。
CollisionDetectorクラスの使用方法
UniRxの導入
CollisionDetectorはUniRxというライブラリを使用しています。 まずはそちらをUnity Asset StoreからインポートもしくはGithubから導入してください。
CollisionDetectorの設定
導入が終わったら、衝突判定をしたいGameObjectにCollisionDetectorをAddComponentしてください。 CollisionDetectorの設定項目は次の通りです。
Check Ohter Tag
衝突したGameObjectのタグをチェックするかしないか設定できます。
Target Tag
Check Other Tagがtrueの場合はここにTargetのタグを設定します。
Cut Off Frequency
衝突判定の安定度。低いほど判定の変化がゆっくりになります。
Detection Threshold Upper/Lower
衝突判定の閾値。2つの差が大きいほど変化しにくくなります。
衝突判定の利用
使用したいスクリプト内で
using NnanaSoft.CollisionDetector;
を宣言してください。 あとはStartかAwake内でGetComponentして
var SmoothedCollision = GetComponent<CollisionDetector>();
その中で行いたい処理を記述すればおっけーです。
// OnCollisionEnter SmoothedCollision.OnCollisionEnterSmoothedAsObservable .Subscribe(other => { // ここに処理を記述 Debug.Log("OnCollisionEnterSmoothed"); }); // OnCollisionStay SmoothedCollision.OnCollisionStaySmoothedAsObservable .Subscribe(other => { // ここに処理を記述 Debug.Log("OnCollisionStaySmoothed"); }); // OnCollisionExit SmoothedCollision.OnCollisionEnterSmoothedAsObservable .Subscribe(other => { // ここに処理を記述 Debug.Log("OnCollisionExitSmoothed"); });
使用するとこんな感じになります。
