UAnimDatabase

Animation Database Asset

API > API/Plugins > API/Plugins/AnimDatabase

Animation Database Asset

This asset contains an array of animations, as well as a skeleton, and a mirror table. It is assumed that all added animations should match the provided skeleton. As well as providing a hook for a custom UI and tooling, this asset provides functions for sampling animation data at a single uniform framerate and in the pose representation used by the database.

The number of "Sequences" in this database (as returned by GetSequenceNum()) will be two times the number of entries in "Entries" when the mirror data table is present and valid, otherwise it will be the same as the number of entries.

   
Name UAnimDatabase
Type class
Header File /Engine/Plugins/Experimental/Animation/AnimDatabase/Source/AnimDatabase/Public/AnimDatabase.h
Include Path #include "AnimDatabase.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Category="Animation", Meta=(DisplayName="Animation Database"))  
class UAnimDatabase : public UDataAsset

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimDatabase ( const FObjectInitializer& ObjectInitializer
)

   AnimDatabase.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CurveSampler EAnimDatabaseSampler Interpolation method used for sampling curves in the database. AnimDatabase.h
  • EditAnywhere
  • Category="Database"
Entries TArray< TObjectPtr< UAnimSequence > > List of Animations in Database AnimDatabase.h
  • EditAnywhere
  • Category="Database"
FrameRate FFrameRate FrameRate to use for sampling the database. AnimDatabase.h
  • EditAnywhere
  • Category="Database"
MirrorDataTable TObjectPtr< UMirrorDataTable > Mirror Data Table. Leave as null if you don't want to include mirrored animations in the database. AnimDatabase.h
  • EditAnywhere
  • Category="Database"
OnSkeletonChanged FAnimDatabaseOnSkeletonChanged Callback to fire when the skeleton is changed AnimDatabase.h  
PoseSampler EAnimDatabaseSampler Interpolation method used for sampling poses in the database. AnimDatabase.h
  • EditAnywhere
  • Category="Database"
Query TObjectPtr< UAnimDatabaseQuery > Editor-only object containing the query state for the editor window AnimDatabase.h
  • Instanced
Skeleton TObjectPtr< USkeleton > Skeleton structure for Animation Sequences AnimDatabase.h
  • EditAnywhere
  • Category="Database"
ViewportSettings TObjectPtr< UAnimDatabaseViewportSettings > Editor-only object containing the viewport settings for the editor window AnimDatabase.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 FindBoneIndex ( const FName BoneName
) const

 Finds the bone index for a given bone name in the database skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void FindBoneIndices ( TArray< int32 >& OutBoneIndices,
const TArray< FName >& BoneNames
) const

 Finds the bone indices associated with the given bone names in the database skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void FindBoneIndicesFromArrayViews ( const TArrayView< int32 > OutBoneIndices,
const TArrayView< const FName > BoneNames
) const

   AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 FindSequenceIndex ( UAnimSequence* AnimSequence,
const bool bIsMirrored
) const

 Finds the sequence index associated with a given animation AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

UAnimSequence * GetAnimSequence ( const int32 SequenceIdx
) const

 Gets a pointer for the animation corresponding to a particular sequence index AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetAttributeData ( const UE::AnimDatabase::FPoseAttributeDataView& OutAttributeData,
const int32 SequenceIdx,
const int32 FrameStart,
const TArrayView< const FAnimDatabaseFrameAttribute > FrameAttributes
) const

 Gets a number of frames of attribute data for a given sequence and frame range AnimDatabase.h  

FName GetBoneName ( const int32 BoneIndex
) const

 Gets the bone name for the given bone index in the database skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneNames ( TArray< FName >& OutBoneNames
) const

 Gets the bone names for all bones on the skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneNamesToArrayView ( TArrayView< FName > OutBoneNames
) const

   AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetBoneNum()

 Gets the number of bones in the database skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetBoneParent ( const int32 BoneIndex
) const

 Gets the parent bone index AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneParents ( TArray< int32 >& OutParents
) const

 Gets the array of bone parent indices for the database skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneParentsToArrayView ( const TArrayView< int32 > OutParents
) const

   AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

FVector GetBoneReferenceLocation ( const int32 BoneIdx
)

 Gets the bone location in the reference skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneReferenceLocations ( TArray< FVector >& OutReferenceLocations
)

 Gets the bone locations in the reference skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneReferenceLocationsToArrayView ( TArrayView< FVector > OutReferenceLocations
)

   AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

FQuat GetBoneReferenceRotation ( const int32 BoneIdx
)

 Gets the bone rotation in the reference skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneReferenceRotations ( TArray< FQuat >& OutReferenceRotations
)

 Gets the bone rotations in the reference skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetBoneReferenceRotationsToArrayView ( TArrayView< FQuat > OutReferenceRotations
)

   AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

