Navigation
API > API/Plugins > API/Plugins/MovieSceneAnimMixer
Decoration that provides root motion offset settings. Can live on a section (skeletal animation) or on a track (control rig child track). When on a section, channels are hosted by the parent section via IMovieSceneChannelDecoration. When on a track, an internal host section is created via IMovieSceneSectionProviderDecoration.
| Name | UMovieSceneRootMotionSettingsDecoration |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MovieSceneAnimMixer/Source/MovieSceneAnimMixer/Public/MovieSceneAnimationMixerTrack.h |
| Include Path | #include "MovieSceneAnimationMixerTrack.h" |
Syntax
UCLASS (MinimalAPI, CollapseCategories, Meta=(DisplayName="Root Motion Settings"))
class UMovieSceneRootMotionSettingsDecoration :
public UMovieSceneSignedObject ,
public IMovieSceneChannelDecoration ,
public IMovieSceneEntityDecorator ,
public IMovieSceneSectionProviderDecoration ,
public IMovieSceneSectionDecoration ,
public IMovieSceneTrackDecoration
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneSignedObject → UMovieSceneRootMotionSettingsDecoration
Implements Interfaces
- IMovieSceneChannelDecoration
- IMovieSceneEntityDecorator
- IMovieSceneSectionDecoration
- IMovieSceneSectionProviderDecoration
- IMovieSceneTrackDecoration
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieSceneRootMotionSettingsDecoration
(
const FObjectInitializer& ObjInit |
MovieSceneAnimationMixerTrack.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitialRootTransformValid | bool | MovieSceneAnimationMixerTrack.h | ||
| BoneMatchChannel | FMovieSceneBoneMatchChannel | MovieSceneAnimationMixerTrack.h | ||
| bShowSkeleton | bool | When true, the edit mode draws this section's skeleton in the viewport. Useful for bone matching. | MovieSceneAnimationMixerTrack.h |
|
| HostSection | TObjectPtr< UMovieSceneSection > | Internal section for hosting channels when the decoration lives on a track. | MovieSceneAnimationMixerTrack.h | |
| InitialRootTransform | FTransform | Cached initial root transform at the section's start time, computed via isolated bake evaluation. | MovieSceneAnimationMixerTrack.h | |
| KeepStateChannel | FMovieSceneByteChannelDefaultOnly | MovieSceneAnimationMixerTrack.h | ||
| Location | FMovieSceneDoubleChannel | MovieSceneAnimationMixerTrack.h | ||
| LoopModeChannel | FMovieSceneByteChannelDefaultOnly | MovieSceneAnimationMixerTrack.h | ||
| LoopStartRootTransform | FTransform | Root transform at the animation's natural start (frame 0). | MovieSceneAnimationMixerTrack.h | |
| RootMotionSourceChannel | FMovieSceneByteChannelDefaultOnly | MovieSceneAnimationMixerTrack.h | ||
| RootMotionSpace | FMovieSceneByteChannelDefaultOnly | MovieSceneAnimationMixerTrack.h | ||
| RootOriginLocation | FVector | MovieSceneAnimationMixerTrack.h |
|
|
| Rotation | FMovieSceneDoubleChannel | MovieSceneAnimationMixerTrack.h | ||
| TransformMode | FMovieSceneByteChannelDefaultOnly | MovieSceneAnimationMixerTrack.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnsureHostSection() |
Creates the internal host section when the decoration is added to a track. | MovieSceneAnimationMixerTrack.h | |
FMovieSceneBoneMatchData GetBoneMatchData() |
Read the first key from the channel, or return a default (invalid) match. | MovieSceneAnimationMixerTrack.h | |
TOptional< FFrameTime > GetFirstLoopBoundary
(
const FFrameRate& TickResolution |
Returns the first loop boundary time for the owning section, or TOptional empty if the section doesn't loop. | MovieSceneAnimationMixerTrack.h | |
FTransform GetInitialRootTransformAtTime
(
FFrameTime Time, |
Returns the appropriate initial root transform for the given time - either InitialRootTransform for the first loop iteration, or LoopStartRootTransform for subsequent iterations. | MovieSceneAnimationMixerTrack.h | |
bool GetKeepStateAfterSectionEnds() |
MovieSceneAnimationMixerTrack.h | ||
EMovieSceneAnimLoopMode GetLoopMode() |
MovieSceneAnimationMixerTrack.h | ||
EMovieSceneRootMotionSource GetRootMotionSource() |
MovieSceneAnimationMixerTrack.h | ||
EMovieSceneRootMotionTransformMode GetRootTransformMode() |
MovieSceneAnimationMixerTrack.h | ||
bool HasBoneMatch() |
MovieSceneAnimationMixerTrack.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ExtendEntityImpl
(
UMovieSceneEntitySystemLinker* EntityLinker, |
MovieSceneAnimationMixerTrack.h |
Overridden from IMovieSceneChannelDecoration
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMovieSceneChannelProxyType PopulateChannelProxy
(
FMovieSceneChannelProxyData& OutProxyData |
MovieSceneAnimationMixerTrack.h |
Overridden from IMovieSceneSectionProviderDecoration
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArrayView< TObjectPtr< UMovieSceneSection > > GetSections() |
IMovieSceneSectionProviderDecoration - provides an internal section when on a track. | MovieSceneAnimationMixerTrack.h |
Overridden from IMovieSceneSectionDecoration
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnDecorationAdded
(
UMovieSceneSection* Section |
IMovieSceneSectionDecoration - auto-creates Root Motion Target when added to a section. | MovieSceneAnimationMixerTrack.h |
Overridden from IMovieSceneTrackDecoration
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnDecorationAdded
(
UMovieSceneTrack* Track |
IMovieSceneTrackDecoration - auto-creates Root Motion Target when added to a child track. | MovieSceneAnimationMixerTrack.h |