AttributesRuntime.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "Animation/AnimTypes.h"
#include "UObject/NameTypes.h"
#include "Containers/ContainersFwd.h"
 
#include "Containers/Map.h"
#include "CoreTypes.h"
#include "Misc/AssertionMacros.h"
#include "UObject/StructOnScope.h"
 
#include "Animation/IAttributeBlendOperator.h"
 
#include "UObject/Class.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
#include "Animation/AttributesContainer.h"
#include "Animation/WrappedAttribute.h"
 
struct FCompactPoseBoneIndex;
struct FBlendSampleData;
struct FBoneContainer;
 
enum class ECustomAttributeBlendType : uint8;
enum EAdditiveAnimationType : int;
 
struct FAnimatedBoneAttribute;
struct FCompactPoseBoneIndex;
struct FAnimExtractContext;
 
class UMirrorDataTable;
 
namespace UE
{
    namespace Anim
    {
        struct FStackAttributeContainer : public TAttributeContainer<FCompactPoseBoneIndex, FAnimStackAllocator> {};
        struct FHeapAttributeContainer : public TAttributeContainer<FCompactPoseBoneIndex, FDefaultAllocator> {};
        struct FMeshAttributeContainer : public TAttributeContainer<FMeshPoseBoneIndex, FDefaultAllocator> {};
 
        template<class BoneIndexType, typename InAllocator>
        struct TAttributeContainerAccessor
        {
            static TArray<TWrappedAttribute<InAllocator>>& GetValues(TAttributeContainer<BoneIndexType, InAllocator>& Attributes,  int32 TypeIndex) {return Attributes.GetValuesInternal(TypeIndex);}
            static TArray<FAttributeId>& GetKeys(TAttributeContainer<BoneIndexType, InAllocator>& Attributes, int32 TypeIndex) {return Attributes.GetKeysInternal(TypeIndex);}
        };
 
        struct FStackAttributeContainerAccessor : public TAttributeContainerAccessor<FCompactPoseBoneIndex, FAnimStackAllocator> {};
        struct FHeapAttributeContainerAccessor : public TAttributeContainerAccessor<FCompactPoseBoneIndex, FDefaultAllocator> {};
        
        struct Attributes
        {
#if WITH_EDITOR
            UE_DEPRECATED(5.1, "GetAttributeValue with signature using FAnimExtractContext is deprecated use other version instead")
            static ENGINE_API void GetAttributeValue(FStackAttributeContainer& OutAttributes, const FCompactPoseBoneIndex& PoseBoneIndex, const FAnimatedBoneAttribute& Attribute, const FAnimExtractContext& ExtractionContext);
 
            static ENGINE_API void GetAttributeValue(FStackAttributeContainer& OutAttributes, const FCompactPoseBoneIndex& PoseBoneIndex, const FAnimatedBoneAttribute& Attribute, double CurrentTime);
#endif // WITH_EDITOR
 
            static ENGINE_API void BlendAttributes(const TArrayView<const FStackAttributeContainer> SourceAttributes, const TArrayView<const float> SourceWeights, FStackAttributeContainer& OutAttributes);
 
            static ENGINE_API void BlendAttributes(const TArrayView<const FStackAttributeContainer* const> SourceAttributes, const TArrayView<const float> SourceWeights, FStackAttributeContainer& OutAttributes);
 
            static ENGINE_API void BlendAttributes(const TArrayView<const FStackAttributeContainer> SourceAttributes, const TArrayView<const float> SourceWeights, const TArrayView<const int32> SourceWeightsIndices, FStackAttributeContainer& OutAttributes);
 
            /* Blend custom attribute values from 2 inputs, using per-bone weights */
            static ENGINE_API void BlendAttributesPerBone(const FStackAttributeContainer& SourceAttributes1, const FStackAttributeContainer& SourceAttributes2, const TArrayView<const float> WeightsOfSource2, FStackAttributeContainer& OutAttributes);
 
            /* Blend custom attribute values from N set of inputs, using N number of blend samples */
            static ENGINE_API void BlendAttributesPerBone(TArrayView<const FStackAttributeContainer> SourceAttributes, TArrayView<const int32> PerBoneInterpolationIndices, TArrayView<const FBlendSampleData> BlendSampleDataCache, FStackAttributeContainer& OutAttributes);
 
            /* Blend custom attribute values from N set of inputs, using N number of blend samples */
            static ENGINE_API void BlendAttributesPerBone(TArrayView<const FStackAttributeContainer> SourceAttributes, TArrayView<const int32> PerBoneInterpolationIndices, TArrayView<const FBlendSampleData> BlendSampleDataCache, TArrayView<const int32> BlendSampleDataCacheIndices, FStackAttributeContainer& OutAttributes);
 
            /* Blend custom attribute values from N set of inputs, using bone filter pose weights */
            static ENGINE_API void BlendAttributesPerBoneFilter(const FStackAttributeContainer& BaseAttributes, const TArrayView<const FStackAttributeContainer> BlendAttributes, const TConstArrayView<FPerBoneBlendWeight> BoneBlendWeights, FStackAttributeContainer& OutAttributes);
 
            static ENGINE_API void OverrideAttributes(const FStackAttributeContainer& SourceAttributes, FStackAttributeContainer& OutAttributes, float Weight);
 
            static ENGINE_API void AccumulateAttributes(const FStackAttributeContainer& SourceAttributes, FStackAttributeContainer& OutAttributes, float Weight, EAdditiveAnimationType AdditiveType);
 
            static ENGINE_API void ConvertToAdditive(const FStackAttributeContainer& BaseAttributes, FStackAttributeContainer& OutAdditiveAttributes);
 
            static ENGINE_API void CopyAndRemapAttributes(const FMeshAttributeContainer& SourceAttributes, FStackAttributeContainer& OutAttributes, const TMap<int32, int32>& BoneMapToSource, const FBoneContainer& RequiredBones);
 
            static ENGINE_API void InterpolateAttributes(FMeshAttributeContainer& FromAttributes, const FMeshAttributeContainer& ToAttributes, float Alpha);
 
            static ENGINE_API void MirrorAttributes(FStackAttributeContainer& Attributes, const UMirrorDataTable& MirrorDataTable, const TArray<FCompactPoseBoneIndex>& CompactPoseMirrorBones);
 
            UE_DEPRECATED(5.2, "MirrorAttributes has been deprecated, use other signature instead")
            static ENGINE_API void MirrorAttributes(FStackAttributeContainer& Attributes, const UMirrorDataTable& MirrorDataTable);
            
            static ENGINE_API ECustomAttributeBlendType GetAttributeBlendType(const FName& InName);
 
            static ENGINE_API ECustomAttributeBlendType GetAttributeBlendType(const FAttributeId& Info);
        };
    }
}
 
struct ENGINE_API UE_DEPRECATED(5.0, "FStackCustomAttributes has been deprecated use UE::Anim::FStackAttributeContainer instead") FStackCustomAttributes : public UE::Anim::FStackAttributeContainer {};
struct ENGINE_API UE_DEPRECATED(5.0, "FStackCustomAttributes has been deprecated use UE::Anim::FStackAttributeContainer instead") FHeapCustomAttributes : public UE::Anim::FHeapAttributeContainer {};