1. Epic GamesDeveloper
  3. FAnimSegment

FAnimSegment

This is anim segment that defines what animation and how

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

References

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

Syntax

struct FAnimSegment

Remarks

This is anim segment that defines what animation and how

Variables

  Type Name Description
Public variable float AnimEndTime Time to end playing the AnimSequence at.
Public variable float AnimPlayRate Playback speed of this animation. If you'd like to reverse, set -1
Public variable float AnimStartTime Time to start playing AnimSequence at.
Public variable float CachedPlayLength  
Public variable int32 LoopingCount  
Public variable float StartPos Start Pos within this AnimCompositeBase

Constructors

  Type Name Description
Public function    
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS  
Public function    

Functions

  Type Name Description
Public function Const float

ConvertTrackPosToAnimPos ( const float& TrackPosition
)

 Converts 'Track Position' to position on AnimSequence.
Public function Const UAnimSequenceBase *

GetAnimationData ( float PositionInTrack,
float& PositionInAnim
)

 Get Animation Data.
Public function Const void

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

  
Public function Const const TObjectPtr< UAnimSequenceBase > &  
Public function Const float End Position within this AnimCompositeBase
Public function Const float  
Public function Const void

GetRootMotionExtractionStepsForTrackRange ( TArray< FRootMotionExtractionStep >& RootMotionExtractionSteps,
const float StartPosition,
const float EndPosition
)

 Given a Track delta position [StartTrackPosition, EndTrackPosition] See if this AnimSegment overlaps any of it, and if it does, break it up into RootMotionExtractionSteps.
Public function Const float Ensures PlayRate is non Zero
Public function Const bool

IsIncluded ( float InStartPos,
float InEndPos
)

 Return true if it's included within the input range
Public function Const bool

IsInRange ( float CurPos
)

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

IsValid ()

 Return true if valid, false otherwise, only invalid if we contains recursive reference
Public function void

SetAnimReference ( UAnimSequenceBase* InAnimReference,
bool bInitialize
)

  
Public function void  

Operators

  Type Name Description
Public function FAnimSegment &

operator= ( const FAnimSegment&
)

  
Public function FAnimSegment &  

Deprecated Variables

  Type Name Description
Public variable TObjectPtr< UAnimSequenceBase > AnimReference Public access to AnimReference has been deprecated, use Set/Get-AnimReference instead

Deprecated Functions

  Type Name Description
Public function Const void

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

 Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyContext instead
Public function Const void

GetAnimNotifiesFromTrackPositions ( const float& PreviousTrackPosition,
const float& CurrentTrackPosition,
TArray< const FAnimNotifyEvent* >& OutActiveNotifies
)

 Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyContext instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page