FVector GetBoneReferenceScale ( const int32 BoneIdx
)

 Gets the bone scale in the reference skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetClosestFrameFromSequenceTime ( const int32 SequenceIdx,
const float SequenceTime
) const

 Gets the closest frame associated with a sequence time AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetContentHash ()

 Gets a hash value which can be used to test if the underlying content in the database, or database properties have changed. AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetCurveActiveData ( const TLearningArrayView< 2, bool > OutCurveActive,
const int32 SequenceIdx,
const int32 FrameStart,
const TArrayView< const FName > CurveNames
) const

 Gets if the given curves are active for a given sequence and frame range AnimDatabase.h  

void GetCurveData ( const TLearningArrayView< 2, float > OutCurveValues,
const TLearningArrayView< 2, float > OutCurveVelocities,
const TLearningArrayView< 2, bool > OutCurveActive,
const int32 SequenceIdx,
const int32 FrameStart,
const TArrayView< const FName > CurveNames
) const

 Gets curve data for a given sequence and frame range AnimDatabase.h  

FFrameRate GetFrameRate()

 Get the database frame rate AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

bool GetIsMirrored ( const int32 SequenceIdx
) const

 Returns if a given sequence index is for a mirrored animation or not AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

UMirrorDataTable * GetMirrorDataTable()

 Get a pointer to the database mirror table AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void GetPoseData ( const UE::AnimDatabase::FPoseDataView& OutPoseData,
const int32 SequenceIdx,
const int32 FrameStart,
const TArrayView< const FAnimDatabaseFrameAttribute > FrameAttributes
) const

 Gets a number of frames of pose data for a given sequence and frame range AnimDatabase.h  

