UMovieSceneSkeletalAnimationSection

Movie scene section that control skeletal animation

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MovieSceneTracks

Header

/Engine/Source/Runtime/MovieSceneTracks/Public/Sections/MovieSceneSkeletalAnimationSection.h

Include

#include "Sections/MovieSceneSkeletalAnimationSection.h"

Syntax

class UMovieSceneSkeletalAnimationSection : public UMovieSceneSection

Remarks

Movie scene section that control skeletal animation

Variables

Name Description

Public variable

bool

 

bMatchIncludeZHeight

Public variable

bool

 

bMatchRotationPitch

Public variable

bool

 

bMatchRotationRoll

Public variable

bool

 

bMatchRotationYaw

Public variable

bool

 

bMatchTranslation

Public variable

bool

 

bMatchWithPrevious

Public variable

bool

 

bShowSkeleton

Whether to show the underlying skeleton for this section.

Public variable

FName

 

MatchedBoneName

Public variable

FVector

 

MatchedLocationOffset

Public variable

FRotator

 

MatchedRotationOffset

Public variable

FMovieSceneSkel...

 

Params

Public variable

float

 

PreviousPlayRate

Public variable

FVector

 

StartLocationOffset

Location Offset applied to this this animations start root motion

Public variable

FRotator

 

StartRotationOffset

Rotation Offset applied to this this animations start root motion

Public variable

FTransform

 

TempOffsetTransform

Temporary transform used to specify the global OffsetTransform while calculting the root motions.

Public variable

TOptional< int3...

 

TempRootBoneIndex

Temporary index used by GetRootMotionTransform and set by SetBoneIndexforRootMotionCalculations.

Constructors

Name Description

Public function

UMovieSceneSkeletalAnimationSection

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

ClearMatchedOffsetTransforms()

Public function

void

 

FindBestBlendPoint

(
    USkeletalMeshComponent* SkelMe...
)

Public function Const

FTransform

 

GetOffsetTransform()

Public function Const

TOptional< F...

 

GetRootMotion

(
    FFrameTime CurrentTime,
    bool& bBlendFirstChildOfRoot
)

Public function Const

FMovieSceneS...

 

GetRootMotionParams()

Functions/params related to root motion calcuations.

Public function Const

bool

 

GetRootMotionTransform

(
    FFrameTime CurrentTime,
    FFrameRate FrameRate,
    FAnimationPoseData& AnimationPoseD...,
    bool& bIsAdditive,
    FTransform& OutTransform,
    float& OutWeight
)

Public function Const

bool

 

GetRootMotionVelocity

(
    FFrameTime PreviousTime,
    FFrameTime CurrentTime,
    FFrameRate FrameRate,
    FTransform& OutVelocity,
    float& OutWeight
)

Public function Const

double

 

MapTimeToAnimation

(
    FFrameTime InPosition,
    FFrameRate InFrameRate
)

Get Frame Time as Animation Time

Public function

void

 

MatchSectionByBoneTransform

(
    USkeletalMeshComponent* SkelMe...,
    FFrameTime CurrentFrame,
    FFrameRate FrameRate,
    const FName& BoneName
)

Public function

int32

 

SetBoneIndexForRootMotionCalculations

(
    bool bBlendFirstChildOfRoot
)

Public function

void

 

ToggleMatchIncludePitchRotation()

Public function

void

 

ToggleMatchIncludeRollRotation()

Public function

void

 

ToggleMatchIncludeYawRotation()

Public function

void

 

ToggleMatchIncludeZHeight()

Public function

void

 

ToggleMatchTranslation()

Public function

void

 

ToggleShowSkeleton()

Overridden from UMovieSceneSection

Name Description

Protected function Virtual Const

TOptional< T...

 

GetAutoSizeRange()

Returns the range to auto size this section to, if there is one.

Protected function Virtual Const

TOptional< F...

 

GetOffsetTime()

The optional offset time of this section

Protected function Virtual Const

void

 

GetSnapTimes

(
    TArray< FFrameNumber >& OutSnapTim...,
    bool bGetSectionBorders
)

Gets all snap times for this section

Protected function Virtual Const

float

 

GetTotalWeightValue

(
    FFrameTime InTime
)

Get The Total Weight Value for this Section For Most Sections it's just the Ease Value, but for some Sections also have an extra Weight Curve

Protected function Virtual

void

 

MigrateFrameTimes

(
    FFrameRate SourceRate,
    FFrameRate DestinationRate
)

Migrate the frame times of the movie scene section from the source frame rate to the destination frame rate

Public function Virtual

void

 

SetEndFrame

(
    TRangeBound< FFrameNumber > NewEndF...
)

Set this section's end frame in sequence resolution space @note Will be clamped to the current start frame if necessary

Public function Virtual

void

 

SetRange

(
    const TRange< FFrameNumber >& NewR...
)

Sets a new range of times for this section

Public function Virtual

void

 

SetStartFrame

(
    TRangeBound< FFrameNumber > NewStar...
)

Set this section's start frame in sequence resolution space.

Protected function Virtual

UMovieSceneS...

 

SplitSection

(
    FQualifiedFrameTime SplitTime,
    bool bDeleteKeys
)

Split a section in two at the split time

Protected function Virtual

void

 

TrimSection

(
    FQualifiedFrameTime TrimTime,
    bool bTrimLeft,
    bool bDeleteKeys
)

Trim a section at the trim time

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostLoad()

~UObject interface

Protected function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.