Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FAnimSegment

This is anim segment that defines what animation and how

Windows

MacOS

Linux

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

	Name	Description
float	AnimEndTime	Time to end playing the AnimSequence at.
float	AnimPlayRate	Playback speed of this animation. If you'd like to reverse, set -1
UAnimSequenceBa...	AnimReference	Anim Reference to play - only allow AnimSequence or AnimComposite
float	AnimStartTime	Time to start playing AnimSequence at.
int32	LoopingCount
float	StartPos	Start Pos within this AnimCompositeBase

Constructors

	Name	Description
	FAnimSegment()

Functions

	Name	Description
float	ConvertTrackPosToAnimPos ( const float& TrackPosition )	Converts 'Track Position' to position on AnimSequence.
UAnimSequenc...	GetAnimationData ( float PositionInTrack, float& PositionInAnim )	Get Animation Data.
void	GetAnimNotifiesFromTrackPositions ( const float& PreviousTrackPosition, const float& CurrentTrackPosition, TArray< FAnimNotifyEventReference >... )	Retrieves AnimNotifies between two Track time positions.
float	GetEndPos()	End Position within this AnimCompositeBase
float	GetLength()
void	GetRootMotionExtractionStepsForTrackRange ( TArray< FRootMotionExtractionStep >..., 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.
float	GetValidPlayRate()	Ensures PlayRate is non Zero
bool	IsIncluded ( float InStartPos, float InEndPos )	Return true if it's included within the input range
bool	IsInRange ( float CurPos )
bool	IsNotifyAvailable()	Return true if anim notify is available
bool	IsValid()	Return true if valid, false otherwise, only invalid if we contains recursive reference

Deprecated Functions

		Name	Description
	void	GetAnimNotifiesFromTrackPositions ( const float& PreviousTrackPosition, const float& CurrentTrackPosition, TArray< const FAnimNotifyEvent*... )	Use the GetAnimNotifiesFromTrackPositions that takes FAnimNotifyEventReferences instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss