UAnimationBlueprintLibrary

Blueprint library for altering and analyzing animation / skeletal data

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AnimationModifiers

Header

/Engine/Source/Editor/AnimationModifiers/Public/AnimationBlueprintLibrary.h

Include

#include "AnimationBlueprintLibrary.h"

Syntax

class UAnimationBlueprintLibrary : public UBlueprintFunctionLibrary

Remarks

Blueprint library for altering and analyzing animation / skeletal data

Functions

Name Description

Public function Static

UAnimNotify ...

 

AddAnimationNotifyEvent

(
    UAnimSequence* AnimationSequen...,
    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

Public function Static

void

 

AddAnimationNotifyEventObject

(
    UAnimSequence* AnimationSequen...,
    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)

Public function Static

UAnimNotifyS...

 

AddAnimationNotifyStateEvent

(
    UAnimSequence* AnimationSequen...,
    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

Public function Static

void

 

AddAnimationNotifyStateEventObject

(
    UAnimSequence* AnimationSequen...,
    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)

Public function Static

void

 

AddAnimationNotifyTrack

(
    UAnimSequence* AnimationSequen...,
    FName NotifyTrackName,
    FLinearColor TrackColor
)

Adds an Animation Notify Track to the Animation Sequence

Public function Static

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

Public function Static

void

 

AddCurve

(
    UAnimSequence* AnimationSequen...,
    FName CurveName,
    ERawCurveTrackTypes CurveType,
    bool bMetaDataCurve
)

Adds an Animation Curve by Type and Name to the given Animation Sequence

Public function Static

bool

 

AddCurveInternal

(
    UAnimSequence* AnimationSequen...,
    FName CurveName,
    FName ContainerName,
    int32 CurveFlags,
    ERawCurveTrackTypes SupportedCurveT...
)

Returns true if successfully added, false if it was already existing.

Public function Static

void

 

AddCurveKeysInternal

(
    UAnimSequence* AnimationSequen...,
    FName CurveName,
    const TArray< float >& Times,
    const TArray< DataType >& KeyData,
    ERawCurveTrackTypes CurveType
)

Curve helper functions.

Public function Static

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

Public function Static

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

Public function Static

void

 

AddMetaData

(
    UAnimSequence* AnimationSequen...,
    TSubclassOf< UAnimMetaData > MetaDa...,
    UAnimMetaData*& MetaDataInstan...
)

Creates and Adds an instance of the specified MetaData Class to the given Animation Sequence

Public function Static

void

 

AddMetaDataObject

(
    UAnimSequence* AnimationSequen...,
    UAnimMetaData* MetaDataObject
)

Adds an instance of the specified MetaData Class to the given Animation Sequence (requires MetaDataObject's outer to be the Animation Sequence)

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

bool

 

ContainsMetaDataOfClass

(
    const UAnimSequence* Animation...,
    TSubclassOf< UAnimMetaData > MetaDa...
)

Checks whether or not the given Animation Sequences contains Meta Data Instance of the specified Meta Data Class

Public function Static

void

 

CopyAnimNotifiesFromSequence

(
    UAnimSequence* SrcAnimSequence,
    UAnimSequence* DestAnimSequenc...
)

Copies animation notifies from Src Animation Sequence to Dest.

Public function Static

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

Public function Static

bool

 

DoesBoneNameExistInternal

(
    USkeleton* Skeleton,
    FName BoneName
)

Public function Static

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

Public function Static

bool

 

DoesSmartNameExist

(
    UAnimSequence* AnimationSequen...,
    FName Name
)

Public function Static

bool

 

DoesVirtualBoneNameExistInternal

(
    USkeleton* Skeleton,
    FName BoneName
)

Public function Static

void

 

FinalizeBoneAnimation

(
    UAnimSequence* AnimationSequen...
)

Apply all the changes made to Bone Tracks to Finalize.

Public function Static

void

 

FindBonePathToRoot

(
    const UAnimSequence* Animation...,
    FName BoneName,
    TArray< FName >& BonePath
)

Finds the Bone Path from the given Bone to the Root Bone

Public function Static

void

 

GetAdditiveAnimationType

(
    const UAnimSequence* Animation...,
    TEnumAsByte< enum EAdditiveAnimatio...
)

Additive.

Public function Static

void

 

GetAdditiveBasePoseType

(
    const UAnimSequence* Animation...,
    TEnumAsByte< enum EAdditiveBasePose...
)

Retrieves the Additive Base Pose type for the given Animation Sequence

Public function Static

void

 

GetAnimationInterpolationType

(
    const UAnimSequence* Animation...,
    EAnimInterpolationType& Interpolat...
)

Retrieves the Animation Interpolation type for the given Animation Sequence

Public function Static

void

 

GetAnimationNotifyEventNames

(
    const UAnimSequence* Animation...,
    TArray< FName >& EventNames
)

Retrieves all Unique Animation Notify Events found within the given Animation Sequence

Public function Static

void

 

GetAnimationNotifyEvents

(
    const UAnimSequence* Animation...,
    TArray< FAnimNotifyEvent >& Notify...
)

Retrieves all Animation Notify Events found within the given Animation Sequence

Public function Static

void

 

GetAnimationNotifyEventsForTrack

(
    const UAnimSequence* Animation...,
    FName NotifyTrackName,
    TArray< FAnimNotifyEvent >& Events
)

Retrieves all Animation Notify Events for the given Notify Track Name from the given Animation Sequence

Public function Static

void

 

GetAnimationNotifyTrackNames

(
    const UAnimSequence* Animation...,
    TArray< FName >& TrackNames
)

Retrieves all Unique Animation Notify Track Names found within the given Animation Sequence

Public function Static

void

 

GetAnimationSyncMarkers

(
    const UAnimSequence* Animation...,
    TArray< FAnimSyncMarker >& Markers
)

Retrieves all the Animation Sync Markers for the given Animation Sequence

Public function Static

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

Public function Static

void

 

GetAnimationTrackNames

(
    const UAnimSequence* Animation...,
    TArray< FName >& TrackNames
)

Retrieves the Names of the individual ATracks for the given Animation Sequence

Public function Static

float

 

GetAnimNotifyEventTriggerTime

(
    const FAnimNotifyEvent& NotifyEven...
)

Returns the actual trigger time for a NotifyEvent

Public function Static

void

 

GetBoneCompressionSettings

(
    const UAnimSequence* Animation...,
    UAnimBoneCompressionSettings*&...
)

Retrieves the Bone Compression Settings for the given Animation Sequence

Public function Static

void

 

GetBonePoseForFrame

(
    const UAnimSequence* Animation...,
    FName BoneName,
    int32 Frame,
    bool bExtractRootMotion,
    FTransform& Pose
)

Retrieves Bone Pose data for the given Bone Name at the specified Frame from the given Animation Sequence

Public function Static

void

 

GetBonePoseForTime

(
    const UAnimSequence* Animation...,
    FName BoneName,
    float Time,
    bool bExtractRootMotion,
    FTransform& Pose
)

Retrieves Bone Pose data for the given Bone Name at the specified Time from the given Animation Sequence

Public function Static

void

 

GetBonePosesForFrame

(
    const UAnimSequence* Animation...,
    TArray< FName > BoneNames,
    int32 Frame,
    bool bExtractRootMotion,
    TArray< FTransform >& Poses,
    const USkeletalMesh* PreviewMe...
)

Retrieves Bone Pose data for the given Bone Names at the specified Frame from the given Animation Sequence

Public function Static

void

 

GetBonePosesForTime

(
    const UAnimSequence* Animation...,
    TArray< FName > BoneNames,
    float Time,
    bool bExtractRootMotion,
    TArray< FTransform >& Poses,
    const USkeletalMesh* PreviewMe...
)

Retrieves Bone Pose data for the given Bone Names at the specified Time from the given Animation Sequence

Public function Static

void

 

GetCurveCompressionSettings

(
    const UAnimSequence* Animation...,
    UAnimCurveCompressionSettings*...
)

Retrieves the Curve Compression Settings for the given Animation Sequence

Public function Static

void

 

GetCurveKeysInternal

(
    UAnimSequence* AnimationSequen...,
    FName CurveName,
    TArray< float >& Times,
    TArray< DataType >& KeyData,
    ERawCurveTrackTypes CurveType
)

Public function Static

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

Public function Static

void

 

GetFrameAtTime

(
    const UAnimSequence* Animation...,
    const float Time,
    int32& Frame
)

Retrieves the Frame Index at the specified Time Value for the given Animation Sequence

Public function Static

void

 

GetMetaData

(
    const UAnimSequence* Animation...,
    TArray< UAnimMetaData* >& Met...
)

Retrieves all Meta Data Instances from the given Animation Sequence

Public function Static

void

 

GetMetaDataOfClass

(
    const UAnimSequence* Animation...,
    TSubclassOf< UAnimMetaData > MetaDa...,
    TArray< UAnimMetaData* >& Met...
)

Retrieves all Meta Data Instances from the given Animation Sequence

Public function Static

const FAnimN...

 

GetNotifyTrackByName

(
    const UAnimSequence* Animation...,
    FName NotifyTrackName
)

Public function Static

void

 

GetNumFrames

(
    const UAnimSequence* Animation...,
    int32& NumFrames
)

Retrieves the number of animation frames for the given Animation Sequence

Public function Static

void

 

GetRateScale

(
    const UAnimSequence* Animation...,
    float& RateScale
)

Retrieves the (Play) Rate Scale of the given Animation Sequence

Public function Static

const FRawAn...

 

GetRawAnimationTrackByName

(
    const UAnimSequence* Animation...,
    const FName TrackName
)

Public function Static

void

 

GetRawTrackData

(
    const UAnimSequence* Animation...,
    const FName TrackName,
    TArray< FVector >& PositionKeys,
    TArray< FQuat >& RotationKeys,
    TArray< FVector >& ScalingKeys
)

Retrieves the Raw Animation Data for the given Animation Track Name and Animation Sequence

Public function Static

void

 

GetRawTrackPositionData

(
    const UAnimSequence* Animation...,
    const FName TrackName,
    TArray< FVector >& PositionData
)

Retrieves the Raw Translation Animation Data for the given Animation Track Name and Animation Sequence

Public function Static

void

 

GetRawTrackRotationData

(
    const UAnimSequence* Animation...,
    const FName TrackName,
    TArray< FQuat >& RotationData
)

Retrieves the Raw Rotation Animation Data for the given Animation Track Name and Animation Sequence

Public function Static

void

 

GetRawTrackScaleData

(
    const UAnimSequence* Animation...,
    const FName TrackName,
    TArray< FVector >& ScaleData
)

Retrieves the Raw Scale Animation Data for the given Animation Track Name and Animation Sequence

Public function Static

void

 

GetRootMotionLockType

(
    const UAnimSequence* Animation...,
    TEnumAsByte< ERootMotionRootLock::T...
)

Retrieves the Root Motion Lock Type for the given Animation Sequence

Public function Static

void

 

GetSequenceLength

(
    const UAnimSequence* Animation...,
    float& Length
)

Retrieves the Length of the given Animation Sequence

Public function Static

void

 

GetTimeAtFrame

(
    const UAnimSequence* Animation...,
    const int32 Frame,
    float& Time
)

Retrieves the Time Value at the specified Frame Indexfor the given Animation Sequence

Public function Static

float

 

GetTimeAtFrameInternal

(
    const UAnimSequence* Animation...,
    const int32 Frame
)

Public function Static

int32

 

GetTrackIndexForAnimationNotifyTrackName

(
    const UAnimSequence* Animation...,
    FName NotifyTrackName
)

Public function Static

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

Public function Static

void

 

GetUniqueMarkerNames

(
    const UAnimSequence* Animation...,
    TArray< FName >& MarkerNames
)

Retrieves all the Unique Names for the Animation Sync Markers contained by the given Animation Sequence

Public function Static

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

Public function Static

bool

 

IsRootMotionEnabled

(
    const UAnimSequence* Animation...
)

Checks whether or not Root Motion is Enabled for the given Animation Sequence

Public function Static

bool

 

IsRootMotionLockForced

(
    const UAnimSequence* Animation...
)

Checks whether or not Root Motion locking is Forced for the given Animation Sequence

Public function Static

bool

 

IsValidAnimationSyncMarkerName

(
    const UAnimSequence* Animation...,
    FName MarkerName
)

Checks whether or not the given Marker Name is a valid Animation Sync Marker Name

Public function Static

bool

 

IsValidAnimNotifyTrackName

(
    const UAnimSequence* Animation...,
    FName NotifyTrackName
)

Checks whether or not the given Track Name is a valid Animation Notify Track in the Animation Sequence

Public function Static

bool

 

IsValidRawAnimationTrackName

(
    const UAnimSequence* Animation...,
    const FName TrackName
)

Checks whether or not the given Animation Track Name is contained within the Animation Sequence

Public function Static

void

 

IsValidTime

(
    const UAnimSequence* Animation...,
    const float Time,
    bool& IsValid
)

Checks whether or not the given Time Value lies within the given Animation Sequence's Length

Public function Static

bool

 

IsValidTimeInternal

(
    const UAnimSequence* Animation...,
    const float Time
)

Public function Static

void

 

RemoveAllAnimationNotifyTracks

(
    UAnimSequence* AnimationSequen...
)

Removes All Animation Notify Tracks from Animation Sequence

Public function Static

void

 

RemoveAllAnimationSyncMarkers

(
    UAnimSequence* AnimationSequen...
)

Removes All Animation Sync Markers found within the Animation Sequence, and returns the number of removed instances

Public function Static

void

 

RemoveAllBoneAnimation

(
    UAnimSequence* AnimationSequen...
)

Removes all Animation Bone Track Data from the given Animation Sequence

Public function Static

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)

Public function Static

void

 

RemoveAllMetaData

(
    UAnimSequence* AnimationSequen...
)

Removes all Meta Data from the given Animation Sequence

Public function Static

void

 

RemoveAllVirtualBones

(
    const UAnimSequence* Animation...
)

Removes all Virtual Bones from the given Animation Sequence

Public function Static

int32

 

RemoveAnimationNotifyEventsByName

(
    UAnimSequence* AnimationSequen...,
    FName NotifyName
)

Removes Animation Notify Events found by Name within the Animation Sequence, and returns the number of removed name instances

Public function Static

int32

 

RemoveAnimationNotifyEventsByTrack

(
    UAnimSequence* AnimationSequen...,
    FName NotifyTrackName
)

Removes Animation Notify Events found by Track within the Animation Sequence, and returns the number of removed name instances

Public function Static

void

 

RemoveAnimationNotifyTrack

(
    UAnimSequence* AnimationSequen...,
    FName NotifyTrackName
)

Removes an Animation Notify Track from Animation Sequence by Name

Public function Static

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

Public function Static

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

Public function Static

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)

Public function Static

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)

