1. Epic GamesDeveloper
  3. UAnimComposite

UAnimComposite

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

Unreal Engine C++ API Reference > Runtime > Engine > Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimComposite.h
Include #include "Animation/AnimComposite.h"

Syntax

class UAnimComposite : public UAnimCompositeBase

Remarks

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

Variables

  Type Name Description
Public variable FAnimTrack AnimationTrack Serializable data that stores section/anim pairing
Public variable TObjectPtr< UAnimSequence > PreviewBasePose Preview Base pose for additive BlendSpace

Constructors

  Type Name Description
Public function  

UAnimComposite ( const FObjectInitializer& ObjectInitializer
)

  

Overridden from UAnimCompositeBase

  Type Name Description
Public function Virtual bool

ContainRecursive ( TArray< UAnimCompositeBase* >& CurrentAccumulatedList
)

 This is recursive function that look thorough internal assets and clear the reference if recursive is found.
Public function Virtual void This is to prevent anybody adding recursive asset to anim composite as a result of anim composite being a part of anim sequence base
Public function Virtual void

SetCompositeLength ( float InLength
)

  
Public function Virtual void  

Overridden from UAnimSequenceBase

  Type Name Description
Public function Virtual void

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

 To support anim sequence base to montage
Public function Virtual Const FTransform

ExtractRootMotion ( float StartTime,
float DeltaTime,
bool bAllowLooping
)

 Extract Root Motion transform from the animation.
Public function Virtual Const FTransform

ExtractRootMotionFromRange ( float StartTrackPosition,
float EndTrackPosition
)

 Extract Root Motion transform from a contiguous position range (no looping)
Public function Virtual Const FTransform

ExtractRootTrackTransform ( float Time,
const FBoneContainer* RequiredBones
)

 Extract the transform from the root track for the given animation position.
Public function Virtual Const EAdditiveAnimationType Default implementation, no additive
Public function Virtual Const UAnimSequence * Ideally this would be animsequcnebase, but we might have some issue with that. For now, just allow AnimSequence
Public function Virtual Const void

GetAnimationPose ( FAnimationPoseData& OutAnimationPoseData,
const FAnimExtractContext& ExtractionContext
)

  
Public function Virtual Const void

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

 Retrieves AnimNotifies between two time positions.
Public function Virtual Const FFrameRate Return rate at which the animation is sampled
Public function Virtual Const void

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

  
Public function Virtual Const bool  
Public function Virtual Const bool Return true if anim notify is available

Overridden from UAnimationAsset

  Type Name Description
Public function Virtual bool

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

 Retrieve all animations that are used by this asset
Public function Virtual Const bool Return true if this is valid additive animation false otherwise
Public function Virtual void Replace this assets references to other animations based on ReplacementMap

Overridden from UObject

  Type Name Description
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page