1. Epic GamesDeveloper
  3. UAnimDataModel

UAnimDataModel

The Model represents the source data for animations.

API > API/Runtime > API/Runtime/Engine

The Model represents the source data for animations. It contains both bone animation data as well as animated curves. They are currently only a sub-object of a AnimSequenceBase instance. The instance derives all runtime data from the source data.

   
Name UAnimDataModel
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimData/AnimDataModel.h
Include Path #include "Animation/AnimData/AnimDataModel.h"

Syntax

UCLASS (BlueprintType, Meta=(DebugTreeLeaf), MinimalAPI)  
class UAnimDataModel :  
    public UObject ,  
    public IAnimationDataModel

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AnimatedBoneAttributes TArray< FAnimatedBoneAttribute > Container with all animated (bone) attribute data Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")
BoneAnimationTracks TArray< FBoneAnimationTrack > All individual bone animation tracks Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")
bPopulated bool   Animation/AnimData/AnimDataModel.h  
BracketCounter int32   Animation/AnimData/AnimDataModel.h
  • Transient
CurveData FAnimationCurveData Container with all animated curve data Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")
FrameRate FFrameRate Rate at which the animated data is sampled Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")
ModifiedEvent FAnimDataModelModifiedEvent Native delegate event allows for registerings to any broadcasted notify. Animation/AnimData/AnimDataModel.h  
ModifiedEventDynamic FAnimDataModelModifiedDynamicEvent Dynamic delegate event allows scripting to register to any broadcasted notify. Animation/AnimData/AnimDataModel.h
  • BlueprintAssignable
  • Transient
  • Category=AnimationDataModel
  • Meta=(ScriptName="ModifiedEvent", AllowPrivateAccess="true")
Notifier TUniquePtr< IAnimationDataModel::FModelNotifier >   Animation/AnimData/AnimDataModel.h  
NumberOfFrames int32 Total number of sampled animated frames Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")
NumberOfKeys int32 Total number of sampled animated keys Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")
PlayLength float Total playable length of the contained animation data Animation/AnimData/AnimDataModel.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category="Animation Data Model"
  • Meta=(AllowPrivateAccess="true")

Functions

Public

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsEditorOnly()

   Animation/AnimData/AnimDataModel.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   Animation/AnimData/AnimDataModel.h  

virtual void PostLoad()

 Begin UObject overrides Animation/AnimData/AnimDataModel.h  

Overridden from IAnimationDataModel

Name Remarks Include Path Unreal Specifiers

virtual void Evaluate ( FAnimationPoseData& InOutPoseData,
const UE::Anim::DataModel::FEvaluationContext& EvaluationContext
) const

 Evaluates the contained Animation Data to populated an Animation Pose with (Bones, Curves and Attributes). Animation/AnimData/AnimDataModel.h  

