#include <IAnimationDataModel.h>

Inheritance diagram for IAnimationDataModel:

Classes
struct	FEvaluationAndModificationLock

struct	FGuidGenerationSettings

struct	FModelNotifier

Public Member Functions
virtual double	GetPlayLength () const =0

virtual int32	GetNumberOfFrames () const =0

virtual int32	GetNumberOfKeys () const =0

virtual FFrameRate	GetFrameRate () const =0

virtual const TArray< FBoneAnimationTrack > &	GetBoneAnimationTracks () const =0

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

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

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

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

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

virtual const FBoneAnimationTrack &	GetBoneTrackByIndex (int32 TrackIndex) const =0

virtual const FBoneAnimationTrack &	GetBoneTrackByName (FName TrackName) const =0

virtual const FBoneAnimationTrack *	FindBoneTrackByName (FName Name) const =0

virtual const FBoneAnimationTrack *	FindBoneTrackByIndex (int32 BoneIndex) const =0

virtual int32	GetBoneTrackIndex (const FBoneAnimationTrack &Track) const =0

virtual int32	GetBoneTrackIndexByName (FName TrackName) const =0

virtual bool	IsValidBoneTrackIndex (int32 TrackIndex) const =0

virtual bool	IsValidBoneTrackName (const FName &TrackName) const =0

virtual int32	GetNumBoneTracks () const =0

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

virtual const FAnimationCurveData &	GetCurveData () const =0

virtual int32	GetNumberOfTransformCurves () const =0

virtual int32	GetNumberOfFloatCurves () const =0

virtual const TArray< struct FFloatCurve > &	GetFloatCurves () const =0

virtual const TArray< struct FTransformCurve > &	GetTransformCurves () const =0

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

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

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

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

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

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

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

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

virtual TArrayView< const FAnimatedBoneAttribute >	GetAttributes () const =0

virtual int32	GetNumberOfAttributes () const =0

virtual int32	GetNumberOfAttributesForBoneIndex (const int32 BoneIndex) const =0

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

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

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

virtual UAnimSequence *	GetAnimationSequence () const =0

virtual FAnimDataModelModifiedEvent &	GetModifiedEvent ()=0

virtual FGuid	GenerateGuid (const FGuidGenerationSettings &InSettings) const =0

virtual FGuid	GenerateGuid () const

virtual TScriptInterface< IAnimationDataController >	GetController ()=0

virtual bool	HasBeenPopulated () const =0

virtual void	IterateBoneKeys (const FName &BoneName, TFunction< bool(const FVector3f &Pos, const FQuat4f &, const FVector3f, const FFrameNumber &)> IterationFunction) const =0

Protected Member Functions
virtual FAnimDataModelModifiedDynamicEvent &	GetModifiedDynamicEvent ()=0

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

virtual void	LockEvaluationAndModification () const =0

virtual bool	TryLockEvaluationAndModification () const =0

virtual void	UnlockEvaluationAndModification () const =0

virtual bool &	GetPopulationFlag ()=0

virtual IAnimationDataModel::FModelNotifier &	GetNotifier ()=0

Member Function Documentation

◆ EvaluateBoneTrackTransform()

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

pure virtual

Implemented in UAnimDataModel.

◆ FindAttribute()

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

pure virtual

Returns: Animated (bone) attribute ptr for the provided identifier if valid, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ FindBoneTrackByIndex()

virtual const FBoneAnimationTrack * IAnimationDataModel::FindBoneTrackByIndex ( int32 BoneIndex ) const

pure virtual

Returns: Bone animation track for the provided index if valid, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ FindBoneTrackByName()

virtual const FBoneAnimationTrack * IAnimationDataModel::FindBoneTrackByName ( FName Name ) const

pure virtual

Returns: Bone animation track for the provided (bone) name if found, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ FindCurve()

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

pure virtual

Returns: Curve ptr for the provided identifier if valid, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ FindFloatCurve()

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

pure virtual

Returns: Float Curve ptr for the provided identifier if valid, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ FindRichCurve()

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

pure virtual

Returns: Rich curve ptr for the provided identifier if valid, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ FindTransformCurve()

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

pure virtual

Returns: Transform Curve ptr for the provided identifier if valid, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ GenerateGuid() [1/2]

virtual FGuid IAnimationDataModel::GenerateGuid ( ) const

inlinevirtual

Returns: GUID representing the contained data and state

◆ GenerateGuid() [2/2]

virtual FGuid IAnimationDataModel::GenerateGuid ( const FGuidGenerationSettings & InSettings ) const

pure virtual

Returns: GUID representing a configured sub-set of the contained data and state

Parameters

InSettings Settings used to determine which data should be included when generating the returned GUID

Implemented in UAnimDataModel.

◆ GetAnimationSequence()

virtual UAnimSequence * IAnimationDataModel::GetAnimationSequence ( ) const

pure virtual

Returns: The outer UAnimSequence object if found, otherwise returns a nullptr

Implemented in UAnimDataModel.

◆ GetAttribute()

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

pure virtual

Returns: Animated (bone) attribute object for the provided identifier if valid

Implemented in UAnimDataModel.

◆ GetAttributes()

virtual TArrayView< const FAnimatedBoneAttribute > IAnimationDataModel::GetAttributes ( ) const

pure virtual

Returns: Animated (bone) attributes stored

Implemented in UAnimDataModel.

◆ GetAttributesForBone()

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

pure virtual

Returns: All animated (bone) attributes stored for the specified bone name

Implemented in UAnimDataModel.

◆ GetBoneAnimationTracks()

virtual const TArray< FBoneAnimationTrack > & IAnimationDataModel::GetBoneAnimationTracks ( ) const

pure virtual

Returns: Array containing all bone animation tracks

Implemented in UAnimDataModel.

◆ GetBoneTrackByIndex()

virtual const FBoneAnimationTrack & IAnimationDataModel::GetBoneTrackByIndex ( int32 TrackIndex ) const

pure virtual

Returns: Bone animation track for the provided index

Implemented in UAnimDataModel.

◆ GetBoneTrackByName()

virtual const FBoneAnimationTrack & IAnimationDataModel::GetBoneTrackByName ( FName TrackName ) const

pure virtual

Returns: Bone animation track for the provided (bone) name

Implemented in UAnimDataModel.

◆ GetBoneTrackIndex()

virtual int32 IAnimationDataModel::GetBoneTrackIndex ( const FBoneAnimationTrack & Track ) const

pure virtual

Returns: Internal track index for the provided bone animation track if found, otherwise returns INDEX_NONE

Implemented in UAnimDataModel.

◆ GetBoneTrackIndexByName()

virtual int32 IAnimationDataModel::GetBoneTrackIndexByName ( FName TrackName ) const

pure virtual

Returns: Internal track index for the provided (bone) name if found, otherwise returns INDEX_NONE

Implemented in UAnimDataModel.

◆ GetBoneTrackNames()

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

pure virtual

Populates the provided array with all contained (bone) track names

Parameters

OutNames [out] Array containing all bone track names

Implemented in UAnimDataModel.

◆ GetBoneTracksTransform()

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

pure virtual

Implemented in UAnimDataModel.

◆ GetBoneTrackTransform()

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

pure virtual

Implemented in UAnimDataModel.

◆ GetBoneTrackTransforms() [1/2]

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

pure virtual

Implemented in UAnimDataModel.

◆ GetBoneTrackTransforms() [2/2]

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

pure virtual

Implemented in UAnimDataModel.

◆ GetController()

virtual TScriptInterface< IAnimationDataController > IAnimationDataModel::GetController ( )

pure virtual

Returns: IAnimationDataController instance used for mutating this model

Implemented in UAnimDataModel.

◆ GetCurve()

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

pure virtual

Returns: Curve object for the provided identifier if valid

Implemented in UAnimDataModel.

◆ GetCurveData()

