2019年3月 – kandy codings開発ブログ

2019年3月24日2019年3月28日

【Unity】インスペクタに編集不可のパラメータを表示してみた

編集不可のパラメータをインスペクターに表示したいという機会があり、PropertyAttribute、PropertyDrawerを継承して処理を書くやり方があったので試しにやってみました。

環境

Unity2018.3.7f1
MacBookPro Mojave v10.14.3

実装

NonEditableAttribute.csというスクリプトを作成して、PropertyAttributeとPropertyDrawerクラスを継承したクラスを定義しました。（ReadOnlyAttributeという名前にしたかったのですが、Unity側に既にあった為、被らない名前にしました。）

using UnityEngine;
#if UNITY_EDITOR
using UnityEditor;
#endif

public sealed class NonEditableAttribute : PropertyAttribute{}

#if UNITY_EDITOR
[CustomPropertyDrawer( typeof(NonEditableAttribute) )]
public sealed class NonEditableAttributeDrawer : PropertyDrawer
{
    public override float GetPropertyHeight ( SerializedProperty property, GUIContent label )
    {
        return EditorGUI.GetPropertyHeight( property, label, true );
    }

    public override void OnGUI ( Rect position, SerializedProperty property, GUIContent label )
    {
    	GUI.enabled = false;
    	EditorGUI.PropertyField( position, property, label, true );
    	GUI.enabled = true;
    }
}
#endif

using UnityEngine;

#if UNITY_EDITOR

using UnityEditor;

#endif

public sealed class NonEditableAttribute : PropertyAttribute{}

#if UNITY_EDITOR

[CustomPropertyDrawer( typeof(NonEditableAttribute) )]

public sealed class NonEditableAttributeDrawer : PropertyDrawer

