MirrorDataTable.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/DataTable.h"
#include "BoneContainer.h"
#include "CustomBoneIndexArray.h"
#include "MirrorDataTable.generated.h"
 
UENUM()
namespace EMirrorRowType
{
    enum Type : int
    {
        Bone,
        AnimationNotify,
        Curve,
        SyncMarker,
        Custom
    };
}
 
 
UENUM()
namespace EMirrorFindReplaceMethod
{
    enum Type : int
    {
        Prefix,
        Suffix,
        RegularExpression
    };
}
 
 
USTRUCT()
struct FMirrorTableRow : public FTableRowBase
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Mirroring)
    FName Name;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Mirroring)
    FName MirroredName;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Mirroring)
    TEnumAsByte<EMirrorRowType::Type> MirrorEntryType;
 
    FMirrorTableRow()
        : Name(NAME_None)
        , MirroredName(NAME_None)
        , MirrorEntryType(EMirrorRowType::Bone) {}
 
    ENGINE_API FMirrorTableRow(const FMirrorTableRow& Other);
    ENGINE_API FMirrorTableRow& operator=(FMirrorTableRow const& Other);
    ENGINE_API bool operator==(FMirrorTableRow const& Other) const;
    ENGINE_API bool operator!=(FMirrorTableRow const& Other) const;
    ENGINE_API bool operator<(FMirrorTableRow const& Other) const;
};
 
 
USTRUCT()
struct FMirrorFindReplaceExpression
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, Category = Mirroring)
    FName FindExpression;
 
    UPROPERTY(EditAnywhere, Category = Mirroring)
    FName ReplaceExpression;
 
    UPROPERTY(EditAnywhere, Category = Mirroring)
    TEnumAsByte<EMirrorFindReplaceMethod::Type> FindReplaceMethod;
 
    FMirrorFindReplaceExpression() 
        : FindExpression(NAME_None)
        , ReplaceExpression(NAME_None)
        , FindReplaceMethod(EMirrorFindReplaceMethod::Prefix) {}
 
    FMirrorFindReplaceExpression(FName InFindExpression, FName InReplaceExpression, EMirrorFindReplaceMethod::Type Method)
        : FindExpression(InFindExpression)
        , ReplaceExpression(InReplaceExpression)
        , FindReplaceMethod(Method)
    {
    }
};
 
UCLASS(MinimalAPI, BlueprintType, hideCategories = (ImportOptions, ImportSource) /* AutoExpandCategories = "MirrorDataTable,ImportOptions"*/)
class UMirrorDataTable : public UDataTable
{
    GENERATED_BODY()
 
    friend class UMirrorDataTableFactory;
 
public:
    UMirrorDataTable(const FObjectInitializer& ObjectInitializer);
 
    ENGINE_API virtual void PostLoad() override;
 
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
 
    ENGINE_API static FName GetSettingsMirrorName(FName InName); 
 
    ENGINE_API static FName GetMirrorName(FName InName, const TArray<FMirrorFindReplaceExpression>& MirrorFindReplaceExpressions);
 
    ENGINE_API static void FillCompactPoseMirrorBones(const FBoneContainer& BoneContainer, const TCustomBoneIndexArray<FSkeletonPoseBoneIndex, FSkeletonPoseBoneIndex>& MirrorBoneIndexes, TCustomBoneIndexArray<FCompactPoseBoneIndex, FCompactPoseBoneIndex>& OutCompactPoseMirrorBones);
 
 
    ENGINE_API void FillMirrorBoneIndexes(const USkeleton* Skeleton, TCustomBoneIndexArray<FSkeletonPoseBoneIndex, FSkeletonPoseBoneIndex>& OutMirrorBoneIndexes) const;
 
    ENGINE_API void FillCompactPoseAndComponentRefRotations(
        const FBoneContainer& BoneContainer,
        TCustomBoneIndexArray<FCompactPoseBoneIndex, FCompactPoseBoneIndex>& OutCompactPoseMirrorBones,
        TCustomBoneIndexArray<FQuat, FCompactPoseBoneIndex>& OutComponentSpaceRefRotations) const;
 
#if WITH_EDITOR  
    ENGINE_API void FindReplaceMirroredNames();
#endif // WITH_EDITOR
 
    ENGINE_API FName FindReplace(FName InName) const;
 
    ENGINE_API static FName FindBestMirroredBone(
        const FName InBoneName,
        const FReferenceSkeleton& InRefSkeleton,
        EAxis::Type InMirrorAxis,
        const float SearchThreshold = 2.0f);
 
public:
 
    UPROPERTY(EditAnywhere, Category = CreateTable)
    TArray<FMirrorFindReplaceExpression> MirrorFindReplaceExpressions;
 
    UPROPERTY(EditAnywhere, Category = Mirroring)
    TEnumAsByte<EAxis::Type> MirrorAxis;
 
    UPROPERTY(EditAnywhere, Category = Mirroring)
    bool  bMirrorRootMotion = true;
    
    UPROPERTY(EditAnywhere, AssetRegistrySearchable, Category = Skeleton)
    TObjectPtr<USkeleton> Skeleton; 
 
    // Index of the mirror bone for a given bone index in the reference skeleton, or INDEX_NONE if the bone is not mirrored
    TCustomBoneIndexArray<FSkeletonPoseBoneIndex, FSkeletonPoseBoneIndex> BoneToMirrorBoneIndex;
    
    UE_DEPRECATED(5.3, "UID-based mirroring has been remove, please use CurveToMirrorCurveMap.")
    TArray<SmartName::UID_Type> CurveMirrorSourceUIDArray;
    
    UE_DEPRECATED(5.3, "UID-based mirroring has been remove, please use CurveToMirrorCurveMap.")
    TArray<SmartName::UID_Type> CurveMirrorTargetUIDArray;
 
    // Map from animation curve to mirrored animation curve
    TMap<FName, FName> CurveToMirrorCurveMap;
    
    // Map from animation notify to mirrored animation notify
    TMap<FName, FName> AnimNotifyToMirrorAnimNotifyMap;
    
    // Map from sync marker to mirrored sync marker 
    TMap<FName, FName> SyncToMirrorSyncMap;
 
protected: 
 
    // Fill BoneToMirrorBoneIndex, CurveMirrorSourceUIDArray, CurveMirrorTargetUIDArray and NotifyToMirrorNotifyIndex based on the Skeleton and Table Contents
    ENGINE_API void FillMirrorArrays();
};