HarmonicMotion
最終更新： 2020年1月30日
概要
HarmonicMotionは、指定したパラメータの値を周期的に反復させる機能です。
主に呼吸のように常に動作し続けるものに対して使用します。
HarmonicMotionの設定方法については こちら をご覧ください。
Cubism SDK for Unity におけるHarmonicMotionは2つの要素によって構成されています。
- 動作させるパラメータ指定用のコンポーネント
- 各パラメータの値を操作するコンポーネント
1. 動作させるパラメータ指定用のコンポーネント
HarmonicMotionに使用するパラメータを指定するには、CubismHarmonicMotionParameterを使用します。
CubismHarmonicMotionParameterはMonoBehaviourを継承したコンポーネントで、
[Prefabのルート]/Parameters/ 以下に配置されたGameObjectにアタッチして使用します。
これがアタッチされたGameObjectと同じIDのパラメータの値を周期的に動作させます。
CubismHarmonicMotionParameterには、5つの設定項目があります。
/// <summary>
/// Timescale channel.
/// </summary>
[SerializeField]
public int Channel;
/// <summary>
/// Motion direction.
/// </summary>
[SerializeField]
public CubismHarmonicMotionDirection Direction;
/// <summary>
/// Normalized origin of motion.
/// </summary>
/// <remarks>
/// The actual origin used for evaluating the motion depends limits of the <see cref="CubismParameter"/>.
/// </remarks>
[SerializeField, Range(0f, 1f)]
public float NormalizedOrigin = 0.5f;
/// <summary>
/// Normalized range of motion.
/// </summary>
/// <remarks>
/// The actual origin used for evaluating the motion depends limits of the <see cref="CubismParameter"/>.
/// </remarks>
[SerializeField, Range(0f, 1f)]
public float NormalizedRange = 0.5f;
/// <summary>
/// Duration of one motion cycle in seconds.
/// </summary>
[SerializeField, Range(0.01f, 10f)]
public float Duration = 3f;
- Channel
CubismHarmonicMotionControllerで設定された、正弦波の周期の倍率を指定します。
HarmonicMotionでは、一つのモデルに対して複数の周期を設定することができ、CubismHarmonicMotionControllerで設定することができます。
ここには、CubismHarmonicMotionController.ChannelTimescalesのインデックスを設定します。
- Direction
パラメータの中心を基準に、どの範囲で周期的に動作させるかを設定します。
設定項目は以下の3つです。
– Left : パラメータの中心から左半分の範囲だけで動作します。
– Right : パラメータの中心から右半分の範囲だけで動作します。
– Centric : パラメータの全体で動作します。
- NormalizedOrigin
Directionで基準にするパラメータの中心を設定します。
そのパラメータの最小値を0、最大値を1としたときの値を中心に設定します。
- NormalizedRange
NormalizedOriginで設定された値を中心から値を動作させる振幅を設定します。
そのパラメータの最小値を0、最大値を1としたときの、中心からの移動距離を設定します。
この値は、NormalizedOriginで設定された中心の位置からパラメータの最小値または最大値までの範囲だけ設定できます。
- Duration
パラメータの周期を調整します。
/// <summary>
/// Evaluates the parameter.
/// </summary>
/// <returns>Parameter value.</returns>
internal float Evaluate()
{
// Lazily initialize.
if (!IsInitialized)
{
Initialize();
}
// Restore origin and range.
var origin = MinimumValue + (NormalizedOrigin * ValueRange);
var range = NormalizedRange * ValueRange;
// Clamp the range so that it stays within the limits.
Clamp(ref origin, ref range);
// Return result.
return origin + (range * Mathf.Sin(T * (2 * Mathf.PI) / Duration));
}
/// <summary>
/// Clamp origin and range based on <see cref="Direction"/>.
/// </summary>
/// <param name="origin">Origin to clamp.</param>
/// <param name="range">Range to clamp.</param>
private void Clamp(ref float origin, ref float range)
{
switch (Direction)
{
case CubismHarmonicMotionDirection.Left:
{
if ((origin - range) >= MinimumValue)
{
range /= 2;
origin -= range;
}
else
{
range = (origin - MinimumValue) / 2f;
origin = MinimumValue + range;
NormalizedRange = (range * 2f)/ValueRange;
}
break;
}
case CubismHarmonicMotionDirection.Right:
{
if ((origin + range) <= MaximumValue)
{
range /= 2f;
origin += range;
}
else
{
range = (MaximumValue - origin) / 2f;
origin = MaximumValue - range;
NormalizedRange = (range * 2f)/ValueRange;
}
break;
}
default:
{
break;
}
}
// Clamp both range and NormalizedRange.
if ((origin - range) < MinimumValue)
{
range = origin - MinimumValue;
NormalizedRange = range / ValueRange;
}
else if ((origin + range) > MaximumValue)
{
range = MaximumValue - origin;
NormalizedRange = range / ValueRange;
}
}
また、CubismHarmonicMotionParameterは、CubismHarmonicMotionControllerが参照先を取得するためのマーカーとしても使用しています。
2. 各パラメータの値を操作するコンポーネント
各パラメータに開閉の値を適用するには、CubismHarmonicMotionControllerを使用します。
これはMonoBehaviourを継承したコンポーネントで、使用する際はCubismのPrefabのルートにアタッチします。
初期化時に、PrefabにアタッチされたすべてのCubismHarmonicMotionParameterの参照を取得します。
実行中に周期的に値を動作させるパラメータを追加／削除した場合、CubismHarmonicMotionController.Refresh()を呼んで参照を取得し直します。
/// <summary>
/// Refreshes the controller. Call this method after adding and/or removing <see cref="CubismHarmonicMotionParameter"/>.
/// </summary>
public void Refresh()
{
var model = this.FindCubismModel();
// Catch sources and destinations.
Sources = model
.Parameters
.GetComponentsMany<CubismHarmonicMotionParameter>();
Destinations = new CubismParameter[Sources.Length];
for (var i = 0; i < Sources.Length; ++i)
{
Destinations[i] = Sources[i].GetComponent<CubismParameter>();
}
// Get cubism update controller.
HasUpdateController = (GetComponent<CubismUpdateController>() != null);
}
...
/// <summary>
/// Called by Unity. Makes sure cache is initialized.
/// </summary>
private void Start()
{
// Initialize cache.
Refresh();
}
CubismHarmonicMotionControllerは、毎フレームのLateUpdate()のタイミングで、CubismHarmonicMotionParameterでマーキングされたパラメータに対して算出された値を適用します。
/// <summary>
/// Called by Unity. Makes sure cache is initialized.
/// </summary>
private void Start()
{
// Initialize cache.
Refresh();
}
CubismHarmonicMotionControllerには、2つの設定項目があります。
/// <summary>
/// Blend mode.
/// </summary>
[SerializeField]
public CubismParameterBlendMode BlendMode = CubismParameterBlendMode.Additive;
/// <summary>
/// The timescales for each channel.
/// </summary>
[SerializeField]
public float[] ChannelTimescales;
- BlendMode
パラメータに値を適用する際のブレンドモードです。
設定できる値は以下の3つです。
– Override : 現在の値を上書きします。
– Additive : 現在の値に加算します。
– Multiply : 現在の値に乗算します。
- ChannelTimescales
正弦波の周期を設定します。
周期は複数設定できます。