virtual const FAnimationCurveData & IAnimationDataModel::GetCurveData ( ) const

pure virtual

Returns all contained curve animation data

Implemented in UAnimDataModel.

◆ GetFloatCurve()

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

pure virtual

Returns: Float Curve object for the provided identifier if valid

Implemented in UAnimDataModel.

◆ GetFloatCurves()

virtual const TArray< struct FFloatCurve > & IAnimationDataModel::GetFloatCurves ( ) const

pure virtual

Returns: Array containing all stored float curves

Implemented in UAnimDataModel.

◆ GetFrameRate()

virtual FFrameRate IAnimationDataModel::GetFrameRate ( ) const

pure virtual

Returns: Frame rate at which the animation data is key-ed

Implemented in UAnimDataModel.

◆ GetModifiedDynamicEvent()

virtual FAnimDataModelModifiedDynamicEvent & IAnimationDataModel::GetModifiedDynamicEvent ( )

protectedpure virtual

Implemented in UAnimDataModel.

◆ GetModifiedEvent()

virtual FAnimDataModelModifiedEvent & IAnimationDataModel::GetModifiedEvent ( )

pure virtual

Returns: Multicast delegate which is broadcasted to propagated changes to any internal data, see FAnimDataModelModifiedEvent and EAnimDataModelNotifyType

Implemented in UAnimDataModel.

◆ GetNotifier()

virtual IAnimationDataModel::FModelNotifier & IAnimationDataModel::GetNotifier ( )

protectedpure virtual

Implemented in UAnimDataModel.

◆ GetNumberOfAttributes()

virtual int32 IAnimationDataModel::GetNumberOfAttributes ( ) const

pure virtual

Returns: Number of animated (bone) attributes stored

Implemented in UAnimDataModel.

◆ GetNumberOfAttributesForBoneIndex()

virtual int32 IAnimationDataModel::GetNumberOfAttributesForBoneIndex ( const int32 BoneIndex ) const

pure virtual

Returns: Number of animated (bone) attributes stored for the specified bone index

Implemented in UAnimDataModel.

◆ GetNumberOfFloatCurves()

virtual int32 IAnimationDataModel::GetNumberOfFloatCurves ( ) const

pure virtual

Returns: Total number of stored float curves

Implemented in UAnimDataModel.

◆ GetNumberOfFrames()

virtual int32 IAnimationDataModel::GetNumberOfFrames ( ) const

pure virtual

Returns: Total number of frames of animation data stored

Implemented in UAnimDataModel.

◆ GetNumberOfKeys()

virtual int32 IAnimationDataModel::GetNumberOfKeys ( ) const

pure virtual

Returns: Total number of animation data keys stored

Implemented in UAnimDataModel.

◆ GetNumberOfTransformCurves()

virtual int32 IAnimationDataModel::GetNumberOfTransformCurves ( ) const

pure virtual

Returns: Total number of stored FTransform curves

Implemented in UAnimDataModel.

◆ GetNumBoneTracks()

virtual int32 IAnimationDataModel::GetNumBoneTracks ( ) const

pure virtual

Returns: Total number of bone animation tracks

Implemented in UAnimDataModel.

◆ GetPlayLength()

virtual double IAnimationDataModel::GetPlayLength ( ) const

pure virtual

Returns: Total length of play-able animation data

Implemented in UAnimDataModel.

◆ GetPopulationFlag()

virtual bool & IAnimationDataModel::GetPopulationFlag ( )

protectedpure virtual

Implemented in UAnimDataModel.

◆ GetRichCurve()

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

pure virtual

Returns: Rich Curve object for the provided identifier if valid

Implemented in UAnimDataModel.

◆ GetTransformCurve()

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

pure virtual

Returns: Transform Curve object for the provided identifier if valid

Implemented in UAnimDataModel.

◆ GetTransformCurves()

virtual const TArray< struct FTransformCurve > & IAnimationDataModel::GetTransformCurves ( ) const

pure virtual

Returns: Array containing all stored FTransform curves

