UAnimationBlueprintLibrary

Blueprint library for altering and analyzing animation / skeletal data

Unreal Engine C++ API Reference > Editor > AnimationBlueprintLibrary

Inheritance Hierarchy

References

   
Module AnimationBlueprintLibrary
Header /Engine/Source/Editor/AnimationBlueprintLibrary/Public/AnimationBlueprintLibrary.h
Include #include "AnimationBlueprintLibrary.h"

Syntax

class UAnimationBlueprintLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)  

Remarks

Blueprint library for altering and analyzing animation / skeletal data

Functions

Type Name Description
UAnimNotify ... AddAnimationNotifyEvent ( UAnimSequenceBase* AnimationSe..., FName NotifyTrackName, float StartTime, TSubclassOf< UAnimNotify > NotifyCl... ) Adds an Animation Notify Event to Notify track in the given Animation with the given Notify creation data
void AddAnimationNotifyEventObject ( UAnimSequenceBase* AnimationSe..., float StartTime, UAnimNotify* Notify, FName NotifyTrackName ) Adds an the specific Animation Notify to the Animation Sequence (requires Notify's outer to be the Animation Sequence)
UAnimNotifyS... AddAnimationNotifyStateEvent ( UAnimSequenceBase* AnimationSe..., FName NotifyTrackName, float StartTime, float Duration, TSubclassOf< UAnimNotifyState > Not... ) Adds an Animation Notify State Event to Notify track in the given Animation with the given Notify State creation data
void AddAnimationNotifyStateEventObject ( UAnimSequenceBase* AnimationSe..., float StartTime, float Duration, UAnimNotifyState* NotifyState, FName NotifyTrackName ) Adds an the specific Animation Notify State to the Animation Sequence (requires Notify State's outer to be the Animation Sequence)
void AddAnimationNotifyTrack ( UAnimSequenceBase* AnimationSe..., FName NotifyTrackName, FLinearColor TrackColor ) Adds an Animation Notify Track to the Animation Sequence
void AddAnimationSyncMarker ( UAnimSequence* AnimationSequen..., FName MarkerName, float Time, FName NotifyTrackName ) Adds an Animation Sync Marker to Notify track in the given Animation with the corresponding Marker Name and Time
void AddCurve ( UAnimSequence* AnimationSequen..., FName CurveName, ERawCurveTrackTypes CurveType, bool bMetaDataCurve ) Adds an Animation Curve by Type and Name to the given Animation Sequence
bool AddCurveInternal ( UAnimSequence* AnimationSequen..., FName CurveName, int32 CurveFlags, ERawCurveTrackTypes SupportedCurveT... ) Returns true if successfully added, false if it was already existing.
void AddCurveKeysInternal ( UAnimSequence* AnimationSequen..., FName CurveName, const TArray< float >& Times, const TArray< DataType >& KeyData ) Curve helper functions.
void AddFloatCurveKey ( UAnimSequence* AnimationSequen..., FName CurveName, const float Time, const float Value ) Adds a Float Key to the specified Animation Curve inside of the given Animation Sequence
void AddFloatCurveKeys ( UAnimSequence* AnimationSequen..., FName CurveName, const TArray< float >& Times, const TArray< float >& Values ) Adds a multiple of Float Keys to the specified Animation Curve inside of the given Animation Sequence
void AddMetaData ( UAnimationAsset* AnimationAsse..., TSubclassOf< UAnimMetaData > MetaDa..., UAnimMetaData*& MetaDataInstan... ) Creates and Adds an instance of the specified MetaData Class to the given Animation Asset
void AddMetaDataObject ( UAnimationAsset* AnimationAsse..., UAnimMetaData* MetaDataObject ) Adds an instance of the specified MetaData Class to the given Animation Asset (requires MetaDataObject's outer to be the Animation Asset)
void AddNodeAssetOverride ( UAnimBlueprint* AnimBlueprint, const UAnimationAsset* Target, UAnimationAsset* Override, bool bPrintAppliedOverrides ) Adds an Animation Asset override for the provided AnimationBlueprint, replacing any instance of Target with Override
void AddTransformationCurveKey ( UAnimSequence* AnimationSequen..., FName CurveName, const float Time, const FTransform& Transform ) Adds a Transformation Key to the specified Animation Curve inside of the given Animation Sequence
void AddTransformationCurveKeys ( UAnimSequence* AnimationSequen..., FName CurveName, const TArray< float >& Times, const TArray< FTransform >& Transf... ) Adds a multiple of Transformation Keys to the specified Animation Curve inside of the given Animation Sequence
void AddVectorCurveKey ( UAnimSequence* AnimationSequen..., FName CurveName, const float Time, const FVector Vector ) Adds a Vector Key to the specified Animation Curve inside of the given Animation Sequence
void AddVectorCurveKeys ( UAnimSequence* AnimationSequen..., FName CurveName, const TArray< float >& Times, const TArray< FVector >& Vectors ) Adds a multiple of Vector Keys to the specified Animation Curve inside of the given Animation Sequence
void AddVirtualBone ( const UAnimSequence* Animation..., FName SourceBoneName, FName TargetBoneName, FName& VirtualBoneName ) Adds a Virtual Bone between the Source and Target Bones to the given Animation Sequence
bool ContainsMetaDataOfClass ( const UAnimationAsset* Animati..., TSubclassOf< UAnimMetaData > MetaDa... ) Checks whether or not the given Animation Asset contains Meta Data Instance of the specified Meta Data Class
void CopyAnimationCurveNamesToSkeleton ( USkeleton* OldSkeleton, USkeleton* NewSkeleton, UAnimSequenceBase* SequenceBas..., ERawCurveTrackTypes CurveType ) Ensures that any curve names that do not exist on the NewSkeleton are added to it, in which case the SmartName on the actual curve itself will also be updated
void CopyAnimNotifiesFromSequence ( UAnimSequenceBase* SourceAnima..., UAnimSequenceBase* Destination..., bool bDeleteExistingNotifies ) Copies animation notifies from Src Animation Sequence to Dest.
void DoesBoneNameExist ( UAnimSequence* AnimationSequen..., FName BoneName, bool& bExists ) Checks whether or not the given Bone Name exist on the Skeleton referenced by the given Animation Sequence
bool DoesBoneNameExistInternal ( USkeleton* Skeleton, FName BoneName )  
bool DoesCurveExist ( UAnimSequence* AnimationSequen..., FName CurveName, ERawCurveTrackTypes CurveType ) Checks whether or not the given Curve Name exist on the Skeleton referenced by the given Animation Sequence
bool DoesVirtualBoneNameExistInternal ( USkeleton* Skeleton, FName BoneName )  
bool EvaluateRootBoneTimecodeAttributesAtTime ( const UAnimSequenceBase* Anima..., const float EvalTime, FQualifiedFrameTime& OutQualifiedF... ) Evaluates timecode attributes (e.g. "TCFrame", "TCSecond", etc.) of the root bone and returns the resulting qualified frame time.
bool EvaluateRootBoneTimecodeSubframeAttributeAtTime ( const UAnimSequenceBase* Anima..., const float EvalTime, float& OutSubframe ) Evaluates the subframe timecode attribute (e.g. "TCSubframe") of the root bone and returns the resulting value.
void FindBonePathToRoot ( const UAnimSequenceBase* Anima..., FName BoneName, TArray< FName >& BonePath ) Finds the Bone Path from the given Bone to the Root Bone
void GetAdditiveAnimationType ( const UAnimSequence* Animation..., TEnumAsByte< enum EAdditiveAnimatio... ) Additive.
void GetAdditiveBasePoseType ( const UAnimSequence* Animation..., TEnumAsByte< enum EAdditiveBasePose... ) Retrieves the Additive Base Pose type for the given Animation Sequence
void GetAnimationCurveNames ( const UAnimSequence* Animation..., ERawCurveTrackTypes CurveType, TArray< FName >& CurveNames ) Retrieves the Names of the individual float curves for the given Animation Sequence
void GetAnimationGraphs ( UAnimBlueprint* AnimationBluep..., TArray< UAnimationGraph* >& A... ) Returns all Animation Graphs contained by the provided Animation Blueprint
void GetAnimationInterpolationType ( const UAnimSequence* Animation..., EAnimInterpolationType& Interpolat... ) Retrieves the Animation Interpolation type for the given Animation Sequence
void GetAnimationNotifyEventNames ( const UAnimSequenceBase* Anima..., TArray< FName >& EventNames ) Retrieves all Unique Animation Notify Events found within the given Animation Sequence
void GetAnimationNotifyEvents ( const UAnimSequenceBase* Anima..., TArray< FAnimNotifyEvent >& Notify... ) Retrieves all Animation Notify Events found within the given Animation Sequence
void GetAnimationNotifyEventsForTrack ( const UAnimSequenceBase* Anima..., FName NotifyTrackName, TArray< FAnimNotifyEvent >& Events ) Retrieves all Animation Notify Events for the given Notify Track Name from the given Animation Sequence
void GetAnimationNotifyTrackNames ( const UAnimSequenceBase* Anima..., TArray< FName >& TrackNames ) Retrieves all Unique Animation Notify Track Names found within the given Animation Sequence
void GetAnimationSyncMarkers ( const UAnimSequence* Animation..., TArray< FAnimSyncMarker >& Markers ) Retrieves all the Animation Sync Markers for the given Animation Sequence
void GetAnimationSyncMarkersForTrack ( const UAnimSequence* Animation..., FName NotifyTrackName, TArray< FAnimSyncMarker >& Markers ) Retrieves all Animation Sync Markers for the given Notify Track Name from the given Animation Sequence
void GetAnimationTrackNames ( const UAnimSequenceBase* Anima..., TArray< FName >& TrackNames ) Retrieves the Names of the individual ATracks for the given Animation Sequence
float GetAnimNotifyEventDuration ( const FAnimNotifyEvent& NotifyEven... ) Returns the duration for a NotifyEvent, only non-zero for Anim Notify States
float GetAnimNotifyEventTriggerTime ( const FAnimNotifyEvent& NotifyEven... ) Returns the actual trigger time for a NotifyEvent
void GetBoneCompressionSettings ( const UAnimSequence* Animation..., UAnimBoneCompressionSettings*&... ) Retrieves the Bone Compression Settings for the given Animation Sequence
void GetCurveCompressionSettings ( const UAnimSequence* Animation..., UAnimCurveCompressionSettings*... ) Retrieves the Curve Compression Settings for the given Animation Sequence
void GetCurveKeysInternal ( UAnimSequence* AnimationSequen..., FName CurveName, TArray< float >& Times, TArray< DataType >& KeyData )  
void GetFloatKeys ( UAnimSequence* AnimationSequen..., FName CurveName, TArray< float >& Times, TArray< float >& Values ) Retrieves, a multiple of, Float Key(s) from the specified Animation Curve inside of the given Animation Sequence
void GetFrameAtTime ( const UAnimSequenceBase* Anima..., const float Time, int32& Frame ) Retrieves the Frame Index at the specified Time Value for the given Animation Sequence
void GetMetaData ( const UAnimationAsset* Animati..., TArray< UAnimMetaData* >& Met... ) Retrieves all Meta Data Instances from the given Animation Asset
void GetMetaDataOfClass ( const UAnimationAsset* Animati..., TSubclassOf< UAnimMetaData > MetaDa..., TArray< UAnimMetaData* >& Met... ) Retrieves all Meta Data Instances from the given Animation Asset
void GetMontageSlotNames ( const UAnimMontage* AnimationM..., TArray< FName >& SlotNames ) Retrieves the Names of the Animation Slots used in the given Montage
void GetNodesOfClass ( UAnimBlueprint* AnimationBluep..., TSubclassOf< UAnimGraphNode_Base > ..., TArray< UAnimGraphNode_Base* >..., bool bIncludeChildClasses ) Returns all Animation Graph Nodes of the provided Node Class contained by the Animation Blueprint
const FAnimN... GetNotifyTrackByName ( const UAnimSequenceBase* Anima..., FName NotifyTrackName )  
void GetNumFrames ( const UAnimSequenceBase* Anima..., int32& NumFrames ) Retrieves the number of animation frames for the given Animation Sequence
void GetNumKeys ( const UAnimSequenceBase* Anima..., int32& NumKeys ) Retrieves the number of animation keys for the given Animation Sequence
void GetRateScale ( const UAnimSequenceBase* Anima..., float& RateScale ) Retrieves the (Play) Rate Scale of the given Animation Sequence
void GetRootMotionLockType ( const UAnimSequence* Animation..., TEnumAsByte< ERootMotionRootLock::T... ) Retrieves the Root Motion Lock Type for the given Animation Sequence
void GetSequenceLength ( const UAnimSequenceBase* Anima..., float& Length ) Retrieves the Length of the given Animation Sequence
void GetTimeAtFrame ( const UAnimSequenceBase* Anima..., const int32 Frame, float& Time ) Retrieves the Time Value at the specified Frame Indexfor the given Animation Sequence
float GetTimeAtFrameInternal ( const UAnimSequenceBase* Anima..., const int32 Frame )  
int32 GetTrackIndexForAnimationNotifyTrackName ( const UAnimSequenceBase* Anima..., FName NotifyTrackName )  
void GetTransformationKeys ( UAnimSequence* AnimationSequen..., FName CurveName, TArray< float >& Times, TArray< FTransform >& Values ) Retrieves, a multiple of, Transformation Key(s) from the specified Animation Curve inside of the given Animation Sequence
void GetUniqueMarkerNames ( const UAnimSequence* Animation..., TArray< FName >& MarkerNames ) Retrieves all the Unique Names for the Animation Sync Markers contained by the given Animation Sequence
void GetVariableFrameStrippingSettings ( const UAnimSequence* Animation..., UVariableFrameStrippingSettings... ) Retrieves the Variable Frame Stripping Settings for the given Animation Sequence
void GetVectorKeys ( UAnimSequence* AnimationSequen..., FName CurveName, TArray< float >& Times, TArray< FVector >& Values ) Retrieves, a multiple of, Vector Key(s) from the specified Animation Curve inside of the given Animation Sequence
bool IsRootMotionEnabled ( const UAnimSequence* Animation... ) Checks whether or not Root Motion is Enabled for the given Animation Sequence
bool IsRootMotionLockForced ( const UAnimSequence* Animation... ) Checks whether or not Root Motion locking is Forced for the given Animation Sequence
bool IsValidAnimationSyncMarkerName ( const UAnimSequence* Animation..., FName MarkerName ) Checks whether or not the given Marker Name is a valid Animation Sync Marker Name
bool IsValidAnimNotifyTrackName ( const UAnimSequenceBase* Anima..., FName NotifyTrackName ) Checks whether or not the given Track Name is a valid Animation Notify Track in the Animation Sequence
bool IsValidRawAnimationTrackName ( const UAnimSequenceBase* Anima..., const FName TrackName ) Checks whether or not the given Animation Track Name is contained within the Animation Sequence
void IsValidTime ( const UAnimSequenceBase* Anima..., const float Time, bool& IsValid ) Checks whether or not the given Time Value lies within the given Animation Sequence's Length
bool IsValidTimeInternal ( const UAnimSequenceBase* Anima..., const float Time )  
void RemoveAllAnimationNotifyTracks ( UAnimSequenceBase* AnimationSe... ) Removes All Animation Notify Tracks from Animation Sequence
void RemoveAllAnimationSyncMarkers ( UAnimSequence* AnimationSequen... ) Removes All Animation Sync Markers found within the Animation Sequence, and returns the number of removed instances
void RemoveAllBoneAnimation ( UAnimSequence* AnimationSequen... ) Removes all Animation Bone Track Data from the given Animation Sequence
void RemoveAllCurveData ( UAnimSequence* AnimationSequen... ) Removes all Animation Curve Data from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton)
void RemoveAllMetaData ( UAnimationAsset* AnimationAsse... ) Removes all Meta Data from the given Animation Asset
void RemoveAllVirtualBones ( const UAnimSequence* Animation... ) Removes all Virtual Bones from the given Animation Sequence
int32 RemoveAnimationNotifyEventsByName ( UAnimSequenceBase* AnimationSe..., FName NotifyName ) Removes Animation Notify Events found by Name within the Animation Sequence, and returns the number of removed name instances
int32 RemoveAnimationNotifyEventsByTrack ( UAnimSequenceBase* AnimationSe..., FName NotifyTrackName ) Removes Animation Notify Events found by Track within the Animation Sequence, and returns the number of removed name instances
void RemoveAnimationNotifyTrack ( UAnimSequenceBase* AnimationSe..., FName NotifyTrackName ) Removes an Animation Notify Track from Animation Sequence by Name
int32 RemoveAnimationSyncMarkersByName ( UAnimSequence* AnimationSequen..., FName MarkerName ) Removes All Animation Sync Marker found within the Animation Sequence whose name matches MarkerName, and returns the number of removed instances
int32 RemoveAnimationSyncMarkersByTrack ( UAnimSequence* AnimationSequen..., FName NotifyTrackName ) Removes All Animation Sync Marker found within the Animation Sequence that belong to the specific Notify Track, and returns the number of removed instances
void RemoveBoneAnimation ( UAnimSequence* AnimationSequen..., FName BoneName, bool bIncludeChildren, bool bFinalize ) Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton)
void RemoveCurve ( UAnimSequence* AnimationSequen..., FName CurveName, bool bRemoveNameFromSkeleton ) Removes an Animation Curve by Name from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton)
bool RemoveCurveInternal ( UAnimSequence* AnimationSequen..., FName CurveName, ERawCurveTrackTypes SupportedCurveT... )  
void RemoveMetaData ( UAnimationAsset* AnimationAsse..., UAnimMetaData* MetaDataObject ) Removes the specified Meta Data Instance from the given Animation Asset
void RemoveMetaDataOfClass ( UAnimationAsset* AnimationAsse..., TSubclassOf< UAnimMetaData > MetaDa... ) Removes all Meta Data Instance of the specified Class from the given Animation Asset
void RemoveVirtualBone ( const UAnimSequence* Animation..., FName VirtualBoneName ) Removes a Virtual Bone with the specified Bone Name from the given Animation Sequence
void RemoveVirtualBones ( const UAnimSequence* Animation..., TArray< FName > VirtualBoneNames ) Removes Virtual Bones with the specified Bone Names from the given Animation Sequence
void ReplaceAnimNotifies ( UAnimSequenceBase* AnimationSe..., TSubclassOf< UAnimNotify > OldNotif..., TSubclassOf< UAnimNotify > NewNotif..., FOnNotifyReplaced OnNotifyReplaced ) Replaces animation notifies in the specified Animation Sequence
void ReplaceAnimNotifyStates ( UAnimSequenceBase* AnimationSe..., TSubclassOf< UAnimNotifyState > Old..., TSubclassOf< UAnimNotifyState > New..., FOnNotifyStateReplaced OnNotifyStat... ) Replaces animation notifies in the specified Animation Sequence
ERawCurveTra... RetrieveCurveTypeForCurve ( const UAnimSequence* Animation..., FName CurveName )  
void SetAdditiveAnimationType ( UAnimSequence* AnimationSequen..., const TEnumAsByte< enum EAdditiveAn... ) Sets the Additive Animation type for the given Animation Sequence
void SetAdditiveBasePoseType ( UAnimSequence* AnimationSequen..., const TEnumAsByte< enum EAdditiveBa... ) Sets the Additive Base Pose type for the given Animation Sequence
void SetAnimationInterpolationType ( UAnimSequence* AnimationSequen..., EAnimInterpolationType Interpolatio... ) Sets the Animation Interpolation type for the given Animation Sequence
void SetBoneCompressionSettings ( UAnimSequence* AnimationSequen..., UAnimBoneCompressionSettings* ... ) Sets the Bone Compression Settings for the given Animation Sequence
void SetCurveCompressionSettings ( UAnimSequence* AnimationSequen..., UAnimCurveCompressionSettings*... ) Sets the Curve Compression Settings for the given Animation Sequence
void SetIsRootMotionLockForced ( UAnimSequence* AnimationSequen..., bool bForced ) Sets whether or not Root Motion locking is Forced for the given Animation Sequence
void SetRateScale ( UAnimSequenceBase* AnimationSe..., float RateScale ) Sets the (Play) Rate Scale for the given Animation Sequence
void SetRootMotionEnabled ( UAnimSequence* AnimationSequen..., bool bEnabled ) Sets whether or not Root Motion is Enabled for the given Animation Sequence
void SetRootMotionLockType ( UAnimSequence* AnimationSequen..., TEnumAsByte< ERootMotionRootLock::T... ) Sets the Root Motion Lock Type for the given Animation Sequence
void SetVariableFrameStrippingSettings ( UAnimSequence* AnimationSequen..., UVariableFrameStrippingSettings... ) Sets the Variable Frame Stripping Settings for the given Animation Sequence