Public function Static

bool

 

RemoveCurveInternal

(
    UAnimSequence* AnimationSequen...,
    FName CurveName,
    FName ContainerName,
    bool bRemoveNameFromSkeleton
)

Public function Static

void

 

RemoveMetaData

(
    UAnimSequence* AnimationSequen...,
    UAnimMetaData* MetaDataObject
)

Removes the specified Meta Data Instance from the given Animation Sequence

Public function Static

void

 

RemoveMetaDataOfClass

(
    UAnimSequence* AnimationSequen...,
    TSubclassOf< UAnimMetaData > MetaDa...
)

Removes all Meta Data Instance of the specified Class from the given Animation Sequence

Public function Static

void

 

RemoveVirtualBone

(
    const UAnimSequence* Animation...,
    FName VirtualBoneName
)

Removes a Virtual Bone with the specified Bone Name from the given Animation Sequence

Public function Static

void

 

RemoveVirtualBones

(
    const UAnimSequence* Animation...,
    TArray< FName > VirtualBoneNames
)

Removes Virtual Bones with the specified Bone Names from the given Animation Sequence

Public function Static

void

 

ReplaceAnimNotifies

(
    UAnimSequenceBase* AnimationSe...,
    TSubclassOf< UAnimNotify > OldNotif...,
    TSubclassOf< UAnimNotify > NewNotif...,
    FOnNotifyReplaced OnNotifyReplaced
)

