1. Epic GamesDeveloper
  3. FMovieSceneSkeletalAnimationParams

FMovieSceneSkeletalAnimationParams

API > API/Runtime > API/Runtime/MovieSceneTracks

   
Name FMovieSceneSkeletalAnimationParams
Type struct
Header File /Engine/Source/Runtime/MovieSceneTracks/Public/Sections/MovieSceneSkeletalAnimationSection.h
Include Path #include "Sections/MovieSceneSkeletalAnimationSection.h"

Syntax

USTRUCT (BlueprintType )  
struct FMovieSceneSkeletalAnimationParams

Constructors

Name Remarks Include Path Unreal Specifiers

FMovieSceneSkeletalAnimationParams()

   Sections/MovieSceneSkeletalAnimationSection.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Animation TObjectPtr< UAnimSequenceBase > The animation this section plays Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation"
  • Meta=(AllowedClasses="/Script/Engine.AnimSequence,/Script/Engine.AnimComposite,/Script/Engine.AnimStreamable")
bForceCustomMode bool If on animation sequence will always play when active even if the animation is controlled by a Blueprint or Anim Instance Class Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
bLinearPlaybackWhenScaled bool   Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
bReverse uint32 Reverse the playback of the animation clip Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
bSkipAnimNotifiers bool If on will skip sending animation notifies Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
EndFrameOffset FFrameNumber The offset into the end of the animation clip Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Offset"
FirstLoopStartFrameOffset FFrameNumber The offset into the beginning of the animation clip for the first loop of play. Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Offset"
MirrorDataTable TObjectPtr< class UMirrorDataTable >   Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
PlayRate FMovieSceneTimeWarpVariant The playback rate of the animation clip Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
SlotName FName The slot name to use for the animation Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
StartFrameOffset FFrameNumber The offset into the beginning of the animation clip Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Offset"
SwapRootBone ESwapRootBone If on the root bone transform will be swapped to the specified root Sections/MovieSceneSkeletalAnimationSection.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Animation|Playback"
Weight FMovieSceneFloatChannel The weight curve for this animation section Sections/MovieSceneSkeletalAnimationSection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetDuration()

 Gets the animation duration, modified by play rate Sections/MovieSceneSkeletalAnimationSection.h  

float GetSequenceLength()

 Gets the animation sequence length, not modified by play rate Sections/MovieSceneSkeletalAnimationSection.h  

FMovieSceneSequenceTransform MakeTransform ( const FFrameRate& OuterFrameRate,
const TRange< FFrameNumber >& OuterRange,
UAnimSequenceBase* OverrideSequence,
bool bClampToOuterRange,
bool bForceLoop
) const

 Make a transform structure from these animation parameters Sections/MovieSceneSkeletalAnimationSection.h  

double MapTimeToAnimation ( const UMovieSceneSection* InSection,
FFrameTime InPosition,
FFrameRate InFrameRate,
UAnimSequenceBase* OverrideSequence
) const

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

double MapTimeToAnimation ( FFrameNumber InSectionStartTime,
FFrameNumber InSectionEndTime,
FFrameTime InPosition,
FFrameRate InFrameRate,
UAnimSequenceBase* OverrideSequence
) const

 As above, but with already computed section bounds. Sections/MovieSceneSkeletalAnimationSection.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
EndOffset_DEPRECATED float   Sections/MovieSceneSkeletalAnimationSection.h  
StartOffset_DEPRECATED float   Sections/MovieSceneSkeletalAnimationSection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page