MovieSceneBoolChannel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channels/MovieSceneChannelEditorData.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "CoreTypes.h"
#include "HAL/PlatformCrt.h"
#include "Math/Range.h"
#include "Misc/FrameNumber.h"
#include "Misc/FrameTime.h"
#include "Misc/Optional.h"
#include "MovieSceneChannel.h"
#include "MovieSceneChannelData.h"
#include "MovieSceneChannelTraits.h"
#include "Serialization/StructuredArchive.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
#include "Curves/RealCurve.h"
 
#include "MovieSceneBoolChannel.generated.h"
 
struct FFrameRate;
struct FKeyHandle;
struct FPropertyTag;
 
 
USTRUCT()
struct FMovieSceneBoolChannel : public FMovieSceneChannel
{
    GENERATED_BODY()
 
    typedef bool CurveValueType;
 
    FMovieSceneBoolChannel()
        : PreInfinityExtrap(RCCE_Constant), PostInfinityExtrap(RCCE_Constant), DefaultValue(false), bHasDefaultValue(false)
    {}
 
    MOVIESCENE_API bool SerializeFromMismatchedTag(const FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
 
    virtual inline TMovieSceneChannelData<bool> GetData()
    {
        return TMovieSceneChannelData<bool>(&Times, &Values, this, &KeyHandles);
    }
 
    virtual inline TMovieSceneChannelData<const bool> GetData() const
    {
        return TMovieSceneChannelData<const bool>(&Times, &Values);
    }
 
    inline TArrayView<const FFrameNumber> GetTimes() const
    {
        return Times;
    }
 
    inline TArrayView<const bool> GetValues() const
    {
        return Values;
    }
 
    inline bool HasAnyData() const
    {
        return Times.Num() != 0 || bHasDefaultValue == true;
    }
 
    MOVIESCENE_API virtual bool Evaluate(FFrameTime InTime, bool& OutValue) const;
 
    inline void AddKeys(const TArray<FFrameNumber>& InTimes, const TArray<bool>& InValues)
    {
        check(InTimes.Num() == InValues.Num());
        Times.Append(InTimes);
        Values.Append(InValues);
    }
 
public:
 
    // ~ FMovieSceneChannel Interface
    MOVIESCENE_API virtual void GetKeys(const TRange<FFrameNumber>& WithinRange, TArray<FFrameNumber>* OutKeyTimes, TArray<FKeyHandle>* OutKeyHandles) override;
    MOVIESCENE_API virtual void GetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<FFrameNumber> OutKeyTimes) override;
    MOVIESCENE_API virtual void SetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<const FFrameNumber> InKeyTimes) override;
    MOVIESCENE_API virtual void DuplicateKeys(TArrayView<const FKeyHandle> InHandles, TArrayView<FKeyHandle> OutNewHandles) override;
    MOVIESCENE_API virtual void DeleteKeys(TArrayView<const FKeyHandle> InHandles) override;
    MOVIESCENE_API virtual void DeleteKeysFrom(FFrameNumber InTime, bool bDeleteKeysBefore) override;
    MOVIESCENE_API virtual void RemapTimes(const UE::MovieScene::IRetimingInterface& Retimer) override;
    MOVIESCENE_API virtual TRange<FFrameNumber> ComputeEffectiveRange() const override;
    MOVIESCENE_API virtual int32 GetNumKeys() const override;
    MOVIESCENE_API virtual void Reset() override;
    MOVIESCENE_API virtual void Offset(FFrameNumber DeltaPosition) override;
    MOVIESCENE_API virtual void Optimize(const FKeyDataOptimizationParams& InParameters) override;
    MOVIESCENE_API virtual void ClearDefault() override;
    MOVIESCENE_API virtual FKeyHandle GetHandle(int32 Index) override;
    MOVIESCENE_API virtual int32 GetIndex(FKeyHandle Handle) override;
 
public:
 
    inline void SetDefault(bool InDefaultValue)
    {
        bHasDefaultValue = true;
        DefaultValue = InDefaultValue;
    }
 
    inline TOptional<bool> GetDefault() const
    {
        return bHasDefaultValue ? TOptional<bool>(DefaultValue) : TOptional<bool>();
    }
 
    inline void RemoveDefault()
    {
        bHasDefaultValue = false;
    }
public:
    UPROPERTY()
    TEnumAsByte<ERichCurveExtrapolation> PreInfinityExtrap;
 
    UPROPERTY()
    TEnumAsByte<ERichCurveExtrapolation> PostInfinityExtrap;
 
protected:
 
    UPROPERTY(meta=(KeyTimes))
    TArray<FFrameNumber> Times;
 
    UPROPERTY()
    bool DefaultValue;
 
    UPROPERTY()
    bool bHasDefaultValue;
 
    UPROPERTY(meta=(KeyValues))
    TArray<bool> Values;
 
    UPROPERTY(Transient)
    FMovieSceneKeyHandleMap KeyHandles;
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneBoolChannel> : public TStructOpsTypeTraitsBase2<FMovieSceneBoolChannel>
{
    enum { WithStructuredSerializeFromMismatchedTag = true };
};
 
template<>
struct TMovieSceneChannelTraits<FMovieSceneBoolChannel> : TMovieSceneChannelTraitsBase<FMovieSceneBoolChannel>
{
#if WITH_EDITORONLY_DATA
 
    typedef TMovieSceneExternalValue<bool> ExtendedEditorDataType;
 
#endif
};