1. Epic GamesDeveloper
  3. UAnimComposite

UAnimComposite

Animation Composites serve as a way to combine multiple animations together and treat them as a single unit.

API > API/Runtime > API/Runtime/Engine

Animation Composites serve as a way to combine multiple animations together and treat them as a single unit.

   
Name UAnimComposite
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimComposite.h
Include Path #include "Animation/AnimComposite.h"

Syntax

UCLASS (Config=Engine, HideCategories=UObject, MinimalAPI, BlueprintType)  
class UAnimComposite : public UAnimCompositeBase

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimComposite ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimComposite.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimationTrack FAnimTrack Serializable data that stores section/anim pairing Animation/AnimComposite.h  
PreviewBasePose TObjectPtr< UAnimSequence > Preview Base pose for additive BlendSpace Animation/AnimComposite.h
  • EditAnywhere
  • Category=AdditiveSettings

Functions

Public

Overridden from UAnimCompositeBase

Name Remarks Include Path Unreal Specifiers

virtual bool ContainRecursive ( TArray< UAnimCompositeBase* >& CurrentAccumulatedList
)

 This is recursive function that look thorough internal assets and clear the reference if recursive is found. Animation/AnimComposite.h  

virtual void InvalidateRecursiveAsset()

 This is to prevent anybody adding recursive asset to anim composite as a result of anim composite being a part of anim sequence base Animation/AnimComposite.h  

virtual void SetCompositeLength ( float InLength
)

   Animation/AnimComposite.h  

virtual void UpdateCommonTargetFrameRate()

   Animation/AnimComposite.h  

Overridden from UAnimSequenceBase

Name Remarks Include Path Unreal Specifiers

virtual void EnableRootMotionSettingFromMontage ( bool bInEnableRootMotion,
const ERootMotionRootLock::Type InRootMotionRootLock
)

 To support anim sequence base to montage Animation/AnimComposite.h  

virtual FTransform ExtractRootMotion ( const FAnimExtractContext& ExtractionContext
) const

 Extract Root Motion transform from the animation. Animation/AnimComposite.h  

virtual FTransform ExtractRootMotionFromRange ( double StartTime,
double EndTime,
const FAnimExtractContext& ExtractionContext
) const

 Extract Root Motion transform from a contiguous position range (no looping) Animation/AnimComposite.h  

virtual FTransform ExtractRootTrackTransform ( const FAnimExtractContext& ExtractionContext,
const FBoneContainer* RequiredBones
) const

 Extract the transform from the root track for the given animation position. Animation/AnimComposite.h  

virtual EAdditiveAnimationType GetAdditiveAnimType()

 Default implementation, no additive Animation/AnimComposite.h  

virtual UAnimSequence * GetAdditiveBasePose()

 Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence Animation/AnimComposite.h  

virtual void GetAnimationPose ( FAnimationPoseData& OutPoseData,
const FAnimExtractContext& ExtractionContext
) const

 Get Bone Transform of the Time given, relative to Parent for all RequiredBones This returns different transform based on additive or not. Animation/AnimComposite.h  

virtual void GetAnimNotifiesFromDeltaPositions ( const float& PreviousPosition,
const float& CurrentPosition,
FAnimNotifyContext& NotifyContext
) const

 Retrieves AnimNotifies between two time positions. Animation/AnimComposite.h  

virtual FFrameRate GetSamplingFrameRate()

 Return rate at which the animation is sampled Animation/AnimComposite.h  

virtual void HandleAssetPlayerTickedInternal ( FAnimAssetTickContext& Context,
const float PreviousTime,
const float MoveDelta,
const FAnimTickRecord& Instance,
FAnimNotifyQueue& NotifyQueue
) const

   Animation/AnimComposite.h  

virtual bool HasRootMotion()

   Animation/AnimComposite.h  

virtual bool IsNotifyAvailable()

 Return true if anim notify is available Animation/AnimComposite.h  

Overridden from UAnimationAsset

Name Remarks Include Path Unreal Specifiers

virtual bool GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& AnimationSequences,
bool bRecursive
)

 Retrieve all animations that are used by this asset Animation/AnimComposite.h  

virtual bool IsValidAdditive()

 Return true if this is valid additive animation false otherwise Animation/AnimComposite.h  

virtual void ReplaceReferredAnimations ( const TMap< UAnimationAsset*, UAnimationAsset* >& ReplacementMap
)

 Replace this assets references to other animations based on ReplacementMap Animation/AnimComposite.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Animation/AnimComposite.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Animation/AnimComposite.h  

virtual void PostLoad()

   Animation/AnimComposite.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page