TimelineTemplate.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Misc/Guid.h"
#include "Components/TimelineComponent.h"
#include "Engine/Blueprint.h"
#include "TimelineTemplate.generated.h"
 
class UTimelineTemplate;
 
USTRUCT()
struct FTTTrackBase
{
    enum ETrackType
    {
        TT_Event,
        TT_FloatInterp,
        TT_VectorInterp,
        TT_LinearColorInterp,
    };
 
    GENERATED_USTRUCT_BODY()
 
private:
    UPROPERTY()
    FName TrackName;
 
public:
    UPROPERTY()
    bool bIsExternalCurve;
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    bool bIsExpanded;
    UPROPERTY()
    bool bIsCurveViewSynchronized;
#endif
 
    ENGINE_API bool operator == (const FTTTrackBase& T2) const;
 
    FTTTrackBase()
        : TrackName(NAME_None)
        , bIsExternalCurve(false)
#if WITH_EDITORONLY_DATA
        , bIsExpanded(true)
        , bIsCurveViewSynchronized(true)
#endif
    {}
 
    virtual ~FTTTrackBase() = default;
 
    FName GetTrackName() const { return TrackName; }
    ENGINE_API virtual void SetTrackName(FName NewTrackName, UTimelineTemplate* OwningTimeline);
};
 
USTRUCT()
struct FTTTrackId
{
    GENERATED_USTRUCT_BODY()
 
    FTTTrackId (int32 InType, int32 InIndex)
        : TrackType(InType)
        , TrackIndex(InIndex)
    {}
 
    FTTTrackId()
        : FTTTrackId(0, 0)
    {}
 
    UPROPERTY()
    int32 TrackType;
    UPROPERTY()
    int32 TrackIndex;
};
 
USTRUCT()
struct FTTEventTrack : public FTTTrackBase
{
    GENERATED_USTRUCT_BODY()
 
private:
    UPROPERTY()
    FName FunctionName;
 
public:
    UPROPERTY()
    TObjectPtr<class UCurveFloat> CurveKeys;
 
    ENGINE_API bool operator == (const FTTEventTrack& T2) const;
 
    FName GetFunctionName() const { return FunctionName; }
    ENGINE_API virtual void SetTrackName(FName NewTrackName, UTimelineTemplate* OwningTimeline) override final;
 
    FTTEventTrack()
        : FTTTrackBase()
        , CurveKeys(nullptr)
    {}
};
 
USTRUCT()
struct FTTPropertyTrack : public FTTTrackBase
{
    GENERATED_USTRUCT_BODY()
 
    FName GetPropertyName() const { return PropertyName; }
    ENGINE_API virtual void SetTrackName(FName NewTrackName, UTimelineTemplate* OwningTimeline) override final;
 
private:
    UPROPERTY()
    FName PropertyName;
};
 
USTRUCT()
struct FTTFloatTrack : public FTTPropertyTrack
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    TObjectPtr<class UCurveFloat> CurveFloat;
 
    ENGINE_API bool operator == (const FTTFloatTrack& T2) const;
 
    FTTFloatTrack()
        : FTTPropertyTrack()
        , CurveFloat(nullptr)
    {}
    
};
 
USTRUCT()
struct FTTVectorTrack : public FTTPropertyTrack
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    TObjectPtr<class UCurveVector> CurveVector;
 
    ENGINE_API bool operator == (const FTTVectorTrack& T2) const;
 
    FTTVectorTrack()
        : FTTPropertyTrack()
        , CurveVector(nullptr)
    {}
    
};
 
USTRUCT()
struct FTTLinearColorTrack : public FTTPropertyTrack
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    TObjectPtr<class UCurveLinearColor> CurveLinearColor;
 
    ENGINE_API bool operator == (const FTTLinearColorTrack& T2) const;
 
    FTTLinearColorTrack()
        : FTTPropertyTrack()
        , CurveLinearColor(nullptr)
    {}
    
};
 
