MovieSceneEventSection.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/Class.h"
#include "Curves/KeyHandle.h"
#include "MovieSceneSection.h"
#include "Curves/NameCurve.h"
#include "UObject/StructOnScope.h"
#include "Engine/Engine.h"
#include "UObject/SoftObjectPath.h"
#include "Channels/MovieSceneChannel.h"
#include "Channels/MovieSceneChannelData.h"
#include "Channels/MovieSceneChannelTraits.h"
#include "MovieSceneEventSection.generated.h"
 
struct EventData;
 
USTRUCT(BlueprintType)
struct FMovieSceneEventParameters
{
    GENERATED_BODY()
 
    FMovieSceneEventParameters()
        : PackageFileVersion(GPackageFileUEVersion)
        , LicenseePackageFileVersion(GPackageFileLicenseeUEVersion )
    {}
 
    FMovieSceneEventParameters(UScriptStruct& InStruct)
        : StructType(&InStruct)
        , PackageFileVersion(GPackageFileUEVersion)
        , LicenseePackageFileVersion(GPackageFileLicenseeUEVersion )
    {
    }
 
    MOVIESCENETRACKS_API friend bool operator==(const FMovieSceneEventParameters& A, const FMovieSceneEventParameters& B);
 
    MOVIESCENETRACKS_API friend bool operator!=(const FMovieSceneEventParameters& A, const FMovieSceneEventParameters& B);
 
    UScriptStruct* GetStructType() const
    {
        return Cast<UScriptStruct>(StructType.TryLoad());
    }
 
    void Reassign(UScriptStruct* NewStruct)
    {
        StructType = NewStruct;
 
        if (!NewStruct)
        {
            StructBytes.Reset();
        }
    }
 
    MOVIESCENETRACKS_API void GetInstance(FStructOnScope& OutStruct) const;
 
    MOVIESCENETRACKS_API void OverwriteWith(uint8* InstancePtr);
 
    MOVIESCENETRACKS_API bool Serialize(FArchive& Ar);
 
    friend FArchive& operator<<(FArchive& Ar, FMovieSceneEventParameters& Payload)
    {
        Payload.Serialize(Ar);
        return Ar;
    }
 
private:
 
    FSoftObjectPath StructType;
 
    FPackageFileVersion PackageFileVersion;
    int32 LicenseePackageFileVersion;
 
    TArray<uint8> StructBytes;
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneEventParameters> : public TStructOpsTypeTraitsBase2<FMovieSceneEventParameters>
{
    enum 
    {
        WithCopy = true,
        WithSerializer = true
    };
};
 
USTRUCT(BlueprintType)
struct FEventPayload
{
    GENERATED_BODY()
 
    FEventPayload() {}
    FEventPayload(FName InEventName) : EventName(InEventName) {}
 
    friend bool operator==(const FEventPayload& A, const FEventPayload& B)
    {
        return A.EventName == B.EventName && A.Parameters == B.Parameters;
    }
 
    friend bool operator!=(const FEventPayload& A, const FEventPayload& B)
    {
        return A.EventName != B.EventName || A.Parameters != B.Parameters;
    }
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Event)
    FName EventName;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Event, meta=(ShowOnlyInnerProperties))
    FMovieSceneEventParameters Parameters;
};
 
USTRUCT()
struct FMovieSceneEventSectionData : public FMovieSceneChannel
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    MOVIESCENETRACKS_API void PostSerialize(const FArchive& Ar);
#endif
 
    inline TMovieSceneChannelData<FEventPayload> GetData()
    {
        return TMovieSceneChannelData<FEventPayload>(&Times, &KeyValues, this, &KeyHandles);
    }
 
    inline TMovieSceneChannelData<const FEventPayload> GetData() const
    {
        return TMovieSceneChannelData<const FEventPayload>(&Times, &KeyValues);
    }
 
    TArrayView<const FFrameNumber> GetKeyTimes() const
    {
        return Times;
    }
 
    TArrayView<const FEventPayload> GetKeyValues() const
    {
        return KeyValues;
    }
 
