Using AnimationTree¶

はじめに¶

With AnimationPlayer, Godot has one of the most flexible animation systems that you can find in any game engine. The ability to animate almost any property in any node or resource, as well as having dedicated transform, bezier, function calling, audio and sub-animation tracks, is pretty much unique.

ただし、それらのアニメーションをブレンドするには、AnimationPlayerでは固定のクロスフェード遷移のみなので、比較的制限されています。

AnimationTreeは、高度な遷移をするためにGodot 3.1で導入されたノードです。これは古いAnimationTreePlayerを置き換えるもので、膨大な量の機能と柔軟性を加えています。

AnimationTreeの作成¶

始める前にまず明らかにすべきは、AnimationTreeノードは自身のアニメーションは含みません。代わりにそれは、別にあるAnimationPlayerノードが持つアニメーションを利用します。これにより、従来通りアニメーションを編集(あるいは他の3Dシーンからインポート)でき、さらに再生をコントロールしたいときにこのノードを追加するのです。

AnimationTreeの最も一般的な使い道は3Dシーンです。シーンを3D交換フォーマットからインポートすると、通常はアニメーションはそのまま同梱されています(複数のものや、大きなものがインポートの際に分割されていても)。インポートされたGodotシーンでは最終的に、アニメーションはすべて一つのAnimationPlayerノードに格納されます。

Godotでは、インポートされたシーンを (インスタンス化あるいは継承せずに) 直接使うことは珍しいので、インポートされたシーンのための新しいシーンにAnimationTreeを追加することにします。そのあとAnimationTreeノードにて、インポートされたシーンの中に作られたAnimationPlayerを割り当ててください。

参考例として、三人称視点シューターデモ(英語) もそうなっています。

プレイヤー用の新しいシーンはKinematicBodyをルートにして作られています。このシーンの中には、元の.dae(Collada)ファイルがインスタンス化され、AnimationTreeノードが作成されてあります。

ツリーの作成¶

AnimationTreeでは主に3種類のノードが使えます:

アニメーション・ノード。リンクされたAnimationTreeのアニメーションを参照します。
アニメーションルート・ノード。副ノードとのブレンドに使われます。
アニメーションブレンド・ノード。AnimationNodeBlendTreeの中で使用され、複数のインプットポートを持ち、一つのグラフでブレンドします。

AnimationTreeのルートノードを設定するには、いくつかの型が用意されています:

AnimationNodeAnimation: リストから選択したアニメーションを再生します。これは一番シンプルなルートノードで、通常は直接のルートとしては使用されません。
AnimationNodeBlendTree: mix、blend2、blend3、one shotなどのような、多くのブレンド型のノードを含んでいます。これはルートとしてよく使われるものの一つです。
AnimationNodeStateMachine: 一つのグラフに、複数のルートノードを子に持ちます。それぞれのノードはステートとして扱われ、ステートを切り替えるための機能をいくつも備えています。
AnimationNodeBlendSpace2D: ルートノードを2Dブレンドスペースに置けるようになります。二次元空間でブレンド位置をコントロールし、複数のアニメーションのミックスします。
AnimationNodeBlendSpace1D: 上記の簡略版です (一次元)。

ブレンド・ツリー¶

AnimationNodeBlendTreeはブレンド用で、ルートまたは通常のノードを含むことができます。ノードはメニューからグラフに追加します。

すべてのブレンドツリーには、標準でOutputノードが入っていて、アニメーションを再生するにはそこに何かをつなげる必要があります。

この機能を確認する一番簡単な方法は、Animationノードを直接つなげることです:

これは単純にアニメーションを再生します。実行する前にまずAnimationTreeがアクティブであることを確認してください。

下記は利用可能なノードの短い説明です:

Blend2 / Blend3¶

これらのノードは、２つあるいは３つのインプットをユーザー指定の値でブレンドします:

より複雑なブレンドには、代わりにブレンドスペースを使うことをおすすめします。

ブレンドにはフィルターを使うこともでき、どのトラックをブレンド関数に渡すかどうかをコントロールできます。これはアニメーションをレイヤーに分けて重ね合わせるのに有用です。

OneShot¶

このノードは、副アニメーションを実行し、完了すると元に戻ります。フィルターだけでなく、フェードインとフェードアウトのブレンド時間もカスタマイズできます。

Seek¶

This node can be used to cause a seek command to happen to any sub-children of the animation graph. Use this node type to play an Animation from the start or a certain playback position inside the AnimationNodeBlendTree.

After setting the time and changing the animation playback, the seek node automatically goes into sleep mode on the next process frame by setting its seek_position value to -1.0.

# Play child animation from the start.
anim_tree.set("parameters/Seek/seek_position", 0.0)
# Alternative syntax (same result as above).
anim_tree["parameters/Seek/seek_position"] = 0.0

# Play child animation from 12 second timestamp.
anim_tree.set("parameters/Seek/seek_position", 12.0)
# Alternative syntax (same result as above).
anim_tree["parameters/Seek/seek_position"] = 12.0

// Play child animation from the start.
animTree.Set("parameters/Seek/seek_position", 0.0);

// Play child animation from 12 second timestamp.
animTree.Set("parameters/Seek/seek_position", 12.0);

TimeScale¶

アニメーションの再生速度の変更 (あるいは逆再生) を可能にします。0 にセットするとアニメーションを一時停止します。

トランジション¶

とても単純なステートマシンです (StateMachineノードを扱いたくない時に)。複数のアニメーションを接続でき、トランジションの時間を指定できます。

BlendSpace2D¶

BlendSpace2D is a node to do advanced blending in two dimensions. Points are added to a two-dimensional space and then a position can be controlled to determine blending:

X および Y の範囲でコントロールできます (それぞれ別の名称に変更可)。デフォルトでは、点はどこにでも置けます(座標系の上で右クリックするか、点を作成ボタンを使う)。三角形はドロネー分割で自動生成されます。

三角形の自動作成をオフにすれば、三角形を手動で作成することもできますが、必要になることはあまり無いでしょう:

最後に、ブレンドモードは変更することができます。標準状態では、一番近い三角形の中で補完された点によってブレンドされますが、もし対象が(フレームごとに動かす)2Dアニメーションなら、離散モードに切り替えてもよいでしょう。あるいは、離散アニメーション間においても現在の再生位置を維持したい場合のために、キャリーモードもあります。モードはブレンドメニューから変更できます。

BlendSpace1D¶

これは2Dブレンドスペースと同様ですが、一次元のみです (そのため三角形は不要)。

StateMachine¶

This node acts as a state machine with root nodes as states. Root nodes can be created and connected via lines. States are connected via Transitions, which are connections with special properties. Transitions are uni-directional, but two can be used to connect in both directions.

There are many types of transition:

即座 (Immediate): 次のステートへと即座に切り替わります。現在のステートが終わると、新しいほうの先頭から始まります。
同期 (Sync): 次のステートへと即座に切り替わりますが、新しいステートでも古いステートと同じ再生位置になります。
終わりに (At End): 現在のステートの再生位置が最後になるまで待ち、それから次のステートの先頭に切り替わります。

トランジションはまた、いくつかのプロパティを持ちます。トランジションをクリックすると、インスペクタドックに表示されます:

Switch Mode はトランジションの種類です (上記参照)。作成した後でもここで変更できます。
Auto Advance (自動移行)は、このステートに到達したらすぐにトランジションがオンになります。これは At End スイッチモードと合わせるのが最適です。
Advance Condition (移行条件) は、この条件が満たされた場合に自動移行させます。テキストフィールドには変数名を入れます。この変数はコードから変更することができます (詳しくは後述)。
Xfade Time は、このステートと次との間でのクロスフェードにかかる時間です。
Priority is used together with the travel() function from code (more on this later). Lower priority transitions are preferred when travelling through the tree.
Disabled toggles disabling this transition (when disabled, it will not be used during travel or auto advance).

ルートモーション¶

3Dアニメーションの作業では、スケルトンを動かすためにルート・スケルトンボーンを用意するのが一般的なテクニックです。これにより、キャラクターを床に合わせて歩かせることが可能になります。また、ムービー場面においても、正確に物体に触れさせられるようになります。

Godot内でアニメーションを再生するときは、このボーンを ルート・モーショントラック に指定することができます。そうすると、そのボーンの見た目の変化は打ち消されます (アニメーションはそのまま)。

そのあと、実際のモーションはAnimationTree APIからトランスフォームとして取得します:

anim_tree.get_root_motion_transform()

animTree.GetRootMotionTransform();

これをKinematicBody.move_and_slideなどの関数に渡すことで、キャラクターの動きをコントロールできます。

There is also a tool node, RootMotionView, that can be placed in a scene and will act as a custom floor for your character and animations (this node is disabled by default during the game).

コードからコントロールする¶

ツリーを作成してプレビューしたら、最後に残る質問は「これを全部コードからコントロールする方法は？」です。

Keep in mind that the animation nodes are just resources and, as such, they are shared between all instances using them. Setting values in the nodes directly will affect all instances of the scene that uses this AnimationTree. This is generally undesirable, but does have some cool use cases, e.g. you can copy and paste parts of your animation tree, or reuse nodes with a complex layout (such as a state machine or blend space) in different animation trees.

実際のアニメーションデータはAnimationTreeノードに格納されており、プロパティを通じてアクセスします。AnimationTreeの Parameters セクションに、リアルタイムで変更できるパラメーターが全てあるので確認してみてください:

This is handy because it makes it possible to animate them from an AnimationPlayer, or even the AnimationTree itself, allowing the realization of very complex animation logic.

これらの値をコードから変更する場合は、プロパティパスを知る必要があります。それには、パラメーターの上にマウスをホバーするだけです。

そうすれば、それらを設定したり読み込めます:

anim_tree.set("parameters/eye_blend/blend_amount", 1.0)
# Simpler alternative form:
anim_tree["parameters/eye_blend/blend_amount"] = 1.0

animTree.Set("parameters/eye_blend/blend_amount", 1.0);

ステートマシン travel¶

One of the nice features in Godot's StateMachine implementation is the ability to travel. The graph can be instructed to go from the current state to another one, while visiting all the intermediate ones. This is done via the A* algorithm. In the absence of any viable set of transitions starting at the current state and finishing at the destination state, the graph teleports to the destination state.

travel機能を使うには、まずAnimationTreeノードからAnimationNodeStateMachinePlayback オブジェクトを取得します (プロパティのひとつ)。

var state_machine = anim_tree["parameters/playback"]

AnimationNodeStateMachinePlayback stateMachine = (AnimationNodeStateMachinePlayback)animTree.Get("parameters/playback");

取得したら、その多くの関数の中からひとつ呼び出せば使えます:

state_machine.travel("SomeState")

stateMachine.Travel("SomeState");

The state machine must be running before you can travel. Make sure to either call start() or choose a node to Autoplay on Load.