virtual FTransform EvaluateBoneTrackTransform ( FName TrackName,
const FFrameTime& FrameTime,
const EAnimInterpolationType& Interpolation
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FAnimatedBoneAttribute * FindAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FBoneAnimationTrack * FindBoneTrackByIndex ( int32 BoneIndex
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FBoneAnimationTrack * FindBoneTrackByName ( FName Name
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FAnimCurveBase * FindCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FFloatCurve * FindFloatCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FRichCurve * FindRichCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FTransformCurve * FindTransformCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual FString GenerateDebugStateString()

   Animation/AnimData/AnimDataModel.h  

virtual FGuid GenerateGuid ( const FGuidGenerationSettings& InSettings
) const

   Animation/AnimData/AnimDataModel.h  

virtual UAnimSequence * GetAnimationSequence()

   Animation/AnimData/AnimDataModel.h  

virtual const FAnimatedBoneAttribute & GetAttribute ( const FAnimationAttributeIdentifier& AttributeIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual TArrayView< const FAnimatedBoneAttribute > GetAttributes()

   Animation/AnimData/AnimDataModel.h  

virtual void GetAttributesForBone ( const FName& BoneName,
TArray< const FAnimatedBoneAttribute* >& OutBoneAttributes
) const

   Animation/AnimData/AnimDataModel.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS const TArray< FBoneAnimationTrack > & GetBoneAnimationTracks()

   Animation/AnimData/AnimDataModel.h  

virtual const FBoneAnimationTrack & GetBoneTrackByIndex ( int32 TrackIndex
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FBoneAnimationTrack & GetBoneTrackByName ( FName TrackName
) const

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetBoneTrackIndex ( const FBoneAnimationTrack& Track
) const

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetBoneTrackIndexByName ( FName TrackName
) const

   Animation/AnimData/AnimDataModel.h  

virtual void GetBoneTrackNames ( TArray< FName >& OutNames
) const

 Populates the provided array with all contained (bone) track names Animation/AnimData/AnimDataModel.h  

virtual void GetBoneTracksTransform ( const TArray< FName >& TrackNames,
const FFrameNumber& FrameNumber,
TArray< FTransform >& OutTransforms
) const

   Animation/AnimData/AnimDataModel.h  

virtual FTransform GetBoneTrackTransform ( FName TrackName,
const FFrameNumber& FrameNumber
) const

   Animation/AnimData/AnimDataModel.h  

virtual void GetBoneTrackTransforms ( FName TrackName,
TArray< FTransform >& OutTransforms
) const

   Animation/AnimData/AnimDataModel.h  

virtual void GetBoneTrackTransforms ( FName TrackName,
const TArray< FFrameNumber >& FrameNumbers,
TArray< FTransform >& OutTransforms
) const

   Animation/AnimData/AnimDataModel.h  

virtual TScriptInterface< IAnimationDataController > GetController()

   Animation/AnimData/AnimDataModel.h  

virtual const FAnimCurveBase & GetCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FAnimationCurveData & GetCurveData()

 Returns all contained curve animation data Animation/AnimData/AnimDataModel.h  

virtual const FFloatCurve & GetFloatCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const TArray< struct FFloatCurve > & GetFloatCurves()

   Animation/AnimData/AnimDataModel.h  

virtual FFrameRate GetFrameRate()

   Animation/AnimData/AnimDataModel.h  

virtual FAnimDataModelModifiedEvent & GetModifiedEvent()

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumberOfAttributes()

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumberOfAttributesForBoneIndex ( const int32 BoneIndex
) const

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumberOfFloatCurves()

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumberOfFrames()

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumberOfKeys()

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumberOfTransformCurves()

   Animation/AnimData/AnimDataModel.h  

virtual int32 GetNumBoneTracks()

   Animation/AnimData/AnimDataModel.h  

virtual double GetPlayLength()

 End UObject overrides Begin IAnimationDataModel overrides Animation/AnimData/AnimDataModel.h  

virtual const FRichCurve & GetRichCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const FTransformCurve & GetTransformCurve ( const FAnimationCurveIdentifier& CurveIdentifier
) const

   Animation/AnimData/AnimDataModel.h  

virtual const TArray< struct FTransformCurve > & GetTransformCurves()

   Animation/AnimData/AnimDataModel.h  

virtual bool HasBeenPopulated()

   Animation/AnimData/AnimDataModel.h  

virtual bool IsValidBoneTrackIndex ( int32 TrackIndex
) const

   Animation/AnimData/AnimDataModel.h  

virtual bool IsValidBoneTrackName ( const FName& TrackName
) const

   Animation/AnimData/AnimDataModel.h  

virtual void IterateBoneKeys ( const FName& BoneName,
TFunction< bool(const FVector3f&Pos, const FQuat4f&, const FVector3f, const FFrameNumber&)> Itera...
) const

   Animation/AnimData/AnimDataModel.h  

Protected

Overridden from IAnimationDataModel

Name Remarks Include Path Unreal Specifiers

virtual FAnimDataModelModifiedDynamicEvent & GetModifiedDynamicEvent()

   Animation/AnimData/AnimDataModel.h  

virtual IAnimationDataModel::FModelNotifier & GetNotifier()

   Animation/AnimData/AnimDataModel.h  

virtual bool & GetPopulationFlag()

   Animation/AnimData/AnimDataModel.h  

virtual void LockEvaluationAndModification()

   Animation/AnimData/AnimDataModel.h  

virtual void OnNotify ( const EAnimDataModelNotifyType& NotifyType,
const FAnimDataModelNotifPayload& Payload
)

   Animation/AnimData/AnimDataModel.h  

virtual bool TryLockEvaluationAndModification()

   Animation/AnimData/AnimDataModel.h  

virtual void UnlockEvaluationAndModification()

   Animation/AnimData/AnimDataModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page