UCLASS(MinimalAPI)
class UTimelineTemplate : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=TimelineTemplate)
    float TimelineLength;
 
    UPROPERTY(EditAnywhere, Category=TimelineTemplate)
    TEnumAsByte<ETimelineLengthMode> LengthMode;
 
    UPROPERTY(EditAnywhere, Category=TimelineTemplate)
    uint8 bAutoPlay:1;
 
    UPROPERTY(EditAnywhere, Category=TimelineTemplate)
    uint8 bLoop:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=TimelineTemplate)
    uint8 bReplicated:1;
 
    UPROPERTY(EditAnywhere, Category = TimelineTemplate)
    uint8 bIgnoreTimeDilation : 1;
 
    UPROPERTY()
    TArray<FTTEventTrack> EventTracks;
 
    UPROPERTY()
    TArray<FTTFloatTrack> FloatTracks;
 
    UPROPERTY()
    TArray<FTTVectorTrack> VectorTracks;
 
    UPROPERTY()
    TArray<FTTLinearColorTrack> LinearColorTracks;
 
    UPROPERTY(EditAnywhere, Category=BPVariableDescription)
    TArray<FBPVariableMetaDataEntry> MetaDataArray;
 
    UPROPERTY(duplicatetransient)
    FGuid   TimelineGuid;
 
    UPROPERTY()
    TEnumAsByte<ETickingGroup> TimelineTickGroup;
 
    int32 FindFloatTrackIndex(FName FloatTrackName) const;
    
    int32 FindVectorTrackIndex(FName VectorTrackName) const;
    
    int32 FindEventTrackIndex(FName EventTrackName) const;
 
    int32 FindLinearColorTrackIndex(FName ColorTrackName) const;
 
    ENGINE_API bool IsNewTrackNameValid(FName NewTrackName) const;
    
    FName GetUpdateFunctionName() const { return UpdateFunctionName; }
 
    FName GetFinishedFunctionName() const { return FinishedFunctionName; }
 
    ENGINE_API void SetMetaData(FName Key, FString Value);
 
    ENGINE_API const FString& GetMetaData(FName Key) const;
 
    ENGINE_API void RemoveMetaData(FName Key);
 
    ENGINE_API int32 FindMetaDataEntryIndexForKey(FName Key) const;
 
    FName GetVariableName() const { return VariableName; }
 
    FName GetDirectionPropertyName() const { return DirectionPropertyName; }
 
    /* Create a new unique name for a curve */
    ENGINE_API static FString MakeUniqueCurveName(UObject* Obj, UObject* InOuter);
 
    ENGINE_API static FString TimelineVariableNameToTemplateName(FName Name);
 
    ENGINE_API void GetAllCurves(TSet<class UCurveBase*>& InOutCurves) const;
 
    ENGINE_API FTTTrackId GetDisplayTrackId(int32 DisplayTrackIndex);
    ENGINE_API int32 GetNumDisplayTracks() const;
    ENGINE_API void RemoveDisplayTrack(int32 DisplayTrackIndex);
    ENGINE_API void MoveDisplayTrack(int32 DisplayTrackIndex, int32 DirectionDelta);
    ENGINE_API void AddDisplayTrack(FTTTrackId NewTrackId);
 
 
    //~ Begin UObject Interface
    virtual void PostDuplicate(bool bDuplicateForPIE) override;
    virtual void PostEditImport() override;
    virtual void PostLoad() override;
    virtual bool Rename(const TCHAR* InName, UObject* NewOuter, ERenameFlags Flags) override;
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostInitProperties() override;
    //~ End UObject Interface
 
private:
    ENGINE_API void UpdateCachedNames();
 
    friend struct FUpdateTimelineCachedNames;
 
    UPROPERTY()
    FName VariableName;
 
    UPROPERTY()
    FName DirectionPropertyName;
 
    UPROPERTY()
    FName UpdateFunctionName;
 
    UPROPERTY()
    FName FinishedFunctionName;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TArray <FTTTrackId> TrackDisplayOrder;
#endif
 
 
public:
    static const FString TemplatePostfix;
};
 
struct FUpdateTimelineCachedNames
{
private:
    static void Execute(UTimelineTemplate* TimelineTemplate)
    {
        TimelineTemplate->UpdateCachedNames();
    }
 
    friend struct FBlueprintCompilationManagerImpl;
    friend struct FRigVMBlueprintCompilationManagerImpl;
 
    friend class FBlueprintEditorUtils;
};