MovieSceneBlendType.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Misc/AssertionMacros.h"
#include "Stats/Stats.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
 
#include "MovieSceneBlendType.generated.h"
 
struct FMovieSceneBlendTypeFieldIterator;
 
UENUM(BlueprintType)
enum class EMovieSceneBlendType : uint8
{
    Invalid UMETA(Hidden),
    Absolute            = 0x1,
    Additive            = 0x2,
    Relative            = 0x4,
    AdditiveFromBase    = 0x8,
    Override            = 0x10,
 
    // If you add new blend types, don't forget to change:
    // - All()
    // - Num()
};
 
USTRUCT(BlueprintType)
struct FOptionalMovieSceneBlendType
{
    GENERATED_BODY()
 
    FOptionalMovieSceneBlendType()
        : BlendType(EMovieSceneBlendType::Absolute)
        , bIsValid(false)
    {}
 
    explicit FOptionalMovieSceneBlendType(EMovieSceneBlendType InBlendType)
        : BlendType(InBlendType)
        , bIsValid(true)
    {}
 
    FOptionalMovieSceneBlendType& operator=(EMovieSceneBlendType InBlendType)
    {
        bIsValid = true;
        BlendType = InBlendType;
        return *this;
    }
 
    bool IsValid() const
    {
        return bIsValid;
    }
 
    EMovieSceneBlendType Get() const
    {
        check(bIsValid);
        return BlendType;
    }
 
    friend bool operator==(FOptionalMovieSceneBlendType A, EMovieSceneBlendType B)
    {
        return A.IsValid() && A.BlendType == B;
    }
 
    UPROPERTY(BlueprintReadOnly, Category="Blend Type")
    EMovieSceneBlendType BlendType;
 
    UPROPERTY(BlueprintReadOnly, Category="Blend Type")
    bool bIsValid;
};
 
struct FMovieSceneBlendTypeField
{
    MOVIESCENE_API FMovieSceneBlendTypeField();
 
    MOVIESCENE_API static FMovieSceneBlendTypeField All();
 
    MOVIESCENE_API static FMovieSceneBlendTypeField None();
 
    template<typename... E> void Add(E... Types)    { for (EMovieSceneBlendType BlendType : {Types...}) { Add(BlendType); }             }
    template<typename... E> void Remove(E... Types) { for (EMovieSceneBlendType BlendType : {Types...}) { Remove(BlendType); }          }
 
    MOVIESCENE_API void Add(EMovieSceneBlendType Type);
    MOVIESCENE_API void Add(FMovieSceneBlendTypeField Field);
 
    MOVIESCENE_API void Remove(EMovieSceneBlendType Type);
    MOVIESCENE_API void Remove(FMovieSceneBlendTypeField Field);
 
    MOVIESCENE_API FMovieSceneBlendTypeField Invert() const;
 
    MOVIESCENE_API bool Contains(EMovieSceneBlendType InBlendType) const;
 
    MOVIESCENE_API int32 Num() const;
 
    friend bool operator==(const FMovieSceneBlendTypeField& A, const FMovieSceneBlendTypeField& B)
    {
        return A.BlendTypeField == B.BlendTypeField;
    }
 
    friend bool operator!=(const FMovieSceneBlendTypeField& A, const FMovieSceneBlendTypeField& B)
    {
        return A.BlendTypeField != B.BlendTypeField;
    }
 
    friend MOVIESCENE_API FMovieSceneBlendTypeFieldIterator begin(const FMovieSceneBlendTypeField& Field);
    friend MOVIESCENE_API FMovieSceneBlendTypeFieldIterator end(const FMovieSceneBlendTypeField& Field);
 
private:
    explicit FMovieSceneBlendTypeField(EMovieSceneBlendType InBlendTypeField) : BlendTypeField(InBlendTypeField) {}
 
    EMovieSceneBlendType BlendTypeField;
};
 
struct FMovieSceneBlendTypeFieldIterator
{
public:
    static FMovieSceneBlendTypeFieldIterator Begin(FMovieSceneBlendTypeField InField);
    static FMovieSceneBlendTypeFieldIterator End(FMovieSceneBlendTypeField InField);
 
    inline explicit operator bool() const   { return Offset >= 0 && Offset <= MaxValidOffset(); }
    inline bool operator!() const           { return Offset < 0 || Offset > MaxValidOffset(); }
    inline void operator++()                { IterateToNext(); }
    inline bool operator==(const FMovieSceneBlendTypeFieldIterator& RHS) const { return Field == RHS.Field && Offset == RHS.Offset; }
    inline bool operator!=(const FMovieSceneBlendTypeFieldIterator& RHS) const { return Field != RHS.Field || Offset != RHS.Offset; }
 
    MOVIESCENE_API EMovieSceneBlendType operator*();
 
private:
    friend MOVIESCENE_API FMovieSceneBlendTypeFieldIterator begin(const FMovieSceneBlendTypeField&);
    friend MOVIESCENE_API FMovieSceneBlendTypeFieldIterator end(const FMovieSceneBlendTypeField&);
 
    MOVIESCENE_API void IterateToNext();
 
    inline static int8 MaxValidOffset() { return (int8)(StaticEnum<EMovieSceneBlendType>()->NumEnums() - 2); }
 
    FMovieSceneBlendTypeField Field;
    int8 Offset;
};