LevelSequenceAnimSequenceLink.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Containers/Array.h"
#include "Engine/AssetUserData.h"
#include "Misc/Guid.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/UObjectGlobals.h"
#include "Animation/AnimTypes.h"
#include "Curves/RealCurve.h"
#include "LevelSequenceAnimSequenceLink.generated.h"
 
class UAnimSequence;
class UObject;
 
USTRUCT(BlueprintType)
struct FLevelSequenceAnimSequenceLinkItem
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintReadWrite, Category = Property)
    FGuid SkelTrackGuid;
 
    UPROPERTY(BlueprintReadWrite, Category = Property)
    FSoftObjectPath PathToAnimSequence;
 
    //From Editor Only UAnimSeqExportOption we cache this since we can re-import dynamically
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bExportTransforms = true;
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bExportMorphTargets = true;
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bExportAttributeCurves = true;
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bExportMaterialCurves = true;
    UPROPERTY(BlueprintReadWrite, Category = Property);
    EAnimInterpolationType Interpolation = EAnimInterpolationType::Linear;
    UPROPERTY(BlueprintReadWrite, Category = Property);
    TEnumAsByte<ERichCurveInterpMode> CurveInterpolation = ERichCurveInterpMode::RCIM_Linear;   
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bRecordInWorldSpace = false;
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bEvaluateAllSkeletalMeshComponents = true;
    
    UPROPERTY(BlueprintReadWrite, Category = Property);
    TArray<FString> IncludeAnimationNames;
    UPROPERTY(BlueprintReadWrite, Category = Property);
    TArray<FString> ExcludeAnimationNames;
    UPROPERTY(BlueprintReadWrite, Category = Property);
    FFrameNumber WarmUpFrames = 0;
    UPROPERTY(BlueprintReadWrite, AdvancedDisplay, Category = Property);
    FFrameNumber DelayBeforeStart = 0;
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bUseCustomTimeRange = false;
    UPROPERTY(BlueprintReadWrite, meta = (EditCondition = bUseCustomTimeRange), Category = Property)
    FFrameNumber CustomStartFrame = 0;
    UPROPERTY(BlueprintReadWrite, meta = (EditCondition = bUseCustomTimeRange), Category = Property)
    FFrameNumber CustomEndFrame = 120;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (EditCondition = bUseCustomTimeRange), Category = Property)
    FFrameRate CustomDisplayRate = FFrameRate(30, 1);
 
    UPROPERTY(BlueprintReadWrite, Category = Property)
    bool bUseCustomFrameRate = false;
 
    UPROPERTY(BlueprintReadWrite, meta = (EditCondition = bUseCustomFrameRate), Category = Property)
    FFrameRate CustomFrameRate = FFrameRate(30, 1);
 
    LEVELSEQUENCE_API void SetAnimSequence(UAnimSequence* InAnimSequence);
    LEVELSEQUENCE_API UAnimSequence* ResolveAnimSequence();
 
    bool IsEqual(FGuid InSkelTrackGuid, bool bInUseCustomTimeRange = false,
        FFrameNumber InCustomStartFrame = 0, FFrameNumber InCustomEndFrame = 120, FFrameRate InCustomDisplayRate = FFrameRate(30,1),
        bool bInUseCustomFrameRate = false, FFrameRate InCustomFrameRate = FFrameRate(30, 1)
        )
    {
        if (InSkelTrackGuid == SkelTrackGuid)
        {
            if (bUseCustomTimeRange == bInUseCustomTimeRange)
            {
                if (bUseCustomTimeRange == false || (InCustomStartFrame == CustomStartFrame &&
                    InCustomEndFrame == CustomEndFrame && InCustomDisplayRate == CustomDisplayRate))
                {
                    if (bUseCustomFrameRate == bInUseCustomFrameRate)
                    {
                        if (bUseCustomFrameRate == false || (InCustomFrameRate == CustomFrameRate))
                        {
                            return true;
                        }
                    }
                }
            }
        }
        return false;
    }
};
 
UCLASS(BlueprintType, MinimalAPI)
class ULevelSequenceAnimSequenceLink : public UAssetUserData
{
    GENERATED_UCLASS_BODY()
 
public:
    virtual bool IsEditorOnly() const override { return true; }
 
    UPROPERTY(BlueprintReadWrite, Category = Links)
    TArray< FLevelSequenceAnimSequenceLinkItem> AnimSequenceLinks;
};