MovieSceneCommonAnimationTrack.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/FrameNumber.h"
#include "MovieSceneNameableTrack.h"
#include "MovieSceneCommonAnimationTrack.generated.h"
 
#define UE_API MOVIESCENETRACKS_API
 
class UAnimSequenceBase;
class UMovieSceneSection;
class UMovieSceneSkeletalAnimationSection;
 
USTRUCT()
struct FMovieSceneSkeletalAnimRootMotionTrackParams
{
    GENERATED_BODY()
 
    FFrameTime FrameTick; 
    FFrameTime StartFrame;
    FFrameTime EndFrame;
    bool bRootMotionsDirty;
    bool bHaveRootMotion;
    FTransform RootMotionStartOffset; // root motion may not be in Mesh Space if we are putting values on a bone that is a child of a root with an offset
    FMovieSceneSkeletalAnimRootMotionTrackParams() : bRootMotionsDirty(true),bHaveRootMotion(false) {}
 
#if WITH_EDITORONLY_DATA
    bool bCacheRootTransforms = false;
    TArray<FTransform> RootTransforms;
#endif
};
 
UCLASS(MinimalAPI)
class UMovieSceneCommonAnimationTrack
    : public UMovieSceneNameableTrack
{
    GENERATED_BODY()
 
public:
 
    UE_API UMovieSceneCommonAnimationTrack(const FObjectInitializer& ObjInit);
 
    UE_API virtual UMovieSceneSection* AddNewAnimationOnRow(FFrameNumber KeyTime, UAnimSequenceBase* AnimSequence, int32 RowIndex);
 
     virtual UMovieSceneSection* AddNewAnimation(FFrameNumber KeyTime, UAnimSequenceBase* AnimSequence) { return AddNewAnimationOnRow(KeyTime, AnimSequence, INDEX_NONE); }
 
    UE_API virtual const TArray<UMovieSceneSection*>& GetAllSections() const override;
    UE_API virtual UMovieSceneSection* CreateNewSection() override;
    UE_API virtual bool SupportsType(TSubclassOf<UMovieSceneSection> SectionClass) const override;
    UE_API virtual bool SupportsMultipleRows() const override;
    UE_API virtual void RemoveAllAnimationData() override;
    UE_API virtual bool HasSection(const UMovieSceneSection& Section) const override;
    UE_API virtual void AddSection(UMovieSceneSection& Section) override;
    UE_API virtual void RemoveSection(UMovieSceneSection& Section) override;
    UE_API virtual void RemoveSectionAt(int32 SectionIndex) override;
    UE_API virtual bool IsEmpty() const override;
    UE_API virtual void UpdateEasing() override;
 
#if WITH_EDITOR
    UE_API virtual void PostEditImport() override;
    UE_API virtual void PostEditUndo() override;
    UE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
    virtual bool ShouldUseRootMotions() const
    {
        return false;
    }
 
public:
 
    UE_API void SetRootMotionsDirty();
    UE_API void SetUpRootMotions(bool bForce);
    UE_API TOptional<FTransform>  GetRootMotion(FFrameTime CurrentTime);
    UE_API void MatchSectionByBoneTransform(bool bMatchWithPrevious, USkeletalMeshComponent* SkelMeshComp, UMovieSceneSkeletalAnimationSection* CurrentSection, FFrameTime CurrentFrame, FFrameRate FrameRate,
        const FName& BoneName, FTransform& SecondSectionRootDiff, FVector& TranslationDiff, FQuat& RotationDiff); //add options for z and for rotation.
#if WITH_EDITORONLY_DATA
    UE_API void ToggleShowRootMotionTrail();
#endif
 
#if WITH_EDITOR
    UE_API virtual EMovieSceneSectionMovedResult OnSectionMoved(UMovieSceneSection& Section, const FMovieSceneSectionMovedParams& Params) override;
#endif
 
private:
    //Not called yet, will be used to automatch a section when it's added to another
    UE_API void AutoMatchSectionRoot(UMovieSceneSkeletalAnimationSection* AnimSection);
 
    UE_API void SortSections();
 
public:
 
    UPROPERTY()
    TArray<TObjectPtr<UMovieSceneSection>> AnimationSections;
 
    UPROPERTY()
    FMovieSceneSkeletalAnimRootMotionTrackParams RootMotionParams;
 
    UPROPERTY(EditAnywhere, Category = "Root Motions")
    bool bBlendFirstChildOfRoot;
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Category = "Root Motions")
    bool bShowRootMotionTrail;
 
#endif
};
 
#undef UE_API