UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneSkeletalAnimationParams Struct Reference

#include <MovieSceneSkeletalAnimationSection.h>

Public Member Functions

 FMovieSceneSkeletalAnimationParams ()
 
float GetDuration () const
 
float GetSequenceLength () const
 
double MOVIESCENETRACKS_API MapTimeToAnimation (const UMovieSceneSection *InSection, FFrameTime InPosition, FFrameRate InFrameRate, UAnimSequenceBase *OverrideSequence=nullptr) const
 
double MOVIESCENETRACKS_API MapTimeToAnimation (FFrameNumber InSectionStartTime, FFrameNumber InSectionEndTime, FFrameTime InPosition, FFrameRate InFrameRate, UAnimSequenceBase *OverrideSequence=nullptr) const
 
MOVIESCENETRACKS_API FMovieSceneSequenceTransform MakeTransform (const FFrameRate &OuterFrameRate, const TRange< FFrameNumber > &OuterRange, UAnimSequenceBase *OverrideSequence=nullptr, bool bClampToOuterRange=true, bool bForceLoop=false) const
 

Public Attributes

TObjectPtr< UAnimSequenceBaseAnimation
 
FFrameNumber FirstLoopStartFrameOffset
 
FFrameNumber StartFrameOffset
 
FFrameNumber EndFrameOffset
 
FMovieSceneTimeWarpVariant PlayRate
 
uint32 bReverse:1
 
FName SlotName
 
TObjectPtr< class UMirrorDataTableMirrorDataTable
 
FMovieSceneFloatChannel Weight
 
bool bSkipAnimNotifiers
 
bool bForceCustomMode
 
ESwapRootBone SwapRootBone
 
bool bLinearPlaybackWhenScaled
 
float StartOffset_DEPRECATED
 
float EndOffset_DEPRECATED
 

Constructor & Destructor Documentation

◆ FMovieSceneSkeletalAnimationParams()

FMovieSceneSkeletalAnimationParams::FMovieSceneSkeletalAnimationParams ( )

Member Function Documentation

◆ GetDuration()

float FMovieSceneSkeletalAnimationParams::GetDuration ( ) const
inline

Gets the animation duration, modified by play rate

◆ GetSequenceLength()

float FMovieSceneSkeletalAnimationParams::GetSequenceLength ( ) const
inline

Gets the animation sequence length, not modified by play rate

◆ MakeTransform()

FMovieSceneSequenceTransform FMovieSceneSkeletalAnimationParams::MakeTransform ( const FFrameRate OuterFrameRate,
const TRange< FFrameNumber > &  OuterRange,
UAnimSequenceBase OverrideSequence = nullptr,
bool  bClampToOuterRange = true,
bool  bForceLoop = false 
) const

Make a transform structure from these animation parameters

◆ MapTimeToAnimation() [1/2]

double FMovieSceneSkeletalAnimationParams::MapTimeToAnimation ( const UMovieSceneSection InSection,
FFrameTime  InPosition,
FFrameRate  InFrameRate,
UAnimSequenceBase OverrideSequence = nullptr 
) const

Convert a sequence frame to a time in seconds inside the animation clip, taking into account start/end offsets, looping, etc.

◆ MapTimeToAnimation() [2/2]

double FMovieSceneSkeletalAnimationParams::MapTimeToAnimation ( FFrameNumber  InSectionStartTime,
FFrameNumber  InSectionEndTime,
FFrameTime  InPosition,
FFrameRate  InFrameRate,
UAnimSequenceBase OverrideSequence = nullptr 
) const

As above, but with already computed section bounds.

Member Data Documentation

◆ Animation

TObjectPtr<UAnimSequenceBase> FMovieSceneSkeletalAnimationParams::Animation

The animation this section plays

◆ bForceCustomMode

bool FMovieSceneSkeletalAnimationParams::bForceCustomMode

If on animation sequence will always play when active even if the animation is controlled by a Blueprint or Anim Instance Class

◆ bLinearPlaybackWhenScaled

bool FMovieSceneSkeletalAnimationParams::bLinearPlaybackWhenScaled

◆ bReverse

uint32 FMovieSceneSkeletalAnimationParams::bReverse

Reverse the playback of the animation clip

◆ bSkipAnimNotifiers

bool FMovieSceneSkeletalAnimationParams::bSkipAnimNotifiers

If on will skip sending animation notifies

◆ EndFrameOffset

FFrameNumber FMovieSceneSkeletalAnimationParams::EndFrameOffset

The offset into the end of the animation clip

◆ EndOffset_DEPRECATED

float FMovieSceneSkeletalAnimationParams::EndOffset_DEPRECATED

◆ FirstLoopStartFrameOffset

FFrameNumber FMovieSceneSkeletalAnimationParams::FirstLoopStartFrameOffset

The offset into the beginning of the animation clip for the first loop of play.

◆ MirrorDataTable

TObjectPtr<class UMirrorDataTable> FMovieSceneSkeletalAnimationParams::MirrorDataTable

◆ PlayRate

FMovieSceneTimeWarpVariant FMovieSceneSkeletalAnimationParams::PlayRate

The playback rate of the animation clip

◆ SlotName

FName FMovieSceneSkeletalAnimationParams::SlotName

The slot name to use for the animation

◆ StartFrameOffset

FFrameNumber FMovieSceneSkeletalAnimationParams::StartFrameOffset

The offset into the beginning of the animation clip

◆ StartOffset_DEPRECATED

float FMovieSceneSkeletalAnimationParams::StartOffset_DEPRECATED

◆ SwapRootBone

ESwapRootBone FMovieSceneSkeletalAnimationParams::SwapRootBone

If on the root bone transform will be swapped to the specified root

◆ Weight

FMovieSceneFloatChannel FMovieSceneSkeletalAnimationParams::Weight

The weight curve for this animation section


The documentation for this struct was generated from the following files: