FAnimTrack

This is list of anim segments for this track For now this is only one [TArray](API\Runtime\Core\Containers\TArray), but in the future we should define more transition/blending behaviors

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Animation/AnimCompositeBase.h

Include

#include "Animation/AnimCompositeBase.h"

Syntax

struct FAnimTrack

Remarks

This is list of anim segments for this track For now this is only one TArray, but in the future we should define more transition/blending behaviors

Variables

Name Description

Public variable

TArray< FAnimSe...

 

AnimSegments

Constructors

Name Description

Public function

FAnimTrack()

Functions

Name Description

Public function

void

 

CollapseAnimSegments()

Moves anim segments so that there are no gaps between one finishing and the next starting, preserving the order of AnimSegments

Public function

bool

 

ContainRecursive

(
    const TArray< UAnimCompositeBase&#...
)

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

Public function

void

 

EnableRootMotionSettingFromMontage

(
    bool bInEnableRootMotion,
    const ERootMotionRootLock::Type InR...
)

Enable Root motion setting from montage

Public function Const

UAnimSequenc...

 

GetAdditiveBasePose()

Get Addiitve Base Pose if additive

Public function Const

bool

 

GetAllAnimationSequencesReferred

(
    TArray< UAnimationAsset* >& A...,
    bool bRecursive
)

Public function Const

void

 

GetAnimationPose

(
    FAnimationPoseData& OutAnimationPo...,
    const FAnimExtractContext& Extract...
)

Public function Const

void

 

GetAnimNotifiesFromTrackPositions

(
    const float& PreviousTrackPosition,
    const float& CurrentTrackPosition,
    FAnimNotifyContext& NotifyContext
)

Retrieves AnimNotifies between two Track time positions.

Public function Const

float

 

GetLength()

Public function Const

void

 

GetRootMotionExtractionStepsForTrackRange

(
    TArray< FRootMotionExtractionStep >...,
    const float StartTrackPosition,
    const float EndTrackPosition
)

Given a Track delta position [StartTrackPosition, EndTrackPosition] See if any AnimSegment overlaps any of it, and if it does, break it up into RootMotionExtractionPieces.

Public function Const

const FAnimS...

 

GetSegmentAtTime

(
    float InTime
)

Get the segment at the given absolute montage time

Public function

FAnimSegment...

 

GetSegmentAtTime

(
    float InTime
)

Get the segment at the given absolute montage time

Public function Const

int32

 

GetSegmentIndexAtTime

(
    float InTime
)

Gets the index of the segment at the given absolute montage time.

Public function Const

int32

 

GetTrackAdditiveType()

Public function Const

bool

 

HasRootMotion()

Returns whether any of the animation sequences this track uses has root motion

Public function

void

 

InvalidateRecursiveAsset

(
    UAnimCompositeBase* CheckAsset
)

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 Const

bool

 

IsAdditive()

Public function Const

bool

 

IsNotifyAvailable()

Return true if anim notify is available

Public function Const

bool

 

IsRotationOffsetAdditive()

Public function Const

bool

 

IsValidToAdd

(
    const UAnimSequenceBase* Seque...
)

Return true if valid to add

Public function

void

 

ReplaceReferredAnimations

(
    const TMap< UAnimationAsset*, ...
)

Public function

void

 

SortAnimSegments()

Sorts AnimSegments based on the start time of each segment

Public function

void

 

ValidateSegmentTimes()

Ensure segment times are correctly formed (no gaps and no extra time at the end of the anim reference)

Deprecated Functions

Name Description

Public function Const

void

 

GetAnimationPose

(
    FCompactPose& OutPose,
    FBlendedCurve& OutCurve,
    const FAnimExtractContext& Extract...
)

Use other GetAnimationPose signature

Public function Const

void

 

GetAnimNotifiesFromTrackPositions

(
    const float& PreviousTrackPosition,
    const float& CurrentTrackPosition,
    TArray< FAnimNotifyEventReference >...
)

Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyContext instead

Public function Const

void

 

GetAnimNotifiesFromTrackPositions

(
    const float& PreviousTrackPosition,
    const float& CurrentTrackPosition,
    TArray< const FAnimNotifyEvent*...
)

Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyEventReferences instead