{

public override float GetPropertyHeight ( SerializedProperty property, GUIContent label )

{

return EditorGUI.GetPropertyHeight( property, label, true );

}

public override void OnGUI ( Rect position, SerializedProperty property, GUIContent label )

{

GUI.enabled = false;

EditorGUI.PropertyField( position, property, label, true );

GUI.enabled = true;

}

#endif

他サイトでは、PropertyDrawerクラスを継承しているクラスはEditorフォルダ内に入れていましたが、#if UNITY_EDITORで囲う形にするとEditorフォルダにいれなくても使えた為、こういう形にしてみました。

使い方はこちら

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class NonEditableAttributeTest : MonoBehaviour
{
	[SerializeField,NonEditable]
	private int m_iValue = 10;

    [SerializeField,NonEditable]
    private float m_fValue = 0.5f;

    [SerializeField,NonEditable]
    private string m_strValue = "NonEditable";

    [SerializeField,NonEditable]
    private List&lt;int> m_iValues = new List&lt;int>() { 1, 2, 3, 4, 5 };
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class NonEditableAttributeTest : MonoBehaviour

{

[SerializeField,NonEditable]

private int m_iValue = 10;

[SerializeField,NonEditable]

private float m_fValue = 0.5f;

[SerializeField,NonEditable]

private string m_strValue = "NonEditable";

[SerializeField,NonEditable]

private List<int> m_iValues = new List<int>() { 1, 2, 3, 4, 5 };

}

インスペクタ表示はこんな感じに！

ListのSizeは編集できてしまうようで、ここも編集出来ない形にできると良かったのですが・・・。

まとめ

値を確認したいだけの時に、編集不可にして表示するととても便利でした。他にも色々できそうなのでインスペクタ表示についても色々調べていこうと思います。

参考url

http://ponkotsu-hiyorin.hateblo.jp/entry/2015/10/20/003042

2019年3月17日2019年3月18日

【Unity】Animatorに設定されているlayerとstateを実行時に取得してみた

アニメーションビューワーの用なものを作ろうと思った時に、実行時にlayerやstate名が取得できると便利だなと思って調べてみると、UnityEditor.Animations.AnimatorControllerというものがあったので使ってみました！

環境

Unity2018.3.7f1
MacBookPro Mojave v10.14.3

実装

AnimatorのruntimeAnimatorControllerをUnityEditor.Animations.AnimatorControllerでキャストしてやると、情報が取れるようです。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class AnimatorTest : MonoBehaviour
{
	[SerializeField]
	private Animator m_animator = null;

	private void Start () 
	{
		var runtimeController = m_animator.runtimeAnimatorController;

		// UnityEditorのAnimatorControllerでキャストする .
        var controller = runtimeController as UnityEditor.Animations.AnimatorController;
        foreach ( var layer in controller.layers )
        {
            UnityEditor.Animations.AnimatorStateMachine stateMachine = layer.stateMachine;

            Debug.Log( "[" + layer.name + "]" );
            foreach ( var state in stateMachine.states )
            {
            	Debug.Log( " " + state.state.name );
            }
        }
	}
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class AnimatorTest : MonoBehaviour

{

[SerializeField]

private Animator m_animator = null;

private void Start ()

{

var runtimeController = m_animator.runtimeAnimatorController;

// UnityEditorのAnimatorControllerでキャストする .

var controller = runtimeController as UnityEditor.Animations.AnimatorController;

foreach ( var layer in controller.layers )

{

UnityEditor.Animations.AnimatorStateMachine stateMachine = layer.stateMachine;

Debug.Log( "[" + layer.name + "]" );

foreach ( var state in stateMachine.states )

{

Debug.Log( " " + state.state.name );

}

デバッグ出力した内容を確認してみると、意図した情報が取れていました。この処理とUnityちゃんを使ってUIからlayerとstateを選択できるものを作ってみました。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
using UnityEditor;

public class AnimatorUI : MonoBehaviour {

	[SerializeField]
	private Animator m_animator = null;

	[SerializeField]
	private Dropdown m_ddLayer = null;

	[SerializeField]
	private Dropdown m_ddState = null;

	private Dictionary&lt;string,List&lt;string>> m_dicState = new Dictionary&lt;string,List&lt;string>>();

	private void Start () 
	{
		m_ddLayer.ClearOptions();
		m_ddState.ClearOptions();

		var runtimeController = m_animator.runtimeAnimatorController;
		var layerList         = new List&lt;string>();
        var controller        = runtimeController as UnityEditor.Animations.AnimatorController;
        foreach ( var layer in controller.layers )
        {
            UnityEditor.Animations.AnimatorStateMachine stateMachine = layer.stateMachine;

            layerList.Add( layer.name );

            List&lt;string> stateList = new List&lt;string>();
            foreach ( var state in stateMachine.states )
            {
                stateList.Add( state.state.name );
            }

            m_dicState[layer.name] = stateList;
        }

        if ( layerList.Count > 0 )
        {
        	m_ddLayer.AddOptions( layerList );
        	ChangeLayer( layerList[0] );
        }
	}

	private void ChangeLayer ( string layer )
	{
		m_ddState.value = 0;
		m_ddState.ClearOptions();
		m_ddState.AddOptions( m_dicState[layer] );
	}

	public void OnChangeDropdownLayer ()
	{
		if ( m_ddLayer.options.Count > 0 )
		{
			ChangeLayer( m_ddLayer.options[m_ddLayer.value].text );
		}
	}

	public void OnClickPlay ()
	{
		if ( m_ddState.options.Count &lt;= 0 || m_ddLayer.options.Count &lt;= 0 )
		{
			return;
		}

		var stateNmae = m_ddState.options[m_ddState.value].text;
		var layer     = m_animator.GetLayerIndex( m_ddLayer.options[m_ddLayer.value].text );
		m_animator.Play( stateNmae, layer );
	}
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.UI;

using UnityEditor;

public class AnimatorUI : MonoBehaviour {

[SerializeField]

private Animator m_animator = null;

[SerializeField]

private Dropdown m_ddLayer = null;

[SerializeField]

private Dropdown m_ddState = null;

private Dictionary<string,List<string>> m_dicState = new Dictionary<string,List<string>>();

private void Start ()

{

m_ddLayer.ClearOptions();

m_ddState.ClearOptions();

var runtimeController = m_animator.runtimeAnimatorController;

var layerList = new List<string>();

var controller = runtimeController as UnityEditor.Animations.AnimatorController;

foreach ( var layer in controller.layers )

{

UnityEditor.Animations.AnimatorStateMachine stateMachine = layer.stateMachine;

layerList.Add( layer.name );

List<string> stateList = new List<string>();

foreach ( var state in stateMachine.states )

{

stateList.Add( state.state.name );

}

m_dicState[layer.name] = stateList;

}

if ( layerList.Count > 0 )

{

m_ddLayer.AddOptions( layerList );

ChangeLayer( layerList[0] );

}

private void ChangeLayer ( string layer )

{

m_ddState.value = 0;

m_ddState.ClearOptions();

m_ddState.AddOptions( m_dicState[layer] );

}

public void OnChangeDropdownLayer ()

{

if ( m_ddLayer.options.Count > 0 )

{

ChangeLayer( m_ddLayer.options[m_ddLayer.value].text );

}

public void OnClickPlay ()

{

if ( m_ddState.options.Count <= 0 || m_ddLayer.options.Count <= 0 )

{

return;

}

var stateNmae = m_ddState.options[m_ddState.value].text;

var layer = m_animator.GetLayerIndex( m_ddLayer.options[m_ddLayer.value].text );

m_animator.Play( stateNmae, layer );

}

実行したものがこちらです。

まとめ

今回使った、UnityEditor.Animations.AnimatorControllerはエディタでしか使えませんが、layer、state名を調べたり手動で書いてアニメーション切り替えをしたりしなくてもいいのはとても便利でした。他にも機能があるようなので別の機会に試してみたいと思います！

参考url

https://docs.unity3d.com/ja/2017.4/ScriptReference/Animations.AnimatorController.html

2019年3月10日2019年3月18日

【Unity】Handheld.Vibrateを使ってみた

スマホのバイブレーション機能がUnityに用意されていたので、試しに使ってみました。

環境

Unity2018.3.7f1
MacBookPro Mojave v10.14.3
iPhone SE OS11.4.1

実装

調べてみると呼び出し自体はすごくシンプルで、Handheld.Vibrate関数を呼び出すだけでした。ソースはこんな感じに

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class VibrationTest : MonoBehaviour
{
	private void Start ()
	{
		Handheld.Vibrate();
	}
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class VibrationTest : MonoBehaviour

{

private void Start ()

{

Handheld.Vibrate();

}

とてもシンプルですね！ただ、用意されている関数はこれだけの為、強弱や回数、振動しているかどうかというのは取得できないようです。他サイトで調べてみると、自分でネイティブ実装すればできるようですね。

これだけだと面白くないので、再生回数、再生秒数、終了コールバック受け取りできるような形にしたクラスを作ってみました！Vibrationのstatic関数にアクセスしたタイミングで破棄されないGameObjectを生成し振動処理を行う形になっています。

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public static class Vibration {

	public enum ResultType
	{
		Interruption = 0,	// 中断 .
		End,				// 終了 .
	}

	public struct Result 
	{
		public ResultType Type { get; set; }
		public uint 	  Uid { get; set; }
	}

	private class Vibrate : MonoBehaviour
	{
		// １回の振動が約0.5秒くらいの為、再生時間を0.5秒として設定 .
		private readonly WaitForSeconds PlaybackSeconds = new WaitForSeconds( 0.5f );
		private uint 			m_uid = 0;
		private Coroutine 		m_coroutine = null;
		private Action&lt;Result>  m_callback = null;

		public bool IsExecuting ()
		{
			return m_coroutine != null;
		}

		public bool IsExecuting ( uint uid )
		{
			return !IsExecuting() ? false : m_uid==uid;
		}

		public uint PlayCount ( int count, Action&lt;Result> callback )
		{
			return OnPlay( OnPlayCount( count ), callback );
		}

		public uint PlaySeconds ( float seconds, Action&lt;Result> callback  )
		{
			return OnPlay( OnPlaySeconds( seconds ), callback );
		}

		public void Stop ()
		{
			OnStop( ResultType.Interruption );
		}

		public void Stop ( uint uid )
		{
			if ( IsExecuting( uid ) )
			{
				OnStop( ResultType.Interruption );
			}
		}

		private uint OnPlay ( IEnumerator enumerator, Action&lt;Result> callback )
		{
			OnStop( ResultType.Interruption );
			++m_uid;
			m_callback  = callback;
			m_coroutine = StartCoroutine( enumerator );
			return m_uid;
		}

		private IEnumerator OnPlayCount ( int count )
		{
			int nowCount = 0;
			while ( nowCount &lt; count )
			{
				Handheld.Vibrate();
				yield return PlaybackSeconds;
				++nowCount;
			}

			OnStop( ResultType.End );
		}

		private IEnumerator OnPlaySeconds ( float seconds )
		{
			float now = Time.realtimeSinceStartup;

			while ( (Time.realtimeSinceStartup-now) &lt; seconds )
			{
				Handheld.Vibrate();
				yield return PlaybackSeconds;
			}

			OnStop( ResultType.End );
		}

		private void OnStop ( ResultType type )
		{
			if ( m_coroutine != null )
			{
				if ( m_callback != null )
				{
					Result result;
					result.Uid  = m_uid;
					result.Type = type;
					m_callback( result );
					m_callback = null;
				}

				StopCoroutine( m_coroutine );
				m_coroutine = null;
			}
		}
	}

	private static Vibrate s_instance = null;

	static Vibration ()
	{
		GameObject go = new GameObject( "Vibration" );
		s_instance = go.AddComponent&lt;Vibrate>();
		GameObject.DontDestroyOnLoad( go );
	}

	public static bool IsEnabled ()
	{
		return SystemInfo.supportsVibration;
	}

	public static bool IsExecuting ()
	{
		return s_instance.IsExecuting();
	}

	public static bool IsExecuting ( uint uid )
	{
		return s_instance.IsExecuting( uid );	
	}

	public static uint PlayCount ( int count, Action&lt;Result> callback = null )
	{
		return s_instance.PlayCount( count, callback );
	}

	public static uint PlaySeconds ( float seconds, Action&lt;Result> callback = null  )
	{
		return s_instance.PlaySeconds( seconds, callback );
	}

	public static void Stop ()
	{
		s_instance.Stop();
	}

	public static void Stop ( uint uid )
	{
		s_instance.Stop( uid );
	}
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

using System;

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public static class Vibration {

public enum ResultType

{

Interruption = 0, // 中断 .

End, // 終了 .

}

public struct Result

{

public ResultType Type { get; set; }

public uint Uid { get; set; }

}

private class Vibrate : MonoBehaviour

{

// １回の振動が約0.5秒くらいの為、再生時間を0.5秒として設定 .

private readonly WaitForSeconds PlaybackSeconds = new WaitForSeconds( 0.5f );

private uint m_uid = 0;

private Coroutine m_coroutine = null;

private Action<Result> m_callback = null;

public bool IsExecuting ()

{

return m_coroutine != null;

}

public bool IsExecuting ( uint uid )

{

return !IsExecuting() ? false : m_uid==uid;

}

public uint PlayCount ( int count, Action<Result> callback )

{

return OnPlay( OnPlayCount( count ), callback );

}

public uint PlaySeconds ( float seconds, Action<Result> callback )

{

return OnPlay( OnPlaySeconds( seconds ), callback );

}

public void Stop ()

{

OnStop( ResultType.Interruption );

}

public void Stop ( uint uid )

{

if ( IsExecuting( uid ) )

{

OnStop( ResultType.Interruption );

}

private uint OnPlay ( IEnumerator enumerator, Action<Result> callback )

{

OnStop( ResultType.Interruption );

++m_uid;

m_callback = callback;

m_coroutine = StartCoroutine( enumerator );

return m_uid;

}

private IEnumerator OnPlayCount ( int count )

{

int nowCount = 0;

while ( nowCount < count )

{

Handheld.Vibrate();

yield return PlaybackSeconds;

++nowCount;

}

OnStop( ResultType.End );

}

private IEnumerator OnPlaySeconds ( float seconds )

{

float now = Time.realtimeSinceStartup;

while ( (Time.realtimeSinceStartup-now) < seconds )

{

Handheld.Vibrate();

yield return PlaybackSeconds;

}

OnStop( ResultType.End );

}

private void OnStop ( ResultType type )

{

if ( m_coroutine != null )

{

if ( m_callback != null )

{

Result result;

result.Uid = m_uid;

result.Type = type;

m_callback( result );

m_callback = null;

}

StopCoroutine( m_coroutine );

m_coroutine = null;

}

private static Vibrate s_instance = null;

static Vibration ()

{

GameObject go = new GameObject( "Vibration" );

s_instance = go.AddComponent<Vibrate>();

GameObject.DontDestroyOnLoad( go );

}

public static bool IsEnabled ()

{

return SystemInfo.supportsVibration;

}

public static bool IsExecuting ()

{

return s_instance.IsExecuting();

}

public static bool IsExecuting ( uint uid )

{

return s_instance.IsExecuting( uid );

}

public static uint PlayCount ( int count, Action<Result> callback = null )

{

return s_instance.PlayCount( count, callback );

}

public static uint PlaySeconds ( float seconds, Action<Result> callback = null )

{

return s_instance.PlaySeconds( seconds, callback );

}

public static void Stop ()

{

s_instance.Stop();

}

public static void Stop ( uint uid )

{

s_instance.Stop( uid );

}

１回の振動を計測したら、約0.5秒くらいだったので、再生時間を0.5秒として扱ってみました。使い方はこちらです。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class VibrationTest : MonoBehaviour
{
	private void Start ()
	{
		// ３回振動させる
		Vibration.PlayCount( 3, OnVibrationEnd );
	}

	private void OnVibrationEnd ( Vibration.Result result )
	{
		if ( result.Type == Vibration.ResultType.Interruption )
		{
			Debug.Log( result.Uid + ":中断" );
		}
		else
		{
			Debug.Log( result.Uid + ":終了" );
		}
	}
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

public class VibrationTest : MonoBehaviour

{

private void Start ()

{

// ３回振動させる

Vibration.PlayCount( 3, OnVibrationEnd );

}

private void OnVibrationEnd ( Vibration.Result result )

{

if ( result.Type == Vibration.ResultType.Interruption )

{

Debug.Log( result.Uid + ":中断" );

}

else

{

Debug.Log( result.Uid + ":終了" );

}

まとめ

凝ったことをしなければ、数分で実装する事ができました！振動の強弱や振動終わりを感知するというのもやってみたいので、別の機会で試しみて記事に書こうと思います！

参考url

https://docs.unity3d.com/jp/460/ScriptReference/Handheld.Vibrate.html
https://qiita.com/DURIAN_JADE/items/3fdddb4ad19658f50539

2019年3月3日2019年3月5日

【Unity】logEnabledを使ってLog出力を無効化してみた

開発をしている時だけ、ログ出力をさせたい！という事は多々あるかなと思いますが、その際に手軽にできるものとして、logEnabledをfalseにする方法があります。ただ、これはランタイムで設定できる為、ログ出力がされないだけで、関数に書いている処理は残っているのではないかな？と思ったので今回はそれを検証してみました。

環境

Unity2018.3.0f2
MacBookPro Mojave v10.14.3

実装

ボタンを押すと、Log関数内で変数をインクリメントする関数を呼ぶという処理を作ってみました。スクリプトはこんな感じに。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;

public class LogTest : MonoBehaviour
{
	[SerializeField]
	private Text m_text = null;

	private int m_count = 0;

    private void Start()
    {
    }

    private int CountUp ()
    {
    	++m_count;
    	return m_count;
    }

    public void OnClickButton ()
    {
		Debug.Log( "Count:" + CountUp() );
		m_text.text = "Count:" + m_count;
    }
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.UI;

public class LogTest : MonoBehaviour

{

[SerializeField]

private Text m_text = null;

private int m_count = 0;

private void Start()

{

}

private int CountUp ()

{

++m_count;

return m_count;

}

public void OnClickButton ()

{

Debug.Log( "Count:" + CountUp() );

m_text.text = "Count:" + m_count;

}

実行して、ボタンを押した際のキャプチャがこちら

次にStart関数内でlogEnabledをfalse設定にして試したものがこちらです。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;

public class LogTest : MonoBehaviour
{
	[SerializeField]
	private Text m_text = null;

	private int m_count = 0;

    private void Start()
    {
        Debug.unityLogger.logEnabled = false;
    }

    private int CountUp ()
    {
    	++m_count;
    	return m_count;
    }

    public void OnClickButton ()
    {
		Debug.Log( "Count:" + CountUp() );
		m_text.text = "Count:" + m_count;
    }
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using UnityEngine.UI;

public class LogTest : MonoBehaviour

{

[SerializeField]

private Text m_text = null;

private int m_count = 0;

private void Start()

{

Debug.unityLogger.logEnabled = false;

}

private int CountUp ()

{

++m_count;

return m_count;

}

public void OnClickButton ()

{

Debug.Log( "Count:" + CountUp() );

m_text.text = "Count:" + m_count;

}

実行して、ボタンを押してみたキャプチャがこちらです。

ログ出力はされなくなりましたが、Count表示の数は増えていきました。Debug.Log関数内に記載している処理は実行されてしまうというのがわかります。ログ出力にこういう形で処理を書く人は少ないと思いますが、処理自体が実行される為、ボトルネックになる可能性はあります。そこでConditionalを使ってみたらどうかなと思い、下記スクリプトを追加してみました。

※PlayerSettingsのScripting Defines SymbolsにENABLE_LOGGINGを記述するとLog出力されます。

using UnityEngine;

public class Debug : MonoBehaviour
{
	[RuntimeInitializeOnLoadMethod]
	private static void OnRuntimeMethodLoad ()
	{
#if ENABLE_LOGGING
		UnityEngine.Debug.unityLogger.logEnabled = true;
#else
		UnityEngine.Debug.unityLogger.logEnabled = false;
#endif
	}

	[System.Diagnostics.Conditional("ENABLE_LOGGING")]
	public static void Log ( object message )
	{
		UnityEngine.Debug.Log(message);
	}
}

using UnityEngine;

public class Debug : MonoBehaviour

{

[RuntimeInitializeOnLoadMethod]

private static void OnRuntimeMethodLoad ()

{

#if ENABLE_LOGGING

UnityEngine.Debug.unityLogger.logEnabled = true;

#else

UnityEngine.Debug.unityLogger.logEnabled = false;

#endif

}

[System.Diagnostics.Conditional("ENABLE_LOGGING")]

public static void Log ( object message )

{

UnityEngine.Debug.Log(message);

}

実行して、ボタンを押してみたキャプチャがこちらです。

まとめ

ログ出力を手っ取り早く無くしたい場合は、logEnabledをfalseにすれば簡単にできてしまうのでとても便利ですね。Log関数内の処理もなくしたい場合は、少し手間ですがConditionalを使ってUnityが提供している関数を全て定義しなおしてしまえばよさそうですね！

2019年3月
月	火	水	木	金	土	日
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31