void GetPoseLocalBoneData ( const UE::AnimDatabase::FPoseLocalBoneDataView& OutPoseLocalBoneData,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Gets a number of frames of local bone data for a given sequence and frame range AnimDatabase.h  

void GetPoseLocalBoneSubsetData ( const UE::AnimDatabase::FPoseLocalBoneDataView& OutPoseLocalBoneData,
const int32 SequenceIdx,
const int32 FrameStart,
const UE::Learning::FIndexSet BoneIndices
) const

 Gets a number of frames of local bone data for a given sequence and frame range, and a subset of bones AnimDatabase.h  

void GetPoseRootData ( const UE::AnimDatabase::FPoseRootDataView& OutPoseRootData,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Get a number of frames of root data for a given sequence and frame range AnimDatabase.h  

void GetPoseSubsetData ( const UE::AnimDatabase::FPoseDataView& OutPoseData,
const int32 SequenceIdx,
const int32 FrameStart,
const UE::Learning::FIndexSet BoneIndices,
const TArrayView< const FAnimDatabaseFrameAttribute > FrameAttributes
) const

 Gets a number of frames of pose data for a given sequence and frame range, and a subset of bones AnimDatabase.h  

void GetRootAngularVelocity ( const TLearningArrayView< 1, FVector3f > OutAngularVelocities,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Gets the root angular velocity for a given sequence and start frame AnimDatabase.h  

void GetRootDirection ( const TLearningArrayView< 1, FVector3f > OutDirections,
const int32 SequenceIdx,
const int32 FrameStart,
const FVector3f ForwardVector
) const

 Gets the root direction for a given sequence and start frame AnimDatabase.h  

void GetRootLinearVelocity ( const TLearningArrayView< 1, FVector3f > OutLinearVelocities,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Gets the root linear velocity for a given sequence and start frame AnimDatabase.h  

void GetRootLocation ( const TLearningArrayView< 1, FVector > OutLocations,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Gets the root location for a given sequence and start frame AnimDatabase.h  

void GetRootRotation ( const TLearningArrayView< 1, FQuat4f > OutRotations,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Gets the root rotation for a given sequence and start frame AnimDatabase.h  

void GetRootTransform ( const TLearningArrayView< 1, FTransform > OutTransforms,
const int32 SequenceIdx,
const int32 FrameStart
) const

 Gets the root transform for a given sequence and start frame AnimDatabase.h  

FString GetSequenceAssetName ( const int32 SequenceIdx
) const

 Gets the asset name for a sequence index AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

float GetSequenceDuration ( const int32 SequenceIdx
) const

 Returns the duration of a sequence in seconds AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetSequenceFrameNum ( const int32 SequenceIdx
) const

 Gets the number of frames in a sequence AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetSequenceNum ()

 Gets the number of sequences in the database. AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

FString GetSequencePathString ( const int32 SequenceIdx
) const

 Gets the path string for a sequence index AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

float GetSequenceTimeFromFrame ( const int32 SequenceIdx,
const int32 FrameIdx
) const

 Gets the sequence time for the start of a given frame AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

USkeleton * GetSkeleton()

 Get a pointer to the database skeleton AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

float GetTotalDuration()

 Gets the total duration of all sequences AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

int32 GetTotalFrameNum()

 Gets the total number of frames across all sequences AnimDatabase.h
  • BlueprintPure
  • Category="AnimDatabase"

void SampleAttributeData ( const UE::AnimDatabase::FPoseAttributeDataView& OutAttributeData,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes,
const TLearningArrayView< 1, const FAnimDatabaseFrameAttribute > FrameAttributes
) const

 Samples attribute data for the given sequences and times in those sequences. AnimDatabase.h  

void SampleCurveActiveData ( const TLearningArrayView< 2, bool > OutCurveActive,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes,
const TArrayView< const FName > CurveNames
) const

 Samples if curve are active for the given sequences and times in those sequences. AnimDatabase.h  

void SampleCurveData ( const TLearningArrayView< 2, float > OutCurveValues,
const TLearningArrayView< 2, float > OutCurveVelocities,
const TLearningArrayView< 2, bool > OutCurveActive,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes,
const TArrayView< const FName > CurveNames
) const

 Samples curve data for the given sequences and times in those sequences. AnimDatabase.h  

void SamplePoseData ( const UE::AnimDatabase::FPoseDataView& OutPoseData,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes,
const TLearningArrayView< 1, const FAnimDatabaseFrameAttribute > FrameAttributes
) const

 Samples pose data for the given sequences and times in those sequences. AnimDatabase.h  

void SamplePoseLocalBoneData ( const UE::AnimDatabase::FPoseLocalBoneDataView& OutPoseLocalBoneData,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes
) const

 Samples local bone data for the given sequences and times in those sequences AnimDatabase.h  

void SamplePoseLocalBoneSubsetData ( const UE::AnimDatabase::FPoseLocalBoneDataView& OutPoseLocalBoneData,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes,
const UE::Learning::FIndexSet BoneIndices
) const

 Samples local bone data for the given sequences and times in those sequences, and a subset of bones. AnimDatabase.h  

void SamplePoseRootData ( const UE::AnimDatabase::FPoseRootDataView& OutPoseRootData,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes
) const

 Samples root data for the given sequences and times in those sequences AnimDatabase.h  

void SamplePoseSubsetData ( const UE::AnimDatabase::FPoseDataView& OutPoseData,
const TLearningArrayView< 1, const int32 > SequenceIndices,
const TLearningArrayView< 1, const float > SequenceTimes,
const UE::Learning::FIndexSet BoneIndices,
const TLearningArrayView< 1, const FAnimDatabaseFrameAttribute > FrameAttributes
) const

 Samples pose data for the given sequences and times in those sequences, for a subset of bones. AnimDatabase.h  

FVector3f SampleRootDirection ( const int32 SequenceIdx,
const float SequenceTime,
const FVector3f ForwardVector
) const

 Samples the root direction for a given sequence and sequence time AnimDatabase.h  

FVector3f SampleRootLinearVelocity ( const int32 SequenceIdx,
const float SequenceTime
) const

 Samples the root linear velocity for a given sequence and sequence time AnimDatabase.h  

FVector SampleRootLocation ( const int32 SequenceIdx,
const float SequenceTime
) const

 Samples the root location for a given sequence and sequence time AnimDatabase.h  

FQuat4f SampleRootRotation ( const int32 SequenceIdx,
const float SequenceTime
) const

 Samples the root rotation for a given sequence and sequence time AnimDatabase.h  

FTransform SampleRootTransform ( const int32 SequenceIdx,
const float SequenceTime
) const

 Samples the root transform for a given sequence and sequence time AnimDatabase.h  

void WaitForCompressionOnAll()

   AnimDatabase.h  

void WaitForCompressionOnAnimSequence ( const int32 SequenceIdx
) const

 Waits for the animation compression to complete for the given sequence. AnimDatabase.h
  • BlueprintCallable
  • Category="AnimDatabase"

void WaitForCompressionOnAnimSequences ( const TArray< int32 >& SequenceIndices
) const

 Waits for the animation compression to complete for the given sequences. AnimDatabase.h
  • BlueprintCallable
  • Category="AnimDatabase"

void WaitForCompressionOnAnimSequencesFromArrayView ( const TArrayView< const int32 > SequenceIndices
) const

   AnimDatabase.h
  • BlueprintCallable
  • Category="AnimDatabase"

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& Event
)

 We use this to ensure that entries added have a matching skeleton AnimDatabase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page