CustomAttributes.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "UObject/NameTypes.h"
#include "Misc/Variant.h"
#include "Animation/AnimTypes.h"
#include "BoneIndices.h"
#include "Templates/Tuple.h"
#include "Curves/StringCurve.h"
#include "Curves/IntegralCurve.h"
#include "Curves/SimpleCurve.h"
 
#include "CustomAttributes.generated.h"
 
UENUM(Experimental)
enum class ECustomAttributeBlendType : uint8
{
    Override,
    Blend
};
 
USTRUCT()
struct FCustomAttributeSetting
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = CustomAttributeSetting)
    FString Name;
 
    UPROPERTY(EditAnywhere, Category = CustomAttributeSetting)
    FString Meaning;
};
 
USTRUCT()
struct FTimecodeCustomAttributeNameSettings
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName HourAttributeName;
 
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName MinuteAttributeName;
 
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName SecondAttributeName;
 
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName FrameAttributeName;
 
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName SubframeAttributeName;
 
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName RateAttributeName;
 
    UPROPERTY(EditAnywhere, Category = TimecodeCustomAttributeNameSettings)
    FName TakenameAttributeName;
};
 
struct UE_DEPRECATED(5.0, "FCustomAttribute has been deprecated") FCustomAttribute;
USTRUCT(Experimental)
struct FCustomAttribute
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Category = CustomAttribute)
    FName Name;
 
    UPROPERTY(VisibleAnywhere, Category = CustomAttribute)
    int32 VariantType = 0;
 
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    TArray<float> Times;
        
    TArray<FVariant> Values;
 
    bool Serialize(FArchive& Ar)
    {
        Ar << Name;
        Ar << VariantType;
        Ar << Times;
        Ar << Values;
 
        return true;
    }
#endif // WITH_EDITORONLY_DATA
};
 
#if WITH_EDITORONLY_DATA
PRAGMA_DISABLE_DEPRECATION_WARNINGS
// Custom serializer required for FVariant array
template<>
struct TStructOpsTypeTraits<FCustomAttribute> : public TStructOpsTypeTraitsBase2<FCustomAttribute>
{
    enum
    {
        WithSerializer = true
    };
};
PRAGMA_ENABLE_DEPRECATION_WARNINGS
#endif // WITH_EDITORONLY_DATA
 
struct UE_DEPRECATED(5.0, "FCustomAttributePerBoneData has been deprecated") FCustomAttributePerBoneData;
 
USTRUCT(Experimental)
struct FCustomAttributePerBoneData
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    int32 BoneTreeIndex = 0;
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UPROPERTY(VisibleAnywhere, EditFixedSize, Category = CustomAttributeBoneData)
    TArray<FCustomAttribute> Attributes;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
#endif // WITH_EDITORONLY_DATA
};
 
struct UE_DEPRECATED(5.0, "FBakedStringCustomAttribute has been deprecated") FBakedStringCustomAttribute;
 
USTRUCT(Experimental)
struct FBakedStringCustomAttribute
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    FName AttributeName;
 
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    FStringCurve StringCurve;
#endif // WITH_EDITORONLY_DATA
};
 
struct UE_DEPRECATED(5.0, "FBakedIntegerCustomAttribute has been deprecated") FBakedIntegerCustomAttribute;
 
USTRUCT(Experimental)
struct FBakedIntegerCustomAttribute
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    FName AttributeName;
 
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    FIntegralCurve IntCurve;
#endif // WITH_EDITORONLY_DATA
};
 
struct UE_DEPRECATED(5.0, "FBakedFloatCustomAttribute has been deprecated") FBakedFloatCustomAttribute;
 
USTRUCT(Experimental)
struct FBakedFloatCustomAttribute
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    FName AttributeName;
 
    UPROPERTY(VisibleAnywhere, Category = CustomAttributeBoneData)
    FSimpleCurve FloatCurve;
#endif // WITH_EDITORONLY_DATA
};
 
struct UE_DEPRECATED(5.0, "FBakedCustomAttributePerBoneData has been deprecated") FBakedCustomAttributePerBoneData;
 
USTRUCT(Experimental)
struct FBakedCustomAttributePerBoneData
{
    GENERATED_BODY()
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    int32 BoneTreeIndex = 0;
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UPROPERTY(VisibleAnywhere, EditFixedSize, Category = CustomAttributeBoneData)
    TArray<FBakedStringCustomAttribute> StringAttributes;
 
    UPROPERTY(VisibleAnywhere, EditFixedSize, Category = CustomAttributeBoneData)
    TArray<FBakedIntegerCustomAttribute> IntAttributes;
 
    UPROPERTY(VisibleAnywhere, EditFixedSize, Category = CustomAttributeBoneData)
    TArray<FBakedFloatCustomAttribute> FloatAttributes;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
#endif // WITH_EDITORONLY_DATA
};