CurveIdentifier.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UObject/ObjectMacros.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Animation/SmartName.h"
#include "Animation/AnimCurveTypes.h"
 
#include "CurveIdentifier.generated.h"
 
UENUM(BlueprintType)
enum class ETransformCurveChannel : uint8
{
    Position,
    Rotation,
    Scale,
    Invalid
};
 
UENUM(BlueprintType)
enum class EVectorCurveChannel : uint8
{
    X,
    Y,
    Z,
    Invalid
};
 
USTRUCT(BlueprintType)
struct FAnimationCurveIdentifier
{
    GENERATED_BODY();
 
    FAnimationCurveIdentifier() = default;
 
    UE_DEPRECATED(5.3, "Please use the constructor that takes an FName")
    FAnimationCurveIdentifier(const FSmartName& InSmartName, ERawCurveTrackTypes InCurveType)
        : CurveName(InSmartName.DisplayName)
        , CurveType(InCurveType)
        , Channel(ETransformCurveChannel::Invalid)
        , Axis(EVectorCurveChannel::Invalid)
    {}
 
    UE_DEPRECATED(5.3, "Please use the constructor that takes an FName")
    explicit FAnimationCurveIdentifier(const SmartName::UID_Type& InUID, ERawCurveTrackTypes InCurveType)
        : CurveType(InCurveType)
    {
    }
 
    FAnimationCurveIdentifier(const FName& InName, ERawCurveTrackTypes InCurveType)
        : CurveName(InName)
        , CurveType(InCurveType)
    {
    }
    
    bool operator==(const FAnimationCurveIdentifier& Other) const
    {
        return (CurveName == Other.CurveName && CurveType == Other.CurveType 
            && Channel == Other.Channel && Axis == Other.Axis);
    }
 
    bool operator!=(const FAnimationCurveIdentifier& Other) const
    {
        return !(*this == Other);
    }
 
    bool IsValid() const
    {
        return CurveName != NAME_None && CurveType != ERawCurveTrackTypes::RCT_MAX;
    }
 
    friend uint32 GetTypeHash(const FAnimationCurveIdentifier& CurveId)
    {
        return HashCombine(HashCombine(HashCombine((uint32)CurveId.Channel, (uint32)CurveId.Axis), (uint32)CurveId.CurveType), GetTypeHash(CurveId.CurveName));
    }
    
    ENGINE_API void PostSerialize(const FArchive& Ar);
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FSmartName InternalName_DEPRECATED;
#endif
 
    UPROPERTY()
    FName CurveName = NAME_None;
 
    UPROPERTY()
    ERawCurveTrackTypes CurveType = ERawCurveTrackTypes::RCT_MAX;
 
    UPROPERTY()
    ETransformCurveChannel Channel = ETransformCurveChannel::Invalid;
    
    UPROPERTY()
    EVectorCurveChannel Axis = EVectorCurveChannel::Invalid;
};
 
template<>
struct TStructOpsTypeTraits<FAnimationCurveIdentifier> : public TStructOpsTypeTraitsBase2<FAnimationCurveIdentifier>
{
    enum
    {
        WithCopy = true,
        WithIdenticalViaEquality = true,
        WithPostSerialize = true,
    };
};
 
UCLASS(MinimalAPI)
class UAnimationCurveIdentifierExtensions : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
public:
    UFUNCTION(BlueprintPure, Category = Curve, meta = (ScriptMethod))
    static bool IsValid(UPARAM(ref) FAnimationCurveIdentifier& Identifier)
    {
        return Identifier.IsValid();
    }
 
    UFUNCTION(BlueprintPure, Category = Curve, meta = (ScriptMethod))
    static FName GetName(UPARAM(ref) FAnimationCurveIdentifier& Identifier)
    {
        return Identifier.CurveName;
    }
 
    UFUNCTION(BlueprintPure, Category = Curve, meta = (ScriptMethod))
    static ERawCurveTrackTypes GetType(UPARAM(ref) FAnimationCurveIdentifier& Identifier)
    {
        return Identifier.CurveType;
    }
 
#if WITH_EDITOR
    UFUNCTION(BlueprintCallable, Category = Curves, meta = (ScriptMethod))
    static ENGINE_API void SetCurveIdentifier(UPARAM(ref) FAnimationCurveIdentifier& InOutIdentifier, FName Name, ERawCurveTrackTypes CurveType);
 
    UFUNCTION(BlueprintCallable, Category = Curves, meta = (ScriptMethod, DeprecatedFunction, DeprecationMessage="Please use SetCurveIdentifier."))
    static ENGINE_API FAnimationCurveIdentifier GetCurveIdentifier(USkeleton* InSkeleton, FName Name, ERawCurveTrackTypes CurveType);
    
    UFUNCTION(BlueprintCallable, Category = Curves, meta = (ScriptMethod, DeprecatedFunction, DeprecationMessage="Curve identifiers are no longer retrievable globally from the skeleton, they are specified per-animation."))
    static ENGINE_API FAnimationCurveIdentifier FindCurveIdentifier(const USkeleton* InSkeleton, FName Name, ERawCurveTrackTypes CurveType);
 
    UFUNCTION(BlueprintCallable, Category = Curves, meta = (ScriptMethod, DeprecatedFunction, DeprecationMessage="Curve identifiers are no longer retrievable globally from the skeleton, they are specified per-animation."))
    static ENGINE_API TArray<FAnimationCurveIdentifier> GetCurveIdentifiers(USkeleton* InSkeleton, ERawCurveTrackTypes CurveType);
 
    UFUNCTION(BlueprintCallable, Category = Curves, meta = (ScriptMethod))
    static ENGINE_API bool GetTransformChildCurveIdentifier(UPARAM(ref) FAnimationCurveIdentifier& InOutIdentifier, ETransformCurveChannel Channel, EVectorCurveChannel Axis);
#endif // WITH_EDITOR
};