Navigation
API > API/Plugins > API/Plugins/AnimDatabase
A blueprint library providing functions for writing back frame attribute data into an animation database.
This library provides something akin to AnimModifiers, where it becomes possible to write an asset action which can extract some frame attributes and then write these back to the animation data either in the form of AnimNotifies, AnimNotifyStates, Curves, or modifications to bone transforms. This method of AnimModifiers is far more efficient as it can be scripted via blueprints but still perform processing in batch.
| Name | UAnimDatabaseLibrary |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Animation/AnimDatabase/Source/AnimDatabase/Public/AnimDatabase.h |
| Include Path | #include "AnimDatabase.h" |
Syntax
UCLASS (BlueprintType)
class UAnimDatabaseLibrary : public UBlueprintFunctionLibrary
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UAnimDatabaseLibrary
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddAnimNotifiesToSequence
(
UAnimSequence* AnimSequence, |
Adds AnimNotifies of the provided class to a sequence at the given times | AnimDatabase.h |
|
static void AddAnimNotifiesToSequenceArrayView
(
UAnimSequence* AnimSequence, |
AnimDatabase.h |
|
|
static void AddAnimNotifyStatesToSequence
(
UAnimSequence* AnimSequence, |
Adds AnimNotifyStates of the provided class to a sequence at the given times with the given durations | AnimDatabase.h |
|
static void AddAnimNotifyStatesToSequenceArrayView
(
UAnimSequence* AnimSequence, |
AnimDatabase.h |
|
|
static void DatabaseAddAnimNotifies
(
UAnimDatabase* Database, |
Create AnimNotifies at the provided Frames in the database using the given track names and classes | AnimDatabase.h |
|
static void DatabaseAddAnimNotifiesFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseAddAnimNotify
(
UAnimDatabase* Database, |
Create AnimNotifies at the provided Frames in the database using the given track name and class | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyObject
(
UAnimDatabase* Database, |
Create AnimNotifies at the provided Frames from a duplicate of the given AnimNotify | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyObjects
(
UAnimDatabase* Database, |
Create AnimNotifies at the provided Frames in the database using the given track names and duplicates of the given AnimNotifies | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyObjectsFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseAddAnimNotifyState
(
UAnimDatabase* Database, |
Create AnimNotifyStates at the provided FrameRanges in the database using the given track name and class | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyStateObject
(
UAnimDatabase* Database, |
Create AnimNotifyStates at the provided FrameRanges from a duplicate of the given AnimNotifyState | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyStateObjects
(
UAnimDatabase* Database, |
Create AnimNotifyStates at the provided FrameRanges in the database using the given track names and duplicates of the given AnimNotifyStates | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyStateObjectsFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseAddAnimNotifyStates
(
UAnimDatabase* Database, |
Create AnimNotifyStates at the provided FrameRanges in the database using the given track names and classes | AnimDatabase.h |
|
static void DatabaseAddAnimNotifyStatesFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseAddCurve
(
UAnimDatabase* Database, |
Write the provided float frame attribute back to the animations in the database with the given curve name | AnimDatabase.h |
|
static void DatabaseAddCurves
(
UAnimDatabase* Database, |
Write the provided float frame attributes back to the animations in the database with the given curve names | AnimDatabase.h |
|
static void DatabaseAddCurvesFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseAddSyncMarker
(
UAnimDatabase* Database, |
Create SyncMarkers at the provided Frames in the database using the given track name and sync marker name | AnimDatabase.h |
|
static void DatabaseAddSyncMarkers
(
UAnimDatabase* Database, |
Create SyncMarkers at the provided Frames in the database using the given track names and sync marker names | AnimDatabase.h |
|
static void DatabaseAddSyncMarkersFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseExportAsAnimSequences
(
UAnimDatabase* Database, |
Exports the given frame ranges in the database as AnimSequences into the provided path | AnimDatabase.h |
|
static void DatabaseExportAsBVH
(
UAnimDatabase* Database, |
Exports the given frame ranges in the database as BVH files into the provided directory | AnimDatabase.h |
|
static void DatabaseExportNotifies
(
UAnimDatabase* Database, |
Exports all AnimNotifies and AnimNotifyStates as JSON | AnimDatabase.h |
|
static void DatabaseExportRootMotion
(
UAnimDatabase* Database, |
Exports the root motion of given frame ranges in the database as a JSON file | AnimDatabase.h |
|
static void DatabaseImportFromBVH
(
UAnimDatabase* Database, |
Imports all the BVH files from the given ImportPath directory into the AssetPath directory and adds them to the database | AnimDatabase.h |
|
static void DatabaseImportNotifies
(
UAnimDatabase* Database, |
Imports AnimNotifies and AnimNotifyStates from a JSON file | AnimDatabase.h |
|
static void DatabaseMakeLooped
(
UAnimDatabase* Database, |
Makes the given ranges looped in the database | AnimDatabase.h |
|
static void DatabaseModifyPoseData
(
UAnimDatabase* Database, |
Uses the provided function to modify the database pose data | AnimDatabase.h | |
static void DatabasePatchRanges
(
UAnimDatabase* Database, |
Patches the given ranges for the provided bones with a simple interpolation | AnimDatabase.h |
|
static void DatabaseRemoveAnimNotifiesFromTrack
(
UAnimDatabase* Database, |
Remove all the anim notifies on a given track | AnimDatabase.h |
|
static void DatabaseRemoveAnimNotifiesFromTracks
(
UAnimDatabase* Database, |
Remove all the anim notifies from the given tracks | AnimDatabase.h |
|
static void DatabaseRemoveAnimNotifiesFromTracksArrayView
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseRemoveFootGroundPenetration
(
UAnimDatabase* Database, |
Removes foot ground penetration in the database | AnimDatabase.h |
|
static void DatabaseRemoveNotifies
(
UAnimDatabase* Database, |
Removes all AnimNotifies and AnimNotifyStates from the given frame ranges | AnimDatabase.h |
|
static void DatabaseRemoveSyncMarkerFromTrack
(
UAnimDatabase* Database, |
Remove all the sync markers on a given track | AnimDatabase.h |
|
static void DatabaseRemoveSyncMarkerFromTracks
(
UAnimDatabase* Database, |
Remove all the sync markers from the given tracks | AnimDatabase.h |
|
static void DatabaseRemoveSyncMarkerFromTracksArrayView
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseResetBoneTransform
(
UAnimDatabase* Database, |
Set the given bone's local transforms in the database to the reference pose | AnimDatabase.h |
|
static void DatabaseResetBoneTransforms
(
UAnimDatabase* Database, |
Set the given bones' local transforms in the database to the reference pose | AnimDatabase.h |
|
static void DatabaseResetBoneTransformsFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseSetGlobalBoneTransform
(
UAnimDatabase* Database, |
Set the given bone's global transform in the database at the given transform frame attribute | AnimDatabase.h |
|
static void DatabaseSetGlobalBoneTransforms
(
UAnimDatabase* Database, |
Set the given bones' global transforms in the database at the given transform frame attributes | AnimDatabase.h |
|
static void DatabaseSetGlobalBoneTransformsFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseSetLocalBoneTransform
(
UAnimDatabase* Database, |
Set the given bone's local transform in the database at the given transform frame attribute | AnimDatabase.h |
|
static void DatabaseSetLocalBoneTransforms
(
UAnimDatabase* Database, |
Set the given bones' local transforms in the database at the given transform frame attributes | AnimDatabase.h |
|
static void DatabaseSetLocalBoneTransformsFromArrayViews
(
UAnimDatabase* Database, |
AnimDatabase.h |
|
|
static void DatabaseSetToReferencePose
(
UAnimDatabase* Database, |
Sets the given ranges to the reference pose, with the exception of the provided IgnoreBoneIndices | AnimDatabase.h |
|
static void DatabaseStripUnusedBoneTracks
(
UAnimDatabase* Database, |
Strips unused bone tracks from the data to reduce the file size on disk | AnimDatabase.h |
|
static void EnableRootMotionAndForceRootLockOnSequences
(
const TArray< UAnimSequence* >& Sequences |
Enables root motion and force root lock on the given animation sequences | AnimDatabase.h |
|
static void EnableRootMotionAndForceRootLockOnSequencesArrayView
(
TConstArrayView< UAnimSequence* > Sequences |
AnimDatabase.h |
|
|
static void GetAnimSequenceAnimNotifyClasses
(
TArray< TSubclassOf< UAnimNotify > >& OutClasses, |
Gets all the AnimNotify classes present in a given AnimSequence | AnimDatabase.h |
|
static void GetAnimSequenceAnimNotifyStateClasses
(
TArray< TSubclassOf< UAnimNotifyState > >& OutClasses, |
Gets all the AnimNotifyState classes present in a given AnimSequence | AnimDatabase.h |
|
static void GetAnimSequenceAnimNotifyStateTimesAndDurations
(
TArray< float >& OutTimes, |
Gets the times and durations of each AnimNotifyState of the given class, in the given sequence | AnimDatabase.h |
|
static void GetAnimSequenceAnimNotifyTimes
(
TArray< float >& OutTimes, |
Gets the times of each AnimNotify of the given class, in the given sequence | AnimDatabase.h |
|
static void LoadAllBlueprintAssetsOfClass
(
UClass* Class |
Loads into memory all the blueprint assets of a given class. | AnimDatabase.h | |
static void RemoveAllAnimNotifiesAndAnimNotifyStatesFromSequence
(
UAnimSequence* AnimSequence |
Removes all AnimNotifies and AnimNotifyStates from a sequence | AnimDatabase.h |
|
static void SetAnimSequencePoseData
(
UAnimSequence* AnimSequence, |
Sets the pose data on a sequence using the given FPoseDataConstView | AnimDatabase.h |