Navigation
API > API/Editor > API/Editor/AnimationBlueprintLibrary
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UBlueprintFunctionLibrary
- UAnimationBlueprintLibrary
References
| Module | AnimationBlueprintLibrary |
| Header | /Engine/Source/Editor/AnimationBlueprintLibrary/Public/AnimationBlueprintLibrary.h |
| Include | #include "AnimationBlueprintLibrary.h" |
Syntax
class UAnimationBlueprintLibrary : public UBlueprintFunctionLibrary
Remarks
Blueprint library for altering and analyzing animation / skeletal data
Functions
| Type | Name | Description | |
|---|---|---|---|
| UAnimNotify * | AddAnimationNotifyEvent
(
UAnimSequenceBase* AnimationSequenceBase, |
Adds an Animation Notify Event to Notify track in the given Animation with the given Notify creation data | |
| void | AddAnimationNotifyEventObject
(
UAnimSequenceBase* AnimationSequenceBase, |
Adds an the specific Animation Notify to the Animation Sequence (requires Notify's outer to be the Animation Sequence) | |
| UAnimNotifyState * | AddAnimationNotifyStateEvent
(
UAnimSequenceBase* AnimationSequenceBase, |
Adds an Animation Notify State Event to Notify track in the given Animation with the given Notify State creation data | |
| void | AddAnimationNotifyStateEventObject
(
UAnimSequenceBase* AnimationSequenceBase, |
Adds an the specific Animation Notify State to the Animation Sequence (requires Notify State's outer to be the Animation Sequence) | |
| void | AddAnimationNotifyTrack
(
UAnimSequenceBase* AnimationSequenceBase, |
Adds an Animation Notify Track to the Animation Sequence | |
| void | AddAnimationSyncMarker
(
UAnimSequence* AnimationSequence, |
Adds an Animation Sync Marker to Notify track in the given Animation with the corresponding Marker Name and Time | |
| void | AddCurve
(
UAnimSequence* AnimationSequence, |
Adds an Animation Curve by Type and Name to the given Animation Sequence | |
| bool | AddCurveInternal
(
UAnimSequence* AnimationSequence, |
Returns true if successfully added, false if it was already existing. | |
| void | AddCurveKeysInternal
(
UAnimSequence* AnimationSequence, |
Curve helper functions. | |
| void | AddFloatCurveKey
(
UAnimSequence* AnimationSequence, |
Adds a Float Key to the specified Animation Curve inside of the given Animation Sequence | |
| void | AddFloatCurveKeys
(
UAnimSequence* AnimationSequence, |
Adds a multiple of Float Keys to the specified Animation Curve inside of the given Animation Sequence | |
| void | AddMetaData
(
UAnimationAsset* AnimationAsset, |
Creates and Adds an instance of the specified MetaData Class to the given Animation Asset | |
| void | AddMetaDataObject
(
UAnimationAsset* AnimationAsset, |
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, |
Adds an Animation Asset override for the provided AnimationBlueprint, replacing any instance of Target with Override | |
| void | AddTransformationCurveKey
(
UAnimSequence* AnimationSequence, |
Adds a Transformation Key to the specified Animation Curve inside of the given Animation Sequence | |
| void | AddTransformationCurveKeys
(
UAnimSequence* AnimationSequence, |
Adds a multiple of Transformation Keys to the specified Animation Curve inside of the given Animation Sequence | |
| void | AddVectorCurveKey
(
UAnimSequence* AnimationSequence, |
Adds a Vector Key to the specified Animation Curve inside of the given Animation Sequence | |
| void | AddVectorCurveKeys
(
UAnimSequence* AnimationSequence, |
Adds a multiple of Vector Keys to the specified Animation Curve inside of the given Animation Sequence | |
| void | AddVirtualBone
(
const UAnimSequence* AnimationSequence, |
Adds a Virtual Bone between the Source and Target Bones to the given Animation Sequence | |
| bool | ContainsMetaDataOfClass
(
const UAnimationAsset* AnimationAsset, |
Checks whether or not the given Animation Asset contains Meta Data Instance of the specified Meta Data Class | |
| void | CopyAnimationCurveNamesToSkeleton
(
USkeleton* OldSkeleton, |
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* SourceAnimationSequenceBase, |
Copies animation notifies from Src Animation Sequence to Dest. | |
| void | DoesBoneNameExist
(
UAnimSequence* AnimationSequence, |
Checks whether or not the given Bone Name exist on the Skeleton referenced by the given Animation Sequence | |
| bool | DoesBoneNameExistInternal
(
USkeleton* Skeleton, |
||
| bool | DoesCurveExist
(
UAnimSequence* AnimationSequence, |
Checks whether or not the given Curve Name exist on the Skeleton referenced by the given Animation Sequence | |
| bool | DoesVirtualBoneNameExistInternal
(
USkeleton* Skeleton, |
||
| bool | EvaluateRootBoneTimecodeAttributesAtTime
(
const UAnimSequenceBase* AnimationSequenceBase, |
Evaluates timecode attributes (e.g. "TCFrame", "TCSecond", etc.) of the root bone and returns the resulting qualified frame time. | |
| bool | EvaluateRootBoneTimecodeSubframeAttributeAtTime
(
const UAnimSequenceBase* AnimationSequenceBase, |
Evaluates the subframe timecode attribute (e.g. "TCSubframe") of the root bone and returns the resulting value. | |
| void | FindBonePathToRoot
(
const UAnimSequenceBase* AnimationSequenceBase, |
Finds the Bone Path from the given Bone to the Root Bone | |
| void | GetAdditiveAnimationType
(
const UAnimSequence* AnimationSequence, |
Additive. | |
| void | GetAdditiveBasePoseType
(
const UAnimSequence* AnimationSequence, |
Retrieves the Additive Base Pose type for the given Animation Sequence | |
| void | GetAnimationCurveNames
(
const UAnimSequence* AnimationSequence, |
Retrieves the Names of the individual float curves for the given Animation Sequence | |
| void | GetAnimationGraphs
(
UAnimBlueprint* AnimationBlueprint, |
Returns all Animation Graphs contained by the provided Animation Blueprint | |
| void | GetAnimationInterpolationType
(
const UAnimSequence* AnimationSequence, |
Retrieves the Animation Interpolation type for the given Animation Sequence | |
| void | GetAnimationNotifyEventNames
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves all Unique Animation Notify Events found within the given Animation Sequence | |
| void | GetAnimationNotifyEvents
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves all Animation Notify Events found within the given Animation Sequence | |
| void | GetAnimationNotifyEventsForTrack
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves all Animation Notify Events for the given Notify Track Name from the given Animation Sequence | |
| void | GetAnimationNotifyTrackNames
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves all Unique Animation Notify Track Names found within the given Animation Sequence | |
| void | GetAnimationSyncMarkers
(
const UAnimSequence* AnimationSequence, |
Retrieves all the Animation Sync Markers for the given Animation Sequence | |
| void | GetAnimationSyncMarkersForTrack
(
const UAnimSequence* AnimationSequence, |
Retrieves all Animation Sync Markers for the given Notify Track Name from the given Animation Sequence | |
| void | GetAnimationTrackNames
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the Names of the individual ATracks for the given Animation Sequence | |
| float | GetAnimNotifyEventDuration
(
const FAnimNotifyEvent& NotifyEvent |
Returns the duration for a NotifyEvent, only non-zero for Anim Notify States | |
| float | GetAnimNotifyEventTriggerTime
(
const FAnimNotifyEvent& NotifyEvent |
Returns the actual trigger time for a NotifyEvent | |
| void | GetBoneCompressionSettings
(
const UAnimSequence* AnimationSequence, |
Retrieves the Bone Compression Settings for the given Animation Sequence | |
| void | GetCurveCompressionSettings
(
const UAnimSequence* AnimationSequence, |
Retrieves the Curve Compression Settings for the given Animation Sequence | |
| void | GetCurveKeysInternal
(
UAnimSequence* AnimationSequence, |
||
| void | GetFloatKeys
(
UAnimSequence* AnimationSequence, |
Retrieves, a multiple of, Float Key(s) from the specified Animation Curve inside of the given Animation Sequence | |
| void | GetFrameAtTime
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the Frame Index at the specified Time Value for the given Animation Sequence | |
| void | GetMetaData
(
const UAnimationAsset* AnimationAsset, |
Retrieves all Meta Data Instances from the given Animation Asset | |
| void | GetMetaDataOfClass
(
const UAnimationAsset* AnimationAsset, |
Retrieves all Meta Data Instances from the given Animation Asset | |
| void | GetMontageSlotNames
(
const UAnimMontage* AnimationMontage, |
Retrieves the Names of the Animation Slots used in the given Montage | |
| void | GetNodesOfClass
(
UAnimBlueprint* AnimationBlueprint, |
Returns all Animation Graph Nodes of the provided Node Class contained by the Animation Blueprint | |
| const FAnimNotifyTrack & | GetNotifyTrackByName
(
const UAnimSequenceBase* AnimationSequenceBase, |
||
| void | GetNumFrames
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the number of animation frames for the given Animation Sequence | |
| void | GetNumKeys
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the number of animation keys for the given Animation Sequence | |
| void | GetRateScale
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the (Play) Rate Scale of the given Animation Sequence | |
| void | GetRootMotionLockType
(
const UAnimSequence* AnimationSequence, |
Retrieves the Root Motion Lock Type for the given Animation Sequence | |
| void | GetSequenceLength
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the Length of the given Animation Sequence | |
| void | GetTimeAtFrame
(
const UAnimSequenceBase* AnimationSequenceBase, |
Retrieves the Time Value at the specified Frame Indexfor the given Animation Sequence | |
| float | GetTimeAtFrameInternal
(
const UAnimSequenceBase* AnimationSequenceBase, |
||
| int32 | GetTrackIndexForAnimationNotifyTrackName
(
const UAnimSequenceBase* AnimationSequenceBase, |
||
| void | GetTransformationKeys
(
UAnimSequence* AnimationSequence, |
Retrieves, a multiple of, Transformation Key(s) from the specified Animation Curve inside of the given Animation Sequence | |
| void | GetUniqueMarkerNames
(
const UAnimSequence* AnimationSequence, |
Retrieves all the Unique Names for the Animation Sync Markers contained by the given Animation Sequence | |
| void | GetVariableFrameStrippingSettings
(
const UAnimSequence* AnimationSequence, |
Retrieves the Variable Frame Stripping Settings for the given Animation Sequence | |
| void | GetVectorKeys
(
UAnimSequence* AnimationSequence, |
Retrieves, a multiple of, Vector Key(s) from the specified Animation Curve inside of the given Animation Sequence | |
| bool | IsRootMotionEnabled
(
const UAnimSequence* AnimationSequence |
Checks whether or not Root Motion is Enabled for the given Animation Sequence | |
| bool | IsRootMotionLockForced
(
const UAnimSequence* AnimationSequence |
Checks whether or not Root Motion locking is Forced for the given Animation Sequence | |
| bool | IsValidAnimationSyncMarkerName
(
const UAnimSequence* AnimationSequence, |
Checks whether or not the given Marker Name is a valid Animation Sync Marker Name | |
| bool | IsValidAnimNotifyTrackName
(
const UAnimSequenceBase* AnimationSequenceBase, |
Checks whether or not the given Track Name is a valid Animation Notify Track in the Animation Sequence | |
| bool | IsValidRawAnimationTrackName
(
const UAnimSequenceBase* AnimationSequenceBase, |
Checks whether or not the given Animation Track Name is contained within the Animation Sequence | |
| void | IsValidTime
(
const UAnimSequenceBase* AnimationSequenceBase, |
Checks whether or not the given Time Value lies within the given Animation Sequence's Length | |
| bool | IsValidTimeInternal
(
const UAnimSequenceBase* AnimationSequenceBase, |
||
| void | RemoveAllAnimationNotifyTracks
(
UAnimSequenceBase* AnimationSequenceBase |
Removes All Animation Notify Tracks from Animation Sequence | |
| void | RemoveAllAnimationSyncMarkers
(
UAnimSequence* AnimationSequence |
Removes All Animation Sync Markers found within the Animation Sequence, and returns the number of removed instances | |
| void | RemoveAllBoneAnimation
(
UAnimSequence* AnimationSequence |
Removes all Animation Bone Track Data from the given Animation Sequence | |
| void | RemoveAllCurveData
(
UAnimSequence* AnimationSequence |
Removes all Animation Curve Data from the given Animation Sequence (Raw Animation Curves [Names] may not be removed from the Skeleton) | |
| void | RemoveAllMetaData
(
UAnimationAsset* AnimationAsset |
Removes all Meta Data from the given Animation Asset | |
| void | RemoveAllVirtualBones
(
const UAnimSequence* AnimationSequence |
Removes all Virtual Bones from the given Animation Sequence | |
| int32 | RemoveAnimationNotifyEventsByName
(
UAnimSequenceBase* AnimationSequenceBase, |
Removes Animation Notify Events found by Name within the Animation Sequence, and returns the number of removed name instances | |
| int32 | RemoveAnimationNotifyEventsByTrack
(
UAnimSequenceBase* AnimationSequenceBase, |
Removes Animation Notify Events found by Track within the Animation Sequence, and returns the number of removed name instances | |
| void | RemoveAnimationNotifyTrack
(
UAnimSequenceBase* AnimationSequenceBase, |
Removes an Animation Notify Track from Animation Sequence by Name | |
| int32 | RemoveAnimationSyncMarkersByName
(
UAnimSequence* AnimationSequence, |
Removes All Animation Sync Marker found within the Animation Sequence whose name matches MarkerName, and returns the number of removed instances | |
| int32 | RemoveAnimationSyncMarkersByTrack
(
UAnimSequence* AnimationSequence, |
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* AnimationSequence, |
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* AnimationSequence, |
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* AnimationSequence, |
||
| void | RemoveMetaData
(
UAnimationAsset* AnimationAsset, |
Removes the specified Meta Data Instance from the given Animation Asset | |
| void | RemoveMetaDataOfClass
(
UAnimationAsset* AnimationAsset, |
Removes all Meta Data Instance of the specified Class from the given Animation Asset | |
| void | RemoveVirtualBone
(
const UAnimSequence* AnimationSequence, |
Removes a Virtual Bone with the specified Bone Name from the given Animation Sequence | |
| void | RemoveVirtualBones
(
const UAnimSequence* AnimationSequence, |
Removes Virtual Bones with the specified Bone Names from the given Animation Sequence | |
| void | ReplaceAnimNotifies
(
UAnimSequenceBase* AnimationSequenceBase, |
Replaces animation notifies in the specified Animation Sequence | |
| void | ReplaceAnimNotifyStates
(
UAnimSequenceBase* AnimationSequenceBase, |
Replaces animation notifies in the specified Animation Sequence | |
| ERawCurveTrackTypes | RetrieveCurveTypeForCurve
(
const UAnimSequence* AnimationSequence, |
||
| void | SetAdditiveAnimationType
(
UAnimSequence* AnimationSequence, |
Sets the Additive Animation type for the given Animation Sequence | |
| void | SetAdditiveBasePoseType
(
UAnimSequence* AnimationSequence, |
Sets the Additive Base Pose type for the given Animation Sequence | |
| void | SetAnimationInterpolationType
(
UAnimSequence* AnimationSequence, |
Sets the Animation Interpolation type for the given Animation Sequence | |
| void | SetBoneCompressionSettings
(
UAnimSequence* AnimationSequence, |
Sets the Bone Compression Settings for the given Animation Sequence | |
| void | SetCurveCompressionSettings
(
UAnimSequence* AnimationSequence, |
Sets the Curve Compression Settings for the given Animation Sequence | |
| void | SetIsRootMotionLockForced
(
UAnimSequence* AnimationSequence, |
Sets whether or not Root Motion locking is Forced for the given Animation Sequence | |
| void | SetRateScale
(
UAnimSequenceBase* AnimationSequenceBase, |
Sets the (Play) Rate Scale for the given Animation Sequence | |
| void | SetRootMotionEnabled
(
UAnimSequence* AnimationSequence, |
Sets whether or not Root Motion is Enabled for the given Animation Sequence | |
| void | SetRootMotionLockType
(
UAnimSequence* AnimationSequence, |
Sets the Root Motion Lock Type for the given Animation Sequence | |
| void | SetVariableFrameStrippingSettings
(
UAnimSequence* AnimationSequence, |
Sets the Variable Frame Stripping Settings for the given Animation Sequence |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | DoesBoneCurveNameExistInternal
(
USkeleton* Skeleton, |
This function is no longer used. | |
| bool | DoesSmartNameExist
(
UAnimSequence* AnimationSequence, |
This function is no longer used. | |
| void | FinalizeBoneAnimation
(
UAnimSequence* AnimationSequence |
FinalizeBoneAnimation has been deprecated, use UAnimDataController instead | |
| void | GetBonePoseForFrame
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly | |
| void | GetBonePoseForTime
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly | |
| void | GetBonePosesForFrame
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly | |
| void | GetBonePosesForTime
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetBonePosesForTime is deprecated, use AnimPose or AnimationDataModel interface directly | |
| const FRawAnimSequenceTrack & | GetRawAnimationTrackByName
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetRawAnimationTrackByName has been deprecated | |
| void | GetRawTrackData
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetRawTrackScaleData has been deprecated, use AnimationModel interface instead | |
| void | GetRawTrackPositionData
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetRawTrackPositionData has been deprecated, use AnimationModel interface instead | |
| void | GetRawTrackRotationData
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetRawTrackRotationData has been deprecated, use AnimationModel interface instead | |
| void | GetRawTrackScaleData
(
const UAnimSequenceBase* AnimationSequenceBase, |
GetRawTrackScaleData has been deprecated, use AnimationModel interface instead | |
| FName | RetrieveContainerNameForCurve
(
const UAnimSequence* AnimationSequence, |
This function is no longer used. | |
| FSmartName | RetrieveSmartNameForCurve
(
const UAnimSequence* AnimationSequence, |
This function is no longer used. | |
| bool | RetrieveSmartNameForCurve
(
const UAnimSequence* AnimationSequence, |
This function is no longer used. |