AnimDataNotifications.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/FrameRate.h"
 
#include "Animation/SmartName.h"
#include "Animation/AnimCurveTypes.h"
#include "Animation/AnimData/CurveIdentifier.h"
#include "Animation/AnimData/AttributeIdentifier.h"
 
#include "AnimDataNotifications.generated.h"
 
class IAnimationDataModel;
 
UENUM(BlueprintType)
enum class EAnimDataModelNotifyType : uint8
{
    BracketOpened,
 
    BracketClosed,
 
    TrackAdded, 
 
    TrackChanged,
 
    TrackRemoved,   
 
    SequenceLengthChanged,
 
    FrameRateChanged,
 
    CurveAdded,
 
    CurveChanged,
 
    CurveRemoved,
 
    CurveFlagsChanged,
 
    CurveRenamed,
 
    CurveScaled,
 
    CurveColorChanged,
 
    CurveCommentChanged,
 
    AttributeAdded,
    
    AttributeRemoved,
 
    AttributeChanged,
    
    Populated,
 
    Reset,
 
    SkeletonChanged,
 
    Invalid // The max for this enum (used for guarding)
};
 
USTRUCT(BlueprintType)
struct FEmptyPayload
{
    GENERATED_BODY()
};
 
USTRUCT(BlueprintType)
struct FBracketPayload : public FEmptyPayload
{
    GENERATED_BODY()
    
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FString Description;
};
 
USTRUCT(BlueprintType)
struct FAnimationTrackPayload : public FEmptyPayload
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FName Name;
};
 
typedef FAnimationTrackPayload FAnimationTrackRemovedPayload;
typedef FAnimationTrackPayload FAnimationTrackChangedPayload;
 
USTRUCT(BlueprintType)
struct FAnimationTrackAddedPayload : public FAnimationTrackPayload
{
    GENERATED_BODY()
    
    
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FAnimationTrackAddedPayload() = default;
    FAnimationTrackAddedPayload(const FAnimationTrackAddedPayload&) = default;
    FAnimationTrackAddedPayload(FAnimationTrackAddedPayload&&) = default;
    FAnimationTrackAddedPayload& operator=(const FAnimationTrackAddedPayload&) = default;
    FAnimationTrackAddedPayload& operator=(FAnimationTrackAddedPayload&&) = default;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UE_DEPRECATED(5.2, "FAnimationTrackAddedPayload::TrackIndex has been deprecated")
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    int32 TrackIndex = INDEX_NONE;
};
 
USTRUCT(BlueprintType)
struct FSequenceLengthChangedPayload : public FEmptyPayload
{
    GENERATED_BODY()
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FSequenceLengthChangedPayload() = default;
    FSequenceLengthChangedPayload(const FSequenceLengthChangedPayload&) = default;
    FSequenceLengthChangedPayload(FSequenceLengthChangedPayload&&) = default;
    FSequenceLengthChangedPayload& operator=(const FSequenceLengthChangedPayload&) = default;
    FSequenceLengthChangedPayload& operator=(FSequenceLengthChangedPayload&&) = default;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UE_DEPRECATED(5.0, "Time in seconds is deprecated use FFrameNumber members (PreviousNumberOfFrames) instead")
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    float PreviousLength = 0.f;
 
    UE_DEPRECATED(5.0, "Time in seconds is deprecated use FFrameNumber members (Frame0) instead")
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    float T0 = 0.f;
 
    UE_DEPRECATED(5.0, "Time in seconds is deprecated use FFrameNumber members (Frame1) instead")
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    float T1 = 0.f;
 
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FFrameNumber PreviousNumberOfFrames;
 
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FFrameNumber Frame0;
 
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FFrameNumber Frame1;
};
 
USTRUCT(BlueprintType)
struct FFrameRateChangedPayload : public FEmptyPayload
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FFrameRate PreviousFrameRate;
};
 
USTRUCT(BlueprintType)
struct FCurvePayload : public FEmptyPayload
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FAnimationCurveIdentifier Identifier;
};
 
typedef FCurvePayload FCurveAddedPayload;
typedef FCurvePayload FCurveRemovedPayload;
typedef FCurvePayload FCurveChangedPayload;
 
USTRUCT(BlueprintType)
struct FCurveScaledPayload : public FCurvePayload
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    float Factor = 0.f;
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    float Origin = 0.f;
};
 
USTRUCT(BlueprintType)
struct FCurveRenamedPayload : public FCurvePayload
{
    GENERATED_BODY()
    
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FAnimationCurveIdentifier NewIdentifier;
};
 
USTRUCT(BlueprintType)
struct FCurveFlagsChangedPayload : public FCurvePayload
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    int32 OldFlags = 0;
};
 
USTRUCT(BlueprintType)
struct FAttributePayload : public FEmptyPayload
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadOnly, Category = Payload)
    FAnimationAttributeIdentifier Identifier;
};
 
typedef FAttributePayload FAttributeAddedPayload;
typedef FAttributePayload FAttributeRemovedPayload;
typedef FAttributePayload FAttributeChangedPayload;
 
USTRUCT(BlueprintType)
struct FAnimDataModelNotifPayload
{
    GENERATED_BODY()
        
    FAnimDataModelNotifPayload() : Data(nullptr), Struct(nullptr) {}
    FAnimDataModelNotifPayload(const int8* InData, UScriptStruct* InStruct) : Data(InData), Struct(InStruct) {}
 
    template<typename PayloadType>
    const PayloadType& GetPayload() const
    {
        const UScriptStruct* ScriptStruct = PayloadType::StaticStruct();
        ensure(ScriptStruct == Struct || Struct->IsChildOf(ScriptStruct));
        return *((const PayloadType*)Data);
    }
 
    const int8* GetData() const { return Data; };
    UScriptStruct* GetStruct() const { return Struct; };
protected:
    const int8* Data;
    
    UScriptStruct* Struct;
};
 
UCLASS(MinimalAPI)
class UAnimationDataModelNotifiesExtensions : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
public:
#if WITH_EDITOR
    UFUNCTION(BlueprintCallable, Category = AnimationAsset, meta = (ScriptMethod))
    static void CopyPayload(UPARAM(ref)const FAnimDataModelNotifPayload& Payload, UScriptStruct* ExpectedStruct, UPARAM(ref)FEmptyPayload& OutPayload)
    {
        if (Payload.GetStruct() == ExpectedStruct)
        {
            ExpectedStruct->CopyScriptStruct(&OutPayload, Payload.GetData());
        }
    }
 
    UFUNCTION(BlueprintCallable, Category = AnimationAsset, meta = (ScriptMethod))
    static const FEmptyPayload& GetPayload(UPARAM(ref)const FAnimDataModelNotifPayload& Payload)
    {
        return *((const FEmptyPayload*)Payload.GetData());
    }
#endif // WITH_EDITOR
};
 
DECLARE_MULTICAST_DELEGATE_ThreeParams(FAnimDataModelModifiedEvent, const EAnimDataModelNotifyType& /* type */, IAnimationDataModel* /* Model */, const FAnimDataModelNotifPayload& /* payload */);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FAnimDataModelModifiedDynamicEvent, EAnimDataModelNotifyType, NotifType, TScriptInterface<IAnimationDataModel>, Model, const FAnimDataModelNotifPayload&, Payload);