1. Epic GamesDeveloper
  3. FAnimSegment

FAnimSegment

This is anim segment that defines what animation and how

API > API/Runtime > API/Runtime/Engine

This is anim segment that defines what animation and how

   
Name FAnimSegment
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimCompositeBase.h
Include Path #include "Animation/AnimCompositeBase.h"

Syntax

USTRUCT ()  
struct FAnimSegment

Constructors

Name Remarks Include Path Unreal Specifiers
  Animation/AnimCompositeBase.h  
  Animation/AnimCompositeBase.h  
  Animation/AnimCompositeBase.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimEndTime float Time to end playing the AnimSequence at. Animation/AnimCompositeBase.h
  • EditAnywhere
  • Category=AnimSegment
  • Meta=(DisplayName="End Time")
AnimPlayRate float Playback speed of this animation. If you'd like to reverse, set -1 Animation/AnimCompositeBase.h
  • EditAnywhere
  • Category=AnimSegment
  • Meta=(DisplayName="Play Rate")
AnimStartTime float Time to start playing AnimSequence at. Animation/AnimCompositeBase.h
  • EditAnywhere
  • Category=AnimSegment
  • Meta=(DisplayName="Start Time")
CachedPlayLength float   Animation/AnimCompositeBase.h
  • EditAnywhere
  • Category=AnimSegment
  • Meta=(DisplayName="Cached Animation Asset length")
LoopingCount int32   Animation/AnimCompositeBase.h
  • EditAnywhere
  • Category=AnimSegment
  • Meta=(DisplayName="Loop Count")
StartPos float Start Pos within this AnimCompositeBase Animation/AnimCompositeBase.h
  • VisibleAnywhere
  • Category=AnimSegment
  • Meta=(DisplayName="Starting Position")

Protected

Name Type Remarks Include Path Unreal Specifiers
bValid bool This gets invalidated if this section started recursive Animation/AnimCompositeBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float ConvertTrackPosToAnimPos ( const float& TrackPosition
) const

 Converts 'Track Position' to position on AnimSequence. Animation/AnimCompositeBase.h  

UAnimSequenceBase * GetAnimationData ( float PositionInTrack,
float& PositionInAnim
) const

 Get Animation Data. Animation/AnimCompositeBase.h  

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

 Retrieves AnimNotifies between two Track time positions. Animation/AnimCompositeBase.h  

const TObjectPtr< UAnimSequenceBase > & GetAnimReference()

   Animation/AnimCompositeBase.h  

float GetEndPos()

 End Position within this AnimCompositeBase Animation/AnimCompositeBase.h  

float GetLength()

   Animation/AnimCompositeBase.h  

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

 Given a Track delta position [StartTrackPosition, EndTrackPosition] See if this AnimSegment overlaps any of it, and if it does, break it up into RootMotionExtractionSteps. Animation/AnimCompositeBase.h  

float GetValidPlayRate()

 Ensures PlayRate is non Zero Animation/AnimCompositeBase.h  

bool IsIncluded ( float InStartPos,
float InEndPos
) const

 Return true if it's included within the input range Animation/AnimCompositeBase.h  

bool IsInRange ( float CurPos
) const

   Animation/AnimCompositeBase.h  

bool IsNotifyAvailable()

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

bool IsPlayLengthOutOfDate()

   Animation/AnimCompositeBase.h  

bool IsValid()

 Return true if valid, false otherwise, only invalid if we contains recursive reference Animation/AnimCompositeBase.h  

void SetAnimReference ( UAnimSequenceBase* InAnimReference,
bool bInitialize
)

   Animation/AnimCompositeBase.h  

void UpdateCachedPlayLength()

   Animation/AnimCompositeBase.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Animation/AnimCompositeBase.h  
  Animation/AnimCompositeBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page