public:
 
    // ~ FMovieSceneChannel Interface
    MOVIESCENETRACKS_API virtual void GetKeys(const TRange<FFrameNumber>& WithinRange, TArray<FFrameNumber>* OutKeyTimes, TArray<FKeyHandle>* OutKeyHandles) override;
    MOVIESCENETRACKS_API virtual void GetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<FFrameNumber> OutKeyTimes) override;
    MOVIESCENETRACKS_API virtual void SetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<const FFrameNumber> InKeyTimes) override;
    MOVIESCENETRACKS_API virtual void DuplicateKeys(TArrayView<const FKeyHandle> InHandles, TArrayView<FKeyHandle> OutNewHandles) override;
    MOVIESCENETRACKS_API virtual void DeleteKeys(TArrayView<const FKeyHandle> InHandles) override;
    MOVIESCENETRACKS_API virtual void DeleteKeysFrom(FFrameNumber InTime, bool bDeleteKeysBefore) override;
    MOVIESCENETRACKS_API virtual void RemapTimes(const UE::MovieScene::IRetimingInterface& Retimer) override;
    MOVIESCENETRACKS_API virtual TRange<FFrameNumber> ComputeEffectiveRange() const override;
    MOVIESCENETRACKS_API virtual int32 GetNumKeys() const override;
    MOVIESCENETRACKS_API virtual void Reset() override;
    MOVIESCENETRACKS_API virtual void Offset(FFrameNumber DeltaPosition) override;
    MOVIESCENETRACKS_API virtual FKeyHandle GetHandle(int32 Index) override;
    MOVIESCENETRACKS_API virtual int32 GetIndex(FKeyHandle Handle) override;
    virtual void Optimize(const FKeyDataOptimizationParams& InParameters) override {}
    virtual void ClearDefault() override {}
 
private:
 
    UPROPERTY(meta=(KeyTimes))
    TArray<FFrameNumber> Times;
 
    UPROPERTY(meta=(KeyValues))
    TArray<FEventPayload> KeyValues;
 
    UPROPERTY(Transient)
    FMovieSceneKeyHandleMap KeyHandles;
 
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY()
    TArray<float> KeyTimes_DEPRECATED;
 
#endif
};
 
#if WITH_EDITORONLY_DATA
template<>
struct TStructOpsTypeTraits<FMovieSceneEventSectionData> : public TStructOpsTypeTraitsBase2<FMovieSceneEventSectionData>
{
    enum { WithPostSerialize = true };
};
#endif
 
UCLASS(MinimalAPI)
class UMovieSceneEventSection
    : public UMovieSceneSection
{
    GENERATED_BODY()
 
    
    UMovieSceneEventSection();
 
public:
    
    // ~UObject interface
    virtual void PostLoad() override;
 
    const FMovieSceneEventSectionData& GetEventData() const { return EventData; }
 
protected:
 
private:
 
    UPROPERTY()
    FNameCurve Events_DEPRECATED;
 
    UPROPERTY()
    FMovieSceneEventSectionData EventData;
};
 
template<>
struct TMovieSceneChannelTraits<FMovieSceneEventSectionData> : TMovieSceneChannelTraitsBase<FMovieSceneEventSectionData>
{
    enum { SupportsDefaults = false };
};
 
inline bool EvaluateChannel(const FMovieSceneEventSectionData* InChannel, FFrameTime InTime, FEventPayload& OutValue)
{
    // Can't evaluate event section data in the typical sense
    return false;
}
 
inline bool ValueExistsAtTime(const FMovieSceneEventSectionData* InChannel, FFrameNumber Time, const FEventPayload& Value)
{
    // true if any value exists
    return InChannel->GetData().FindKey(Time) != INDEX_NONE;
}