MovieSceneSectionParameters.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 "Misc/EnumClassFlags.h"
#include "Variants/MovieSceneTimeWarpVariant.h"
#include "MovieSceneSectionParameters.generated.h"
 
UENUM(Flags, BlueprintType)
enum class EMovieSceneSubSectionFlags : uint8
{
    None = 0,
 
    /*~ Begin mutually exclusive */
    OverrideKeepState = 1 << 0,
    OverrideRestoreState = 1 << 1,
    /*~ End mutually exclusive */
 
    IgnoreHierarchicalBias = 1 << 2,
 
    BlendHierarchicalBias  = 1 << 3,
 
    AnyRestoreStateOverride = OverrideKeepState | OverrideRestoreState,
};
ENUM_CLASS_FLAGS(EMovieSceneSubSectionFlags)
 
namespace UE::MovieScene
{
    inline EMovieSceneSubSectionFlags AccumulateChildSubSectionFlags(EMovieSceneSubSectionFlags ParentFlags, EMovieSceneSubSectionFlags ChildFlags)
    {
        if (EnumHasAnyFlags(ParentFlags, EMovieSceneSubSectionFlags::AnyRestoreStateOverride))
        {
            // If the parent has any uninheritable flags based on the parent, ensure the child has the parent's flags
            return (ChildFlags & ~EMovieSceneSubSectionFlags::AnyRestoreStateOverride) | ParentFlags;
        }
        else
        {
            return ChildFlags | ParentFlags;
        }
    }
 
} // namespace UE::MovieScene
 
USTRUCT(BlueprintType)
struct FMovieSceneSectionParameters
{
    GENERATED_BODY()
 
    
    FMovieSceneSectionParameters()
        : StartFrameOffset(0)
        , EndFrameOffset(0)
        , FirstLoopStartFrameOffset(0)
        , TimeScale(1.0f)
        , HierarchicalBias(100)
        , Flags(EMovieSceneSubSectionFlags::None)
        , StartOffset_DEPRECATED(0.f)
        , PrerollTime_DEPRECATED(0.0f)
        , PostrollTime_DEPRECATED(0.0f)
    {}
 
public:
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Clipping", meta=(UIFrameDisplayAs=Duration))
    FFrameNumber StartFrameOffset;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Clipping")
    bool bCanLoop = false;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Clipping", meta=(EditCondition="bCanLoop", UIFrameDisplayAs=Duration))
    FFrameNumber EndFrameOffset;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Clipping", meta=(EditCondition="bCanLoop", UIFrameDisplayAs=Duration))
    FFrameNumber FirstLoopStartFrameOffset;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
    FMovieSceneTimeWarpVariant TimeScale;
 
    UPROPERTY(config, BlueprintReadWrite, EditAnywhere, Category="Sequence")
    int32 HierarchicalBias;
 
    UPROPERTY(config, BlueprintReadWrite, Category="Sequence")
    EMovieSceneSubSectionFlags Flags;
 
    UPROPERTY()
    float StartOffset_DEPRECATED;
    UPROPERTY()
    float PrerollTime_DEPRECATED;
    UPROPERTY()
    float PostrollTime_DEPRECATED;
};