Deprecated Functions

Type Name Description
bool DoesBoneCurveNameExistInternal ( USkeleton* Skeleton, FName BoneName ) This function is no longer used.
bool DoesSmartNameExist ( UAnimSequence* AnimationSequen..., FName Name ) This function is no longer used.
void FinalizeBoneAnimation ( UAnimSequence* AnimationSequen... ) FinalizeBoneAnimation has been deprecated, use UAnimDataController instead
void GetBonePoseForFrame ( const UAnimSequenceBase* Anima..., FName BoneName, int32 Frame, bool bExtractRootMotion, FTransform& Pose ) GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly
void GetBonePoseForTime ( const UAnimSequenceBase* Anima..., FName BoneName, float Time, bool bExtractRootMotion, FTransform& Pose ) GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly
void GetBonePosesForFrame ( const UAnimSequenceBase* Anima..., TArray< FName > BoneNames, int32 Frame, bool bExtractRootMotion, TArray< FTransform >& Poses, const USkeletalMesh* PreviewMe... ) GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly
void GetBonePosesForTime ( const UAnimSequenceBase* Anima..., TArray< FName > BoneNames, float Time, bool bExtractRootMotion, TArray< FTransform >& Poses, const USkeletalMesh* PreviewMe... ) GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly
const FRawAn... GetRawAnimationTrackByName ( const UAnimSequenceBase* Anima..., const FName TrackName ) GetRawAnimationTrackByName has been deprecated
void GetRawTrackData ( const UAnimSequenceBase* Anima..., const FName TrackName, TArray< FVector >& PositionKeys, TArray< FQuat >& RotationKeys, TArray< FVector >& ScalingKeys ) GetRawTrackScaleData has been deprecated, use AnimationModel interface instead
void GetRawTrackPositionData ( const UAnimSequenceBase* Anima..., const FName TrackName, TArray< FVector >& PositionData ) GetRawTrackPositionData has been deprecated, use AnimationModel interface instead
void GetRawTrackRotationData ( const UAnimSequenceBase* Anima..., const FName TrackName, TArray< FQuat >& RotationData ) GetRawTrackRotationData has been deprecated, use AnimationModel interface instead
void GetRawTrackScaleData ( const UAnimSequenceBase* Anima..., const FName TrackName, TArray< FVector >& ScaleData ) GetRawTrackScaleData has been deprecated, use AnimationModel interface instead
FName RetrieveContainerNameForCurve ( const UAnimSequence* Animation..., FName CurveName ) This function is no longer used.
FSmartName RetrieveSmartNameForCurve ( const UAnimSequence* Animation..., FName CurveName, FName ContainerName ) This function is no longer used.
bool RetrieveSmartNameForCurve ( const UAnimSequence* Animation..., FName CurveName, FName ContainerName, FSmartName& SmartName ) This function is no longer used.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library