Implemented in UAnimDataModel.

◆ HasBeenPopulated()

virtual bool IAnimationDataModel::HasBeenPopulated ( ) const

pure virtual

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

Parameters

InOutPoseData	Container for the to-be-evaluated pose related data
EvaluationContext	Context describing how the data should be evaluated (timing etc.)

Implemented in UAnimDataModel.

◆ IsValidBoneTrackIndex()

virtual bool IAnimationDataModel::IsValidBoneTrackIndex ( int32 TrackIndex ) const

pure virtual

Returns: Whether or not the provided track index is valid

Implemented in UAnimDataModel.

◆ IsValidBoneTrackName()

virtual bool IAnimationDataModel::IsValidBoneTrackName ( const FName & TrackName ) const

pure virtual

Implemented in UAnimDataModel.

◆ IterateBoneKeys()

virtual void IAnimationDataModel::IterateBoneKeys	(	const FName &	BoneName,
		TFunction< bool(const FVector3f &Pos, const FQuat4f &, const FVector3f, const FFrameNumber &)>	IterationFunction
	)		const

pure virtual

Implemented in UAnimDataModel.

◆ LockEvaluationAndModification()

virtual void IAnimationDataModel::LockEvaluationAndModification ( ) const

protectedpure virtual

Implemented in UAnimDataModel.

◆ OnNotify()

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

protectedpure virtual

Implemented in UAnimDataModel.

◆ TryLockEvaluationAndModification()

virtual bool IAnimationDataModel::TryLockEvaluationAndModification ( ) const

protectedpure virtual

Implemented in UAnimDataModel.

◆ UnlockEvaluationAndModification()

virtual void IAnimationDataModel::UnlockEvaluationAndModification ( ) const

protectedpure virtual

Implemented in UAnimDataModel.

The documentation for this class was generated from the following file:

Engine/Source/Runtime/Engine/Classes/Animation/AnimData/IAnimationDataModel.h

Classes

Public Member Functions

Protected Member Functions

Member Function Documentation

◆ EvaluateBoneTrackTransform()

◆ FindAttribute()

◆ FindBoneTrackByIndex()

◆ FindBoneTrackByName()

◆ FindCurve()

◆ FindFloatCurve()

◆ FindRichCurve()

◆ FindTransformCurve()

◆ GenerateGuid() [1/2]

◆ GenerateGuid() [2/2]

◆ GetAnimationSequence()

◆ GetAttribute()

◆ GetAttributes()

◆ GetAttributesForBone()

◆ GetBoneAnimationTracks()

◆ GetBoneTrackByIndex()

◆ GetBoneTrackByName()

◆ GetBoneTrackIndex()

◆ GetBoneTrackIndexByName()

◆ GetBoneTrackNames()

◆ GetBoneTracksTransform()

◆ GetBoneTrackTransform()

◆ GetBoneTrackTransforms() [1/2]

◆ GetBoneTrackTransforms() [2/2]

◆ GetController()

◆ GetCurve()

◆ GetCurveData()

◆ GetFloatCurve()

◆ GetFloatCurves()

◆ GetFrameRate()

◆ GetModifiedDynamicEvent()

◆ GetModifiedEvent()

◆ GetNotifier()

◆ GetNumberOfAttributes()

◆ GetNumberOfAttributesForBoneIndex()

◆ GetNumberOfFloatCurves()

◆ GetNumberOfFrames()

◆ GetNumberOfKeys()

◆ GetNumberOfTransformCurves()

◆ GetNumBoneTracks()

◆ GetPlayLength()

◆ GetPopulationFlag()

◆ GetRichCurve()

◆ GetTransformCurve()

◆ GetTransformCurves()

◆ HasBeenPopulated()

◆ IsValidBoneTrackIndex()

◆ IsValidBoneTrackName()

◆ IterateBoneKeys()

◆ LockEvaluationAndModification()

◆ OnNotify()

◆ TryLockEvaluationAndModification()

◆ UnlockEvaluationAndModification()