Replaces animation notifies in the specified Animation Sequence

Public function Static

void

 

ReplaceAnimNotifyStates

(
    UAnimSequenceBase* AnimationSe...,
    TSubclassOf< UAnimNotifyState > Old...,
    TSubclassOf< UAnimNotifyState > New...,
    FOnNotifyStateReplaced OnNotifyStat...
)

Replaces animation notifies in the specified Animation Sequence

Public function Static

FName

 

RetrieveContainerNameForCurve

(
    const UAnimSequence* Animation...,
    FName CurveName
)

Public function Static

FSmartName

 

RetrieveSmartNameForCurve

(
    const UAnimSequence* Animation...,
    FName CurveName,
    FName ContainerName
)

Public function Static

bool

 

RetrieveSmartNameForCurve

(
    const UAnimSequence* Animation...,
    FName CurveName,
    FName ContainerName,
    FSmartName& SmartName
)

Public function Static

void

 

SetAdditiveAnimationType

(
    UAnimSequence* AnimationSequen...,
    const TEnumAsByte< enum EAdditiveAn...
)

Sets the Additive Animation type for the given Animation Sequence

Public function Static

void

 

SetAdditiveBasePoseType

(
    UAnimSequence* AnimationSequen...,
    const TEnumAsByte< enum EAdditiveBa...
)

