Class AnimationUtility

Inheritance

Object

AnimationUtility

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEditor

Assembly: UnityEditor.dll

Syntax

public class AnimationUtility

Fields

| Improve this Doc View Source

onCurveWasModified

Declaration

public static AnimationUtility.OnCurveWasModified onCurveWasModified

Field Value

Type	Description
AnimationUtility.OnCurveWasModified

Methods

CalculateTransformPath(Transform, Transform)

Declaration

public static string CalculateTransformPath(Transform targetTransform, Transform root)

Parameters

Type	Name	Description
Transform	targetTransform
Transform	root

Returns

Type	Description
String

ConstrainToPolynomialCurve(AnimationCurve)

Declaration

public static void ConstrainToPolynomialCurve(AnimationCurve curve)

Parameters

Type	Name	Description
AnimationCurve	curve

| Improve this Doc View Source

GetAllCurves(AnimationClip)

Declaration

[Obsolete("GetAllCurves is deprecated. Use GetCurveBindings and GetObjectReferenceCurveBindings instead.")]
public static AnimationClipCurveData[] GetAllCurves(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip

Returns

Type	Description
AnimationClipCurveData[]

| Improve this Doc View Source

GetAllCurves(AnimationClip, Boolean)

Declaration

[Obsolete("GetAllCurves is deprecated. Use GetCurveBindings and GetObjectReferenceCurveBindings instead.")]
public static AnimationClipCurveData[] GetAllCurves(AnimationClip clip, [DefaultValue("true")] bool includeCurveData)

Parameters

Type	Name	Description
AnimationClip	clip
Boolean	includeCurveData

Returns

Type	Description
AnimationClipCurveData[]

| Improve this Doc View Source

GetAnimatableBindings(GameObject, GameObject)

Declaration

public static EditorCurveBinding[] GetAnimatableBindings(GameObject targetObject, GameObject root)

Parameters

Type	Name	Description
GameObject	targetObject
GameObject	root

Returns

Type	Description
EditorCurveBinding[]

GetAnimatedObject(GameObject, EditorCurveBinding)

Declaration

public static Object GetAnimatedObject(GameObject root, EditorCurveBinding binding)

Parameters

Type	Name	Description
GameObject	root
EditorCurveBinding	binding

Returns

Type	Description
Object

| Improve this Doc View Source

GetAnimationClips(Animation)

Declaration

[Obsolete("GetAnimationClips(Animation) is deprecated. Use GetAnimationClips(GameObject) instead.")]
public static AnimationClip[] GetAnimationClips(Animation component)

Parameters

Type	Name	Description
Animation	component

Returns

Type	Description
AnimationClip[]

| Improve this Doc View Source

GetAnimationClips(GameObject)

Declaration

public static AnimationClip[] GetAnimationClips(GameObject gameObject)

Parameters

Type	Name	Description
GameObject	gameObject

Returns

Type	Description
AnimationClip[]

GetAnimationClipSettings(AnimationClip)

Declaration

public static AnimationClipSettings GetAnimationClipSettings(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip

Returns

Type	Description
AnimationClipSettings

GetAnimationEvents(AnimationClip)

Declaration

public static AnimationEvent[] GetAnimationEvents(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip

Returns

Type	Description
AnimationEvent[]

GetCurveBindings(AnimationClip)

Declaration

public static EditorCurveBinding[] GetCurveBindings(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip

Returns

Type	Description
EditorCurveBinding[]

| Improve this Doc View Source

GetEditorCurve(AnimationClip, String, Type, String)

Declaration

[Obsolete("This overload is deprecated. Use the one with EditorCurveBinding instead.")]
public static AnimationCurve GetEditorCurve(AnimationClip clip, string relativePath, Type type, string propertyName)

Parameters

Type	Name	Description
AnimationClip	clip
String	relativePath
Type	type
String	propertyName

Returns

Type	Description
AnimationCurve

GetEditorCurve(AnimationClip, EditorCurveBinding)

Declaration

public static AnimationCurve GetEditorCurve(AnimationClip clip, EditorCurveBinding binding)

Parameters

Type	Name	Description
AnimationClip	clip
EditorCurveBinding	binding

Returns

Type	Description
AnimationCurve

| Improve this Doc View Source

GetEditorCurveValueType(GameObject, EditorCurveBinding)

Declaration

public static Type GetEditorCurveValueType(GameObject root, EditorCurveBinding binding)

Parameters

Type	Name	Description
GameObject	root
EditorCurveBinding	binding

Returns

Type	Description
Type

| Improve this Doc View Source

GetFloatValue(GameObject, String, Type, String, out Single)

Declaration

[Obsolete("This overload is deprecated. Use the one with EditorCurveBinding instead.")]
public static bool GetFloatValue(GameObject root, string relativePath, Type type, string propertyName, out float data)

Parameters

Type	Name	Description
GameObject	root
String	relativePath
Type	type
String	propertyName
Single	data

Returns

Type	Description
Boolean

GetFloatValue(GameObject, EditorCurveBinding, out Single)

Declaration

public static bool GetFloatValue(GameObject root, EditorCurveBinding binding, out float data)

Parameters

Type	Name	Description
GameObject	root
EditorCurveBinding	binding
Single	data

Returns

Type	Description
Boolean

| Improve this Doc View Source

GetGenerateMotionCurves(AnimationClip)

Declaration

[Obsolete("This is not used anymore.  Root motion curves are automatically generated if applyRootMotion is enabled on Animator component.")]
public static bool GetGenerateMotionCurves(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip

Returns

Type	Description
Boolean

GetKeyBroken(AnimationCurve, Int32)

Declaration

public static bool GetKeyBroken(AnimationCurve curve, int index)

Parameters

Type	Name	Description
AnimationCurve	curve
Int32	index

Returns

Type	Description
Boolean

GetKeyLeftTangentMode(AnimationCurve, Int32)

Declaration

public static AnimationUtility.TangentMode GetKeyLeftTangentMode(AnimationCurve curve, int index)

Parameters

Type	Name	Description
AnimationCurve	curve
Int32	index

Returns

Type	Description
AnimationUtility.TangentMode

GetKeyRightTangentMode(AnimationCurve, Int32)

Declaration

public static AnimationUtility.TangentMode GetKeyRightTangentMode(AnimationCurve curve, int index)

Parameters

Type	Name	Description
AnimationCurve	curve
Int32	index

Returns

Type	Description
AnimationUtility.TangentMode

GetObjectReferenceCurve(AnimationClip, EditorCurveBinding)

Declaration

public static ObjectReferenceKeyframe[] GetObjectReferenceCurve(AnimationClip clip, EditorCurveBinding binding)

Parameters

Type	Name	Description
AnimationClip	clip
EditorCurveBinding	binding

Returns

Type	Description
ObjectReferenceKeyframe[]

GetObjectReferenceCurveBindings(AnimationClip)

Declaration

public static EditorCurveBinding[] GetObjectReferenceCurveBindings(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip

Returns

Type	Description
EditorCurveBinding[]

| Improve this Doc View Source

GetObjectReferenceValue(GameObject, EditorCurveBinding, out Object)

Declaration

public static bool GetObjectReferenceValue(GameObject root, EditorCurveBinding binding, out Object data)

Parameters

Type	Name	Description
GameObject	root
EditorCurveBinding	binding
Object	data

Returns

Type	Description
Boolean

| Improve this Doc View Source

InAnimationMode()

Declaration

[Obsolete("Use AnimationMode.InAnimationMode instead.")]
public static bool InAnimationMode()

Returns

Type	Description
Boolean

| Improve this Doc View Source

PropertyModificationToEditorCurveBinding(PropertyModification, GameObject, out EditorCurveBinding)

Declaration

public static Type PropertyModificationToEditorCurveBinding(PropertyModification modification, GameObject gameObject, out EditorCurveBinding binding)

Parameters

Type	Name	Description
PropertyModification	modification
GameObject	gameObject
EditorCurveBinding	binding

Returns

Type	Description
Type

SetAdditiveReferencePose(AnimationClip, AnimationClip, Single)

Declaration

public static void SetAdditiveReferencePose(AnimationClip clip, AnimationClip referenceClip, float time)

Parameters

Type	Name	Description
AnimationClip	clip
AnimationClip	referenceClip
Single	time

SetAnimationClips(Animation, AnimationClip[])

Declaration

public static void SetAnimationClips(Animation animation, AnimationClip[] clips)

Parameters

Type	Name	Description
Animation	animation
AnimationClip[]	clips

SetAnimationClipSettings(AnimationClip, AnimationClipSettings)

Declaration

public static void SetAnimationClipSettings(AnimationClip clip, AnimationClipSettings srcClipInfo)

Parameters

Type	Name	Description
AnimationClip	clip
AnimationClipSettings	srcClipInfo

SetAnimationEvents(AnimationClip, AnimationEvent[])

Declaration

public static void SetAnimationEvents(AnimationClip clip, AnimationEvent[] events)

Parameters

Type	Name	Description
AnimationClip	clip
AnimationEvent[]	events

| Improve this Doc View Source

SetAnimationType(AnimationClip, ModelImporterAnimationType)

Declaration

[Obsolete("SetAnimationType is no longer supported.")]
public static void SetAnimationType(AnimationClip clip, ModelImporterAnimationType type)

Parameters

Type	Name	Description
AnimationClip	clip
ModelImporterAnimationType	type

| Improve this Doc View Source

SetEditorCurve(AnimationClip, String, Type, String, AnimationCurve)

Declaration

[Obsolete("This overload is deprecated. Use the one with EditorCurveBinding instead.")]
public static void SetEditorCurve(AnimationClip clip, string relativePath, Type type, string propertyName, AnimationCurve curve)

Parameters

Type	Name	Description
AnimationClip	clip
String	relativePath
Type	type
String	propertyName
AnimationCurve	curve

| Improve this Doc View Source

SetEditorCurve(AnimationClip, EditorCurveBinding, AnimationCurve)

Declaration

public static void SetEditorCurve(AnimationClip clip, EditorCurveBinding binding, AnimationCurve curve)

Parameters

Type	Name	Description
AnimationClip	clip
EditorCurveBinding	binding
AnimationCurve	curve

| Improve this Doc View Source

SetGenerateMotionCurves(AnimationClip, Boolean)

Declaration

[Obsolete("This is not used anymore.  Root motion curves are automatically generated if applyRootMotion is enabled on Animator component.")]
public static void SetGenerateMotionCurves(AnimationClip clip, bool value)

Parameters

Type	Name	Description
AnimationClip	clip
Boolean	value

SetKeyBroken(AnimationCurve, Int32, Boolean)

Declaration

public static void SetKeyBroken(AnimationCurve curve, int index, bool broken)

Parameters

Type	Name	Description
AnimationCurve	curve
Int32	index
Boolean	broken

SetKeyLeftTangentMode(AnimationCurve, Int32, AnimationUtility.TangentMode)

Declaration

public static void SetKeyLeftTangentMode(AnimationCurve curve, int index, AnimationUtility.TangentMode tangentMode)

Parameters

Type	Name	Description
AnimationCurve	curve
Int32	index
AnimationUtility.TangentMode	tangentMode

SetKeyRightTangentMode(AnimationCurve, Int32, AnimationUtility.TangentMode)

Declaration

public static void SetKeyRightTangentMode(AnimationCurve curve, int index, AnimationUtility.TangentMode tangentMode)

Parameters

Type	Name	Description
AnimationCurve	curve
Int32	index
AnimationUtility.TangentMode	tangentMode

| Improve this Doc View Source

SetObjectReferenceCurve(AnimationClip, EditorCurveBinding, ObjectReferenceKeyframe[])

Declaration

public static void SetObjectReferenceCurve(AnimationClip clip, EditorCurveBinding binding, ObjectReferenceKeyframe[] keyframes)

Parameters

Type	Name	Description
AnimationClip	clip
EditorCurveBinding	binding
ObjectReferenceKeyframe[]	keyframes

| Improve this Doc View Source

StartAnimationMode(Object[])

Declaration

[Obsolete("Use AnimationMode.StartAnimationmode instead.")]
public static void StartAnimationMode(Object[] objects)

Parameters

Type	Name	Description
Object[]	objects

| Improve this Doc View Source

StopAnimationMode()

Declaration

[Obsolete("Use AnimationMode.StopAnimationMode instead.")]
public static void StopAnimationMode()

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)

MustExtensions.MustBeEqual<T>(T, T, String)

MustExtensions.MustNotBeEqual<T>(T, T)

MustExtensions.MustNotBeEqual<T>(T, T, String)

MustExtensions.MustBeNull<T>(T)

MustExtensions.MustBeNull<T>(T, String)

MustExtensions.MustNotBeNull<T>(T)

MustExtensions.MustNotBeNull<T>(T, String)