AnimCurveMetadata.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/BoneReference.h"
#include "Engine/AssetUserData.h"
#include "UObject/AnimPhysObjectVersion.h"
#include "UObject/Interface.h"
#include "AnimCurveMetadata.generated.h"
 
USTRUCT()
struct FAnimCurveType
{
    GENERATED_BODY()
 
    UPROPERTY()
    bool bMaterial;
 
    UPROPERTY()
    bool bMorphtarget;
 
    FAnimCurveType(bool bInMorphtarget = false, bool bInMaterial = false)
        : bMaterial(bInMaterial)
        , bMorphtarget(bInMorphtarget)
    {
    }
};
 
USTRUCT()
struct FCurveMetaData
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    TArray<FBoneReference> LinkedBones;
    
    /* max LOD (lowest LOD) to evaluate this. -1 means it will evaluate all the time. */
    UPROPERTY()
    uint8 MaxLOD;
 
    UPROPERTY()
    FAnimCurveType Type;
 
    friend FArchive& operator<<(FArchive& Ar, FCurveMetaData& B);
 
    ENGINE_API bool Serialize(FArchive& Ar);
 
    ENGINE_API FCurveMetaData();
};
 
UINTERFACE()
class UInterface_AnimCurveMetaData : public UInterface
{
    GENERATED_BODY()
};
 
class IInterface_AnimCurveMetaData
{
    GENERATED_BODY()
 
public:
    virtual void ForEachCurveMetaData(const TFunctionRef<void(FName, const FCurveMetaData&)>& InFunction) const = 0;
 
    virtual int32 GetNumCurveMetaData() const = 0;
 
    virtual const FCurveMetaData* GetCurveMetaData(FName InCurveName) const = 0;
 
    virtual bool AddCurveMetaData(FName InCurveName, bool bInTransact = true) = 0;
 
    virtual FCurveMetaData* GetCurveMetaData(FName InCurveName) = 0;
 
    virtual void GetCurveMetaDataNames(TArray<FName>& OutNames) const = 0;
 
    virtual void RefreshBoneIndices(USkeleton* InSkeleton) {}
 
    virtual uint16 GetVersionNumber() const = 0;
 
#if WITH_EDITOR
    virtual bool RenameCurveMetaData(FName OldName, FName NewName) = 0;
 
    virtual bool RemoveCurveMetaData(FName CurveName) = 0;
 
    virtual bool RemoveCurveMetaData(TArrayView<FName> CurveNames) = 0;
 
    virtual FDelegateHandle RegisterOnCurveMetaDataChanged(const FSimpleMulticastDelegate::FDelegate& InOnCurveMetaDataChanged) = 0;
 
    virtual bool GetCurveMetaDataMaterial(FName CurveName) const = 0;
 
    virtual bool GetCurveMetaDataMorphTarget(FName CurveName) const = 0;
 
    virtual void SetCurveMetaDataMaterial(FName CurveName, bool bOverrideMaterial) = 0;
 
    virtual void SetCurveMetaDataMorphTarget(FName CurveName, bool bOverrideMorphTarget) = 0;
 
    virtual void SetCurveMetaDataBoneLinks(FName CurveName, const TArray<FBoneReference>& BoneLinks, uint8 InMaxLOD, USkeleton* InSkeleton) = 0;
    
    virtual void UnregisterOnCurveMetaDataChanged(FDelegateHandle InHandle) = 0;
 
#endif// WITH_EDITOR
};
 
 
UCLASS(MinimalAPI)
class UAnimCurveMetaData : public UAssetUserData, public IInterface_AnimCurveMetaData
{
    GENERATED_BODY()
 
    // Friend with skeleton for upgrade purposes
    friend class USkeleton;
 
public:
#if WITH_EDITOR
    // UObject interface
    virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
#endif
 
    // IInterface_AnimCurveMetaData interface
    virtual void ForEachCurveMetaData(const TFunctionRef<void(FName, const FCurveMetaData&)>& InFunction) const override;
    virtual int32 GetNumCurveMetaData() const override { return CurveMetaData.Num(); }
    virtual const FCurveMetaData* GetCurveMetaData(FName InCurveName) const override;
    virtual FCurveMetaData* GetCurveMetaData(FName InCurveName) override;
    virtual bool AddCurveMetaData(FName InCurveName, bool bInTransact = true) override;
    virtual void GetCurveMetaDataNames(TArray<FName>& OutNames) const override;
    virtual void RefreshBoneIndices(USkeleton* InSkeleton) override;
    virtual uint16 GetVersionNumber() const override; 
#if WITH_EDITOR
    virtual bool RenameCurveMetaData(FName OldName, FName NewName) override;
    virtual bool RemoveCurveMetaData(FName CurveName) override;
    virtual bool RemoveCurveMetaData(TArrayView<FName> CurveNames) override;
    virtual bool GetCurveMetaDataMaterial(FName CurveName) const override;
    virtual bool GetCurveMetaDataMorphTarget(FName CurveName) const override;
    virtual void SetCurveMetaDataMaterial(FName CurveName, bool bOverrideMaterial) override;
    virtual void SetCurveMetaDataMorphTarget(FName CurveName, bool bOverrideMorphTarget) override;
    virtual void SetCurveMetaDataBoneLinks(FName CurveName, const TArray<FBoneReference>& BoneLinks, uint8 InMaxLOD, USkeleton* InSkeleton) override;
    virtual FDelegateHandle RegisterOnCurveMetaDataChanged(const FSimpleMulticastDelegate::FDelegate& InOnCurveMetaDataChanged) override;
    virtual void UnregisterOnCurveMetaDataChanged(FDelegateHandle InHandle) override;
#endif
private:
    void IncreaseVersionNumber();
 
private:
    UPROPERTY()
    TMap<FName, FCurveMetaData> CurveMetaData;
 
    FSimpleMulticastDelegate OnCurveMetaDataChanged;
 
    uint16 VersionNumber = 0;
};