Sets the Additive Base Pose type for the given Animation Sequence

Public function Static

void

 

SetAnimationInterpolationType

(
    UAnimSequence* AnimationSequen...,
    EAnimInterpolationType Interpolatio...
)

Sets the Animation Interpolation type for the given Animation Sequence

Public function Static

void

 

SetBoneCompressionSettings

(
    UAnimSequence* AnimationSequen...,
    UAnimBoneCompressionSettings* ...
)

Sets the Bone Compression Settings for the given Animation Sequence

Public function Static

void

 

SetCurveCompressionSettings

(
    UAnimSequence* AnimationSequen...,
    UAnimCurveCompressionSettings*...
)

Sets the Curve Compression Settings for the given Animation Sequence

Public function Static

void

 

SetIsRootMotionLockForced

(
    UAnimSequence* AnimationSequen...,
    bool bForced
)

Sets whether or not Root Motion locking is Forced for the given Animation Sequence

Public function Static

void

 

SetRateScale

(
    UAnimSequence* AnimationSequen...,
    float RateScale
)

Sets the (Play) Rate Scale for the given Animation Sequence

Public function Static

void

 

SetRootMotionEnabled

(
    UAnimSequence* AnimationSequen...,
    bool bEnabled
)

Sets whether or not Root Motion is Enabled for the given Animation Sequence

Public function Static

void

 

SetRootMotionLockType

(
    UAnimSequence* AnimationSequen...,
    TEnumAsByte< ERootMotionRootLock::T...
)

Sets the Root Motion Lock Type for the given Animation Sequence

Constants

Name

Description

SmartContainerNames
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss