===== Mecanim Control =====
Your ultimate solution for Mecanim based games!

{{ :logo_mecanim_control.jpg?nolink |}}

**Mecanim Control** is a coding tool made that allow for a wider variety of common methods used by the [[http://docs.unity3d.com/Documentation/ScriptReference/Animation.html|Animation component]] with Mecanim (Humanoid/Generic) animations. It allows you to not only dynamically load any animation clip during runtime, but also tap into several methods currently missing in this magnificent system.


----

==== Overview ====

{{ :mecanimcontrol2ss.jpg |}}

You can use MecanimControl much like you would use the animation component.\\
To play a simple animation use //MecanimControl.Play//\\
To cross-fade between animations use //MecanimControl.CrossFade// -or- one of the //MecanimControl.Play// alternatives.\\
To change how animations wrap (Loop, Once, PingPong) change the WrapMode of the respective //AnimationClip// in their import settings, or use //MecanimControl.SetWrapMode// to change it at runtime.\\
//AnimationData// can be used to modify the clip, playback speed, and direct control over blending.

MecanimControl also supports enumerators so you can loop through all AnimationData like this:

<code c#>
using UnityEngine;
using System.Collections;

public class AnimationControlDemo : MonoBehaviour {

	private MecanimControl mecanimControl;

	void Start () {
		mecanimControl = gameObject.GetComponent<MecanimControl>();
	}

	void OnGUI(){
		foreach(AnimationData animationData in mecanimControl.animations){
			if (GUILayout.Button(animationData.clipName)){
				mecanimControl.Play(animationData, mirror);
			}
		}
	}
}
</code>

----
==== Public Variables ====

{{ :mecanim_ui.jpg?nolink |}}

**Index:**
  * [[#defaultanimation|Default Animation]]
  * [[#animations|Animations]]
  * [[#debugmode|Debug Mode]]
  * [[#alwaysplay|Always Play]]
  * [[#overriderootmotion|Override Root Motion]]
  * [[#defaulttransitionduration|Default Transition Duration]]
  * [[#defaultwrapmode|Default Wrap Mode]]


----
{{anchor:defaultanimation}}
**Default Animation**\\
AnimationData //defaultAnimation//;\\
By default, if no order is given, the animator will play the animation stored in this AnimationData. If you don't assign an animation, Mecanim Control will instantiate the first animation listed on [[#animations|animations]].

<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.defaultAnimationData.speed = .5f;
}
</code>

----
{{anchor:animations}}
**Animations**\\
AnimationData[] //animations//;\\

**Properties**\\
AnimationClip clip - The AnimationClip file.\\
string clipName - Animation name.\\
float speed - Animation speed.\\
float transitionDuration - Blending Duration.\\
WrapMode wrapMode - The animation's default [[http://docs.unity3d.com/ScriptReference/WrapMode.html|WrapMode]].\\
bool applyRootMotion - If this and //Override Root Motion// is toggled this animation will toggle the Animator's [[http://docs.unity3d.com/Manual/RootMotion.html|Root Motion]]

**Description**\\
This array contain all the AnimationData stored by either the UI or by using AddClip. Its then used to emulate a state machine under the //Animator Controller//.

<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	foreach(AnimationData animationData in mecanimControl.animations) {
		animationData.speed = .5f;
	}
}
</code>

----
{{anchor:debugmode}}
**Debug Mode**\\
bool //debugMode//;\\
Toggles a GUI box containing all the information about the current clip playing as well as its blending weight.

<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.debugMode = true;
}
</code>

----
{{anchor:alwaysplay}}
**Always Play**\\
bool //alwaysPlay//;\\
If an animation is set to //WrapMode.Once// and //alwaysPlay// is toggled on, after the clip ends it will immediately play the //default animation//.


<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.alwaysPlay = true;
}
</code>

----
{{anchor:overriderootmotion}}
**Override Root Motion**\\
bool //overrideRootMotion//;\\
If both applyRootMotion (under the animation element) and this variable is //true//, this animation will toggle the Animator's [[http://docs.unity3d.com/Manual/RootMotion.html|Root Motion]].


<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.overrideRootMotion = true;
	mecanimControl.animationData[0].applyRootMotion = true;
}
</code>

----
{{anchor:defaulttransitionduration}}
**Default Transition Duration**\\
float //defaultTransitionDuration//;\\
If an animation has its blending speed set to 0, it will use this value instead.

<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.defaultTransitionDuration = .2f;
}
</code>

----
{{anchor:defaultwrapmode}}
**Default Wrap Mode**\\
float //defaultWrapMode//;\\
If an animation has its //wrapmode// set to //default//, it will use this value instead.

<code c#>
void Start () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.defaultWrapMode = WrapMode.Once;
}
</code>

----
==== Public Functions ====
{{ ::mecanim_script.jpg?nolink |}}

**Index:**
  * [[#addclip|AddClip]]
  * [[#crossfade|CrossFade]]
  * [[#getanimationdata|GetAnimationData]]
  * [[#getcurrentanimationdata|GetCurrentAnimationData]]
  * [[#getcurrentclipname|GetCurrentClipName]]
  * [[#getcurrentclipplaycount|GetCurrentClipPlayCount]]
  * [[#getcurrentclipposition|GetCurrentClipPosition]]
  * [[#getmirror|GetMirror]]
  * [[#getspeed|GetSpeed]]
  * [[#isplaying|IsPlaying]]
  * [[#pause|Pause]]
  * [[#play|Play]]
  * [[#removeclip|Remove Clip]]
  * [[#restorespeed|Restore Speed]]
  * [[#rewind|Rewind]]
  * [[#setcurrentclipposition|SetCurrentClipPosition]]
  * [[#setdefaultclip|SetDefaultClip]]
  * [[#setmirror|SetMirror]]
  * [[#setspeed|SetSpeed]]
  * [[#setwrapmode|SetWrapMode]]
  * [[#stop|Stop]]


----
{{anchor:addclip}}
**AddClip**\\
void //AddClip(AnimationClip clip, string name);//\\
void //AddClip(AnimationClip clip, string name, float speed, WrapMode wrapMode)//;

**Parameters**\\
clip - The AnimationClip file.\\
name - Animation name.\\
speed - Animation speed.\\
wrapMode - The animation's default [[http://docs.unity3d.com/ScriptReference/WrapMode.html|WrapMode]].

**Description:**
Adds a clip to //animations// with the name //newName//.

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {
	public AnimationClip walkClip;
	void Start () {
		mecanimControl = gameObject.GetComponent<MecanimControl>();
		mecanimControl.AddClip(walkClip, "walk");
	}
}
</code>

----
{{anchor:crossfade}}
**CrossFade**\\
void //CrossFade(string clipName, float blendingTime);//\\
void //CrossFade(string clipName, float blendingTime, float normalizedTime, bool mirror);//\\
void //CrossFade(AnimationData animationData, float blendingTime, float normalizedTime, bool mirror);//\\

**Parameters**\\
clipName - Animation name.\\
animationData - The correspondent animation data.\\
blendingTime - The blending duration between the 2 animations.\\
normalizedTime - The timeline's position of the animation to be played (0-1)\\
mirror - Should the animation be mirrored?

**Description:**
Fades the animation with name //clipName// in over a period of //blendingTime// seconds as it fades other animations out.\\
You can also set //normalizedTime// to set where, in its timeline, you want the animation to start (0-1) as well as toggle [[http://docs.unity3d.com/Documentation/Manual/AnimationStates.html|mirror]].

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {
	public AnimationClip walkClip;
	void Start () {
		mecanimControl = gameObject.GetComponent<MecanimControl>();
		mecanimControl.CrossFade("walk", .2f);
	}
}
</code>

----
{{anchor:getanimationdata}}
**GetAnimationData**\\
AnimationData //GetAnimationData(AnimationClip clip);//\\
AnimationData //GetAnimationData(string clipName);//\\

**Parameters**\\
clip - Animation clip.\\
clipName - Clip name.

**Description:**
Returns the AnimationData related to that animation name or clip.

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {
	public AnimationClip walkClip;
	void Start () {
		mecanimControl = gameObject.GetComponent<MecanimControl>();
		mecanimControl.AddClip(walkClip, "walk");
		Debug("Animation Name:"+ mecanimControl.GetAnimationData(walkClip).clipName);
	}
}
</code>

----
{{anchor:getcurrentanimationdata}}
**GetCurrentAnimationData**\\
AnimationData //GetCurrentAnimationData();//\\

**Description:**
Get the AnimationData currently running.

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {
	public AnimationClip walkClip;
	void Start () {
		mecanimControl = gameObject.GetComponent<MecanimControl>();
		Debug("Animation Name:"+ mecanimControl.GetCurrentAnimationData().clipName);
	}
}
</code>


----
{{anchor:getcurrentclipname}}
**GetCurrentClipName**\\
string //GetCurrentClipName();//\\

**Description:**
Get the name of the current running clip.

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {
	void Start () {
		mecanimControl = gameObject.GetComponent<MecanimControl>();
		Debug("Animation Name:"+ mecanimControl.GetCurrentClipName());
	}
}
</code>

----
{{anchor:getcurrentclipposition}}
**GetCurrentClipPosition**\\
float //GetCurrentClipPosition();//\\

**Description:**
Get the //normalized time// of the current running clip. (0-1)

<code c#>
void CheckProgress() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	Debug("Animation Progress (%):"+ mecanimControl.GetCurrentClipPosition() * 100);
}
</code>

----
{{anchor:getcurrentclipplaycount}}
**GetCurrentClipPlayCount**\\
int //GetCurrentClipPlayCount();//\\

**Description:**
Get the number of times the current clip has played. Only works if the animation's WrapMode is set to either //WrapMode.Loop// or //WrapMode.PingPong//

<code c#>
void CheckProgress() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	Debug("Times Played:"+ mecanimControl.GetCurrentClipPlayCount());
}
</code>

----
{{anchor:getmirror}}
**GetMirror**\\
bool //GetMirror();//\\

**Description:**
Get the current [[http://docs.unity3d.com/Documentation/Manual/AnimationStates.html|mirror]] state of the //emulated runtime animator//.

<code c#>
void FaceLeft () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	if (!mecanimControl.GetMirror()) mecanimControl.setMirror(true);
}
</code>

----
{{anchor:getspeed}}
**GetSpeed**\\
float //GetSpeed();//\\
float //GetSpeed(AnimationClip clip);//\\
float //GetSpeed(string clipName);//\\

**Parameters**\\
clip - Animation clip.\\
clipName - Clip name.\\

**Description:**
Get the speed value set for //animationClip/////clipName//.\\
__no parameters__ - Get the speed the animator is running based on the current running animation.\\


<code c#>
void SlowDown() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	if (mecanimControl.GetSpeed() > 1) mecanimControl.SetSpeed(1);
}
</code>

----
{{anchor:isplaying}}
**IsPlaying**\\
bool //IsPlaying(string clipName);//\\
bool //IsPlaying(AnimationClip clip);//\\
bool //IsPlaying(AnimationData animationData);//\\

**Description:**
Returns true if //clipName//, //clip// or //animationData// is playing.

<code c#>
void Example() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	if (mecanimControl.IsPlaying("walk")) Debug.Log("Walk is playing");
}
</code>

----
{{anchor:pause}}
**Pause**\\
void //Pause();//\\

**Description:**
Pauses the animator component.

<code c#>
void Example() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.Pause();
}
</code>

----
{{anchor:play}}
**Play**\\
void //Play();//\\
void //Play(string clipName);//\\
void //Play(AnimationClip clip);//\\
void //Play(AnimationData animationData);//\\
void //Play(string clipName, bool mirror);//\\
void //Play(AnimationClip clip, bool mirror);//\\
void //Play(AnimationData animationData, bool mirror);//\\
void //Play(string clipName, float blendingTime, float normalizedTime, bool mirror);//\\
void //Play(AnimationClip clip, float blendingTime, float normalizedTime, bool mirror);//\\

**Parameters**\\
clip - Animation clip.\\
clipName - Animation name.\\
animationData - The correspondent animation data.\\
blendingTime - The blending duration between the 2 animations.\\
normalizedTime - The timeline's position of the animation to be played (0-1)\\
mirror - Should the animation be mirrored?

**Description:**
Plays animation. //Play// can be used in several ways, including blending. If no blending is set, Play will try using the default blending value. If blending is set to -1, the animation will be played abruptly without any blending.

If the animation is not set to be looping and //alwaysPlay// is toggled off it will be stopped after playing.

If no parameters are used, //Play// can be used as a follow up to //Pause//. It restores the speed of the Animator to the current animation speed value.

//Normalized Time// lets you start the animation from a predefined position in the animation timeline (0-1).

<code c#>
void Example() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.Play();
}
</code>

<code c#>
void Example() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.Play("walk", .2f, 0, true);
}
</code>

----
{{anchor:removeclip}}
**RemoveClip**\\
void //RemoveClip(string clipName);//\\
void //RemoveClip(AnimationClip clip);//\\

**Description:**
Removes the //AnimationData// from //animations// related to //clipName/////clip//.

<code c#>
void RemoveAnimation(string animation) {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.RemoveClip(animation);
}
</code>

----
{{anchor:restorespeed}}
**RestoreSpeed**\\
void //RestoreSpeed();//\\

**Description:**
Restores the speed of the animator component to the original value from the current animation being played.

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {

	private MecanimControl mecanimControl;

	void SlowMo(string animation) {
		mecanimControl.SetSpeed(.01f);
		Invoke("Restore", 2);
	}

	void Restore() {
		mecanimControl.RestoreSpeed();
	}
}
</code>

----
{{anchor:rewind}}
**Rewind**\\
void //Rewind();//\\

**Description:**
Inverts the speed of the animator component.

<code c#>
void Example() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.Rewind();
}
</code>

----
{{anchor:setcurrentclipposition}}
**SetCurrentClipPosition**\\
void //SetCurrentClipPosition(float normalizedTime);//\\
void //SetCurrentClipPosition(float normalizedTime, bool pause);//\\

**Description:**
Set the position in the timeline of the current playing clip (0-1). If pause is toggled on, the animation will be paused afterwards.

<code c#>
void Example() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.SetCurrentClipPosition(.3f, true);
}
</code>

----
{{anchor:setdefaultclip}}
**SetDefaultClip**\\
void //SetDefaultClip(AnimationClip clip, string name, float speed, WrapMode wrapMode);//\\

**Description:**
Sets the //defaultclip// through code (instead of the UI).

<code c#>
using UnityEngine;
using System.Collections;

public class Example : MonoBehaviour {

	private MecanimControl mecanimControl;
	private AnimationClip idle;

	void Start() {
		mecanimControl.SetDefaultClip(idle,"Idle", 1, WrapMode.Loop);
	}
}
</code>

----
{{anchor:setmirror}}
**SetMirror**\\
void //SetMirror(bool mirror);//\\
void //SetMirror(bool mirror, float blendingTime);//\\
void //SetMirror(bool mirror, float blendingTime, bool forceMirror);//\\

**Description:**
When toggled on, every animation will be played with the [[http://docs.unity3d.com/Documentation/Manual/AnimationStates.html|mirror]] tag toggled on.\\

<code c#>
void FaceLeft () {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	if (!mecanimControl.GetMirror()) mecanimControl.setMirror(true);
}
</code>

----
{{anchor:setspeed}}
**SetSpeed**\\
void //SetSpeed(float speed);//\\
void //SetSpeed(string clipName, float speed);//\\
void //SetSpeed(AnimationClip clip, float speed);//\\

**Description:**
Change the speed value of the Animator component or AnimationData based on //clipName/////clip//.\\
If no parameters are used, SetSpeed will change the global speed from the Animator component.


<code c#>
void SlowDown() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	if (mecanimControl.GetSpeed() > 1) mecanimControl.SetSpeed(1);
}
</code>

----
{{anchor:setwrapmode}}
**SetWrapMode**\\
void //SetWrapMode(WrapMode wrapMode);//\\
void //SetWrapMode(AnimationData animationData, WrapMode wrapMode);//\\
void //SetWrapMode(AnimationClip clip, WrapMode wrapMode);//\\
void //SetWrapMode(string clipName, WrapMode wrapMode);//\\

**Description:**
Sets the Wrap Mode of an AnimationData based on //clipName/////clip//.\\
If no parameters are used, SetWrapMode will change //defaultWrapMode//.


<code c#>
void ClampCurrentClip() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.SetWrapMode(mecanimControl.GetCurrentAnimationData, WrapMode.Clamp);
}
</code>

----
{{anchor:stop}}
**Stop**\\
void //Stop();//\\

**Description:**
Stops any animation from playing and starts playing the default animation.

<code c#>
void PlayDefaultAnimation() {
	mecanimControl = gameObject.GetComponent<MecanimControl>();
	mecanimControl.Stop();
}
</code>
----
==== Public Events ====
{{ ::mecanim_events.jpg?nolink |}}

**Index:**
  * [[#onanimationbegin|OnAnimationBegin]]
  * [[#onanimationend|OnAnimationEnd]]
  * [[#onanimationloop|OnAnimationLoop]]


----
{{anchor:onanimationbegin}}
**OnAnimationBegin**\\
void //AnimEvent(AnimationData animationData);//\\

**Description:**
Fires when an animation begins.

<code c#>
void OnAnimationBegin(AnimationData animData) {
	if (animData.clipName == "walk") Debug.Log("character is walking");
}
</code>

----
{{anchor:onanimationend}}
**OnAnimationEnd**\\
void //AnimEvent(AnimationData animationData);//\\

**Description:**
Fires when an animation ends.

<code c#>
void OnAnimationEnd(AnimationData animData) {
	if (animData.clipName == "walk") Debug.Log("character has stopped walking");
}
</code>

----
{{anchor:onanimationloop}}
**OnAnimationLoop**\\
void //AnimEvent(AnimationData animationData);//\\

**Description:**
Fires when an animation loops. This is only triggered if the animation WrapMode is set to either //WrapMode.Loop// or //WrapMode.PingPong//

<code c#>
void OnAnimationLoop(AnimationData animData) {
	if (animData.clipName == "walk") 
		Debug.Log("walking animation has looped "+ animData.timesPlayed + " times.");
}
</code>

----