BlendProfile.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/Object.h"
#include "BoneContainer.h"
#include "AnimationRuntime.h"
#include "BlendProfile.generated.h"
 
#define UE_API ENGINE_API
 
struct FAlphaBlend;
struct FCompactPose;
struct FBlendedCurve;
struct FSlotEvaluationPose;
namespace UE { namespace Anim { struct FStackAttributeContainer; } }
 
UENUM()
enum class EBlendProfileMode : uint8
{
    // The bone's transition time is a factor based on the transition time. 
    // For example 0.5 means it takes half the time of the transition.
    // Values should be between 0 and 1. They will be clamped if they go out of this range.
    // A bone value of 0 means the bone will instantly transition into the target state.
    TimeFactor = 0,
 
    // The bone's transition weight is multiplied by this factor.
    // For example 2.0 means the bone's blend weight is twice as high as the transition's blend weight.
    // Values should typically be equal or greater than 1.0.
    // If you want certain bones to instantly transition into the target state
    // the Time Factor based method might be a better choice.
    WeightFactor,
 
    // Used for blend masks. Per bone alpha
    BlendMask UMETA(Hidden),
};
 
USTRUCT()
struct FBlendProfileBoneEntry
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, Category=BoneSettings)
    FBoneReference BoneReference;
 
    UPROPERTY(EditAnywhere, Category=BoneSettings)
    float BlendScale = 0.f;
};
 
class IBlendProfileInterface : public IInterpolationIndexProvider
{
public:
    virtual ~IBlendProfileInterface() = default;
 
    virtual float GetBoneBlendScale(int32 InBoneIdx) const = 0;
 
    virtual int32 GetNumBlendEntries() const = 0;
 
    virtual TObjectPtr<USkeleton> GetSkeleton() const = 0;
 
    virtual EBlendProfileMode GetMode() const = 0;
 
    void UpdateBoneWeights(FBlendSampleData& InOutCurrentData, const FAlphaBlend& BlendInfo, float BlendStartAlpha, float MainWeight, bool bInverse = false) const;
};
 
class UBlendProfile;
 
UINTERFACE(MinimalAPI, Blueprintable)
class UBlendProfileProviderInterface : public UInterface
{
    GENERATED_BODY()
};
 
class IBlendProfileProviderInterface
{
    GENERATED_BODY()
 
public:
    // Convert the custom internal data struct into a regular blend profile
    virtual void ConstructBlendProfile(const TObjectPtr<UBlendProfile> OutBlendProfile) const = 0;
};
 
USTRUCT()
struct FBlendProfileInterfaceWrapper
{
    GENERATED_BODY()
 
public:
    UE_API void UpdateCachedBlendProfile();
 
    const TObjectPtr<UBlendProfile> GetBlendProfile() const { return BlendProfile; }
 
    TObjectPtr<UObject> GetCustomProviderObject() const { return BlendProfileProvider.GetObject(); }
 
    UE_API void SetBlendProfileProvider(TObjectPtr<UObject> Provider, IBlendProfileProviderInterface* ProviderInterface, UObject* Outer);
 
    UE_API void SetSkeletonBlendProfile(TObjectPtr<UBlendProfile> InBlendProfile);
 
    bool UsesSkeletonBlendProfile() const { return BlendProfileProvider.GetObject() == nullptr; }
 
private:
    UPROPERTY()
    bool bIsSkeletonBlendProfile = true;
 
    // The object responsible for constructing the blend profile
    UPROPERTY()
    TScriptInterface<IBlendProfileProviderInterface> BlendProfileProvider;
 
    // The actual blend profile to use
    UPROPERTY()
    TObjectPtr<UBlendProfile> BlendProfile;
};
 
 
UCLASS(MinimalAPI, BlueprintType)
class UBlendProfile : public UObject, public IBlendProfileInterface
{
public:
 
    GENERATED_BODY()
 
    ENGINE_API UBlendProfile();
 
    int32 GetNumBlendEntries() const { return ProfileEntries.Num(); }
 
    ENGINE_API void SetBoneBlendScale(int32 InBoneIdx, float InScale, bool bRecurse = false, bool bCreate = false);
 
    ENGINE_API void SetBoneBlendScale(const FName& InBoneName, float InScale, bool bRecurse = false, bool bCreate = false);
 
    ENGINE_API void RemoveEntry(int32 InBoneIdx);
 
    ENGINE_API void RefreshBoneEntry(int32 InBoneIndex);
 
    ENGINE_API void RefreshBoneEntriesFromName();
 
    ENGINE_API void CleanupBoneEntries();
 
    TObjectPtr<USkeleton> GetSkeleton() const override { return OwningSkeleton; }
 
    ENGINE_API const FBlendProfileBoneEntry& GetEntry(const int32 InEntryIdx) const;
 
    ENGINE_API float GetBoneBlendScale(int32 InBoneIdx) const override;
 
    ENGINE_API float GetBoneBlendScale(const FName& InBoneName) const;
    
    UE_DEPRECATED(5.0, "Please use the overload that takes a skeleton bone index")
    ENGINE_API int32 GetEntryIndex(const int32 InBoneIdx) const;
 
    ENGINE_API int32 GetEntryIndex(const FSkeletonPoseBoneIndex InBoneIdx) const;
 
    ENGINE_API int32 GetEntryIndex(const FName& BoneName) const;
 
    ENGINE_API float GetEntryBlendScale(const int32 InEntryIdx) const;
 
    ENGINE_API void UpdateBoneWeights(FBlendSampleData& InOutCurrentData, const FAlphaBlend& BlendInfo, float BlendStartAlpha, float MainWeight, bool bInverse = false);
 
    static ENGINE_API float CalculateBoneWeight(float BoneFactor, EBlendProfileMode Mode, const FAlphaBlend& BlendInfo, float BlendStartAlpha, float MainWeight, bool bInverse = false);
 
    ENGINE_API void FillBoneScalesArray(TArray<float>& OutBoneBlendProfileFactors, const FBoneContainer& BoneContainer) const;
 
    UE_DEPRECATED(5.4, "Please use the FillSkeletonBoneDurationsArray that takes a target skeleton as parameter.")
    ENGINE_API void FillSkeletonBoneDurationsArray(TCustomBoneIndexArrayView<float, FSkeletonPoseBoneIndex> OutDurationPerBone, float Duration) const;
 
    ENGINE_API void FillSkeletonBoneDurationsArray(TCustomBoneIndexArrayView<float, FSkeletonPoseBoneIndex> OutDurationPerBone, float Duration, const USkeleton* TargetSkeleton) const;
 
    // IInterpolationIndexProvider
    ENGINE_API virtual int32 GetPerBoneInterpolationIndex(const FCompactPoseBoneIndex& InCompactPoseBoneIndex, const FBoneContainer& BoneContainer, const IInterpolationIndexProvider::FPerBoneInterpolationData* Data) const override;
    ENGINE_API virtual int32 GetPerBoneInterpolationIndex(const FSkeletonPoseBoneIndex InSkeletonBoneIndex, const USkeleton* TargetSkeleton, const IInterpolationIndexProvider::FPerBoneInterpolationData* Data) const override;
    // End IInterpolationIndexProvider
 
    // UObject
    virtual bool IsSafeForRootSet() const override {return false;}
    ENGINE_API virtual void PostLoad() override;
    // End UObject
 
    // Default value of entries. Default values are not saved
    virtual float GetDefaultBlendScale() const { return IsBlendMask() ? 0.0f : 1.0f; }
 
    bool IsBlendMask() const { return Mode == EBlendProfileMode::BlendMask;  }
 
    EBlendProfileMode GetMode() const { return Mode; }
 
    ENGINE_API void SetSkeleton(USkeleton* InSkeleton);
 
    // Empties the bone enties array
    void ClearEntries();
 
private:
    ENGINE_API void SetSingleBoneBlendScale(int32 InBoneIdx, float InScale, bool bCreate = false);
 
public:
    // The skeleton that owns this profile
    UPROPERTY()
    TObjectPtr<USkeleton> OwningSkeleton;
 
    // List of blend scale entries
    UPROPERTY()
    TArray<FBlendProfileBoneEntry> ProfileEntries;
 
    // Blend Profile Mode. Read EBlendProfileMode for more details
    UPROPERTY()
    EBlendProfileMode Mode;
};
 
#undef UE_API