Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEditor
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseAnimationMode is used by the AnimationWindow to store properties modified by the AnimationClip playback.
When exiting AnimationMode all properties are reverted to their
default state. Animated properties are also highlighted by the inspector. Use
StartAnimationMode to enter animation mode. In Animation mode the
editor is tinted to show that it is animating. Properties can be animated via
SampleAnimationClip.
The following script example shows how a GameObject can be animated. AnimationMode has
functions which support this. The demo can be launched from the "Examples/AnimationMode demo"
menu. Once this demo starts it requires a GameObject to be selected in the Scene window.
(This example requires the game to not be running in the Game view.) After a
GameObject has been selected the example window will change. Choose a created animation clip
for the chosen GameObject. Once the animation clip has been loaded the
animation can be applied to the GameObject. Clicking the Animate button adds a slider to the
window. Using the slider will apply the animation to the selected GameObject. The Lock
button prevents the animation to be applied to a different GameObject.
no example available in JavaScript
using UnityEngine; using UnityEditor;
public class ExampleClass : EditorWindow { protected GameObject go; protected AnimationClip animationClip; protected float time = 0.0f; protected bool lockSelection = false; protected bool animationMode = false;
[MenuItem("Examples/AnimationMode demo", false, 2000)] public static void DoWindow() { var window = GetWindowWithRect<ExampleClass>(new Rect(0, 0, 300, 80)); window.Show(); }
// Has a GameObject been selection? public void OnSelectionChange() { if (!lockSelection) { go = Selection.activeGameObject; Repaint(); } }
// Main editor window public void OnGUI() { // Wait for user to select a GameObject if (go == null) { EditorGUILayout.HelpBox("Please select a GameObject", MessageType.Info); return; }
// Animate and Lock buttons. Check if Animate has changed GUILayout.BeginHorizontal(); EditorGUI.BeginChangeCheck(); GUILayout.Toggle(AnimationMode.InAnimationMode(), "Animate"); if (EditorGUI.EndChangeCheck()) ToggleAnimationMode();
GUILayout.FlexibleSpace(); lockSelection = GUILayout.Toggle(lockSelection, "Lock"); GUILayout.EndHorizontal();
// Slider to use when Animate has been ticked EditorGUILayout.BeginVertical(); animationClip = EditorGUILayout.ObjectField(animationClip, typeof(AnimationClip), false) as AnimationClip; if (animationClip != null) { float startTime = 0.0f; float stopTime = animationClip.length; time = EditorGUILayout.Slider(time, startTime, stopTime); } else if (AnimationMode.InAnimationMode()) AnimationMode.StopAnimationMode(); EditorGUILayout.EndVertical(); }
void Update() { if (go == null) return;
if (animationClip == null) return;
// There is a bug in AnimationMode.SampleAnimationClip which crashes // Unity if there is no valid controller attached Animator animator = go.GetComponent<Animator>(); if (animator != null && animator.runtimeAnimatorController == null) return;
// Animate the GameObject if (!EditorApplication.isPlaying && AnimationMode.InAnimationMode()) { AnimationMode.BeginSampling(); AnimationMode.SampleAnimationClip(go, animationClip, time); AnimationMode.EndSampling();
SceneView.RepaintAll(); } }
void ToggleAnimationMode() { if (AnimationMode.InAnimationMode()) AnimationMode.StopAnimationMode(); else AnimationMode.StartAnimationMode(); } }
animatedPropertyColor | The color used to show that a property is currently being animated. |
candidatePropertyColor | The color used to show that an animated property has been modified. |
recordedPropertyColor | The color used to show that an animated property automatically records changes in the animation clip. |
AddPropertyModification | Marks a property as currently being animated. |
BeginSampling | Initialise the start of the animation clip sampling. |
EndSampling | Finish the sampling of the animation clip. |
InAnimationMode | Are we currently in AnimationMode? |
IsPropertyAnimated | Is the specified property currently in animation mode and being animated? |
SampleAnimationClip | Samples an AnimationClip on the object and also records any modified properties in AnimationMode. |
StartAnimationMode | Starts the animation mode. |
StopAnimationMode | Stops Animation mode, reverts all properties that were animated in animation mode. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!