Files
UnrealEngineUWP/Engine/Source/Runtime/AnimGraphRuntime/Private/AnimNodes/AnimNode_CopyPoseFromMesh.cpp
Marc Audy 0c3be2b6ad Merge Release-Engine-Staging to Test @ CL# 18240298
[CL 18241953 by Marc Audy in ue5-release-engine-test branch]
2021-11-18 14:37:34 -05:00

321 lines
12 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "AnimNodes/AnimNode_CopyPoseFromMesh.h"
#include "Animation/AnimInstanceProxy.h"
#include "Animation/AnimTrace.h"
/////////////////////////////////////////////////////
// FAnimNode_CopyPoseFromMesh
FAnimNode_CopyPoseFromMesh::FAnimNode_CopyPoseFromMesh()
: SourceMeshComponent(nullptr)
, bUseAttachedParent (false)
, bCopyCurves (false)
, bCopyCustomAttributes(false)
, bUseMeshPose (false)
{
}
void FAnimNode_CopyPoseFromMesh::Initialize_AnyThread(const FAnimationInitializeContext& Context)
{
DECLARE_SCOPE_HIERARCHICAL_COUNTER_ANIMNODE(Initialize_AnyThread)
FAnimNode_Base::Initialize_AnyThread(Context);
// Initial update of the node, so we dont have a frame-delay on setup
GetEvaluateGraphExposedInputs().Execute(Context);
}
void FAnimNode_CopyPoseFromMesh::CacheBones_AnyThread(const FAnimationCacheBonesContext& Context)
{
DECLARE_SCOPE_HIERARCHICAL_COUNTER_ANIMNODE(CacheBones_AnyThread)
}
void FAnimNode_CopyPoseFromMesh::RefreshMeshComponent(USkeletalMeshComponent* TargetMeshComponent)
{
auto ResetMeshComponent = [this](USkeletalMeshComponent* InMeshComponent, USkeletalMeshComponent* InTargetMeshComponent)
{
USkeletalMeshComponent* CurrentMeshComponent = CurrentlyUsedSourceMeshComponent.Get();
// if current mesh exists, but not same as input mesh
if (CurrentMeshComponent)
{
// if component has been changed, reinitialize
if (CurrentMeshComponent != InMeshComponent)
{
ReinitializeMeshComponent(InMeshComponent, InTargetMeshComponent);
}
// if component is still same but mesh has been changed, we have to reinitialize
else if (CurrentMeshComponent->SkeletalMesh != CurrentlyUsedSourceMesh.Get())
{
ReinitializeMeshComponent(InMeshComponent, InTargetMeshComponent);
}
else if (InTargetMeshComponent)
{
// see if target mesh has changed
if (InTargetMeshComponent->SkeletalMesh != CurrentlyUsedTargetMesh.Get())
{
ReinitializeMeshComponent(InMeshComponent, InTargetMeshComponent);
}
}
}
// if not valid, but input mesh is
else if (!CurrentMeshComponent && InMeshComponent)
{
ReinitializeMeshComponent(InMeshComponent, InTargetMeshComponent);
}
};
if(SourceMeshComponent.IsValid())
{
ResetMeshComponent(SourceMeshComponent.Get(), TargetMeshComponent);
}
else if (bUseAttachedParent)
{
if (TargetMeshComponent)
{
USkeletalMeshComponent* ParentComponent = Cast<USkeletalMeshComponent>(TargetMeshComponent->GetAttachParent());
if (ParentComponent)
{
ResetMeshComponent(ParentComponent, TargetMeshComponent);
}
else
{
CurrentlyUsedSourceMeshComponent.Reset();
}
}
else
{
CurrentlyUsedSourceMeshComponent.Reset();
}
}
else
{
CurrentlyUsedSourceMeshComponent.Reset();
}
}
void FAnimNode_CopyPoseFromMesh::PreUpdate(const UAnimInstance* InAnimInstance)
{
QUICK_SCOPE_CYCLE_COUNTER(FAnimNode_CopyPoseFromMesh_PreUpdate);
RefreshMeshComponent(InAnimInstance->GetSkelMeshComponent());
USkeletalMeshComponent* CurrentMeshComponent = CurrentlyUsedSourceMeshComponent.IsValid() ? CurrentlyUsedSourceMeshComponent.Get() : nullptr;
if (CurrentMeshComponent && CurrentMeshComponent->SkeletalMesh && CurrentMeshComponent->IsRegistered())
{
// If our source is running under master-pose, then get bone data from there
if(USkeletalMeshComponent* MasterPoseComponent = Cast<USkeletalMeshComponent>(CurrentMeshComponent->MasterPoseComponent.Get()))
{
CurrentMeshComponent = MasterPoseComponent;
}
// re-check mesh component validity as it may have changed to master
if(CurrentMeshComponent->SkeletalMesh && CurrentMeshComponent->IsRegistered())
{
const bool bUROInSync = CurrentMeshComponent->ShouldUseUpdateRateOptimizations() && CurrentMeshComponent->AnimUpdateRateParams != nullptr && CurrentMeshComponent->AnimUpdateRateParams == InAnimInstance->GetSkelMeshComponent()->AnimUpdateRateParams;
const bool bUsingExternalInterpolation = CurrentMeshComponent->IsUsingExternalInterpolation();
const TArray<FTransform>& CachedComponentSpaceTransforms = CurrentMeshComponent->GetCachedComponentSpaceTransforms();
const bool bArraySizesMatch = CachedComponentSpaceTransforms.Num() == CurrentMeshComponent->GetComponentSpaceTransforms().Num();
// Copy source array from the appropriate location
SourceMeshTransformArray.Reset();
SourceMeshTransformArray.Append((bUROInSync || bUsingExternalInterpolation) && bArraySizesMatch ? CachedComponentSpaceTransforms : CurrentMeshComponent->GetComponentSpaceTransforms());
// Ref skeleton is need for parent index lookups later, so store it now
CurrentlyUsedMesh = CurrentMeshComponent->SkeletalMesh;
if(bCopyCurves)
{
UAnimInstance* SourceAnimInstance = CurrentMeshComponent->GetAnimInstance();
if (SourceAnimInstance)
{
// attribute curve contains all list
SourceCurveList.Reset();
SourceCurveList.Append(SourceAnimInstance->GetAnimationCurveList(EAnimCurveType::AttributeCurve));
}
else
{
SourceCurveList.Reset();
}
}
if (bCopyCustomAttributes)
{
SourceCustomAttributes.CopyFrom(CurrentMeshComponent->GetCustomAttributes());
}
}
else
{
CurrentlyUsedMesh.Reset();
}
}
}
void FAnimNode_CopyPoseFromMesh::Update_AnyThread(const FAnimationUpdateContext& Context)
{
DECLARE_SCOPE_HIERARCHICAL_COUNTER_ANIMNODE(Update_AnyThread)
// This introduces a frame of latency in setting the pin-driven source component,
// but we cannot do the work to extract transforms on a worker thread as it is not thread safe.
GetEvaluateGraphExposedInputs().Execute(Context);
TRACE_ANIM_NODE_VALUE(Context, TEXT("Component"), *GetNameSafe(CurrentlyUsedSourceMeshComponent.IsValid() ? CurrentlyUsedSourceMeshComponent.Get() : nullptr));
TRACE_ANIM_NODE_VALUE(Context, TEXT("Mesh"), *GetNameSafe(CurrentlyUsedSourceMeshComponent.IsValid() ? CurrentlyUsedSourceMeshComponent.Get()->SkeletalMesh : nullptr));
}
void FAnimNode_CopyPoseFromMesh::Evaluate_AnyThread(FPoseContext& Output)
{
DECLARE_SCOPE_HIERARCHICAL_COUNTER_ANIMNODE(Evaluate_AnyThread)
FCompactPose& OutPose = Output.Pose;
OutPose.ResetToRefPose();
USkeletalMesh* CurrentMesh = CurrentlyUsedMesh.IsValid() ? CurrentlyUsedMesh.Get() : nullptr;
if(SourceMeshTransformArray.Num() > 0 && CurrentMesh)
{
const FBoneContainer& RequiredBones = OutPose.GetBoneContainer();
if (bUseMeshPose)
{
FCSPose<FCompactPose> MeshPoses;
MeshPoses.InitPose(OutPose);
for (FCompactPoseBoneIndex PoseBoneIndex : OutPose.ForEachBoneIndex())
{
const FMeshPoseBoneIndex MeshBoneIndex = RequiredBones.MakeMeshPoseIndex(PoseBoneIndex);
const int32* Value = BoneMapToSource.Find(MeshBoneIndex.GetInt());
if (Value && SourceMeshTransformArray.IsValidIndex(*Value))
{
const int32 SourceBoneIndex = *Value;
MeshPoses.SetComponentSpaceTransform(PoseBoneIndex, SourceMeshTransformArray[SourceBoneIndex]);
}
}
FCSPose<FCompactPose>::ConvertComponentPosesToLocalPosesSafe(MeshPoses, OutPose);
}
else
{
for (FCompactPoseBoneIndex PoseBoneIndex : OutPose.ForEachBoneIndex())
{
const FMeshPoseBoneIndex MeshBoneIndex = RequiredBones.MakeMeshPoseIndex(PoseBoneIndex);
const int32* Value = BoneMapToSource.Find(MeshBoneIndex.GetInt());
if (Value && SourceMeshTransformArray.IsValidIndex(*Value))
{
const int32 SourceBoneIndex = *Value;
const int32 ParentIndex = CurrentMesh->GetRefSkeleton().GetParentIndex(SourceBoneIndex);
const FCompactPoseBoneIndex MyParentIndex = RequiredBones.GetParentBoneIndex(PoseBoneIndex);
// only apply if I also have parent, otherwise, it should apply the space bases
if (SourceMeshTransformArray.IsValidIndex(ParentIndex) && MyParentIndex != INDEX_NONE)
{
const FTransform& ParentTransform = SourceMeshTransformArray[ParentIndex];
const FTransform& ChildTransform = SourceMeshTransformArray[SourceBoneIndex];
OutPose[PoseBoneIndex] = ChildTransform.GetRelativeTransform(ParentTransform);
}
else
{
OutPose[PoseBoneIndex] = SourceMeshTransformArray[SourceBoneIndex];
}
}
}
}
}
if (bCopyCurves)
{
for (auto Iter = SourceCurveList.CreateConstIterator(); Iter; ++Iter)
{
const SmartName::UID_Type* UID = CurveNameToUIDMap.Find(Iter.Key());
if (UID)
{
// set source value to output curve
Output.Curve.Set(*UID, Iter.Value());
}
}
}
if (bCopyCustomAttributes)
{
const FBoneContainer& RequiredBones = OutPose.GetBoneContainer();
UE::Anim::Attributes::CopyAndRemapAttributes(SourceCustomAttributes, Output.CustomAttributes, BoneMapToSource, RequiredBones);
}
}
void FAnimNode_CopyPoseFromMesh::GatherDebugData(FNodeDebugData& DebugData)
{
DECLARE_SCOPE_HIERARCHICAL_COUNTER_ANIMNODE(GatherDebugData)
FString DebugLine = DebugData.GetNodeName(this);
DebugLine += FString::Printf(TEXT("('%s')"), *GetNameSafe(CurrentlyUsedSourceMeshComponent.IsValid() ? CurrentlyUsedSourceMeshComponent.Get()->SkeletalMesh : nullptr));
DebugData.AddDebugItem(DebugLine, true);
}
void FAnimNode_CopyPoseFromMesh::ReinitializeMeshComponent(USkeletalMeshComponent* NewSourceMeshComponent, USkeletalMeshComponent* TargetMeshComponent)
{
CurrentlyUsedSourceMeshComponent.Reset();
// reset source mesh
CurrentlyUsedSourceMesh.Reset();
CurrentlyUsedTargetMesh.Reset();
BoneMapToSource.Reset();
CurveNameToUIDMap.Reset();
if (TargetMeshComponent && IsValid(NewSourceMeshComponent) && NewSourceMeshComponent->SkeletalMesh)
{
USkeletalMesh* SourceSkelMesh = NewSourceMeshComponent->SkeletalMesh;
USkeletalMesh* TargetSkelMesh = TargetMeshComponent->SkeletalMesh;
if (IsValid(SourceSkelMesh) && !SourceSkelMesh->HasAnyFlags(RF_NeedPostLoad) &&
IsValid(TargetSkelMesh) && !TargetSkelMesh->HasAnyFlags(RF_NeedPostLoad))
{
CurrentlyUsedSourceMeshComponent = NewSourceMeshComponent;
CurrentlyUsedSourceMesh = SourceSkelMesh;
CurrentlyUsedTargetMesh = TargetSkelMesh;
if (SourceSkelMesh == TargetSkelMesh)
{
for(int32 ComponentSpaceBoneId = 0; ComponentSpaceBoneId < SourceSkelMesh->GetRefSkeleton().GetNum(); ++ComponentSpaceBoneId)
{
BoneMapToSource.Add(ComponentSpaceBoneId, ComponentSpaceBoneId);
}
}
else
{
const int32 SplitBoneIndex = (RootBoneToCopy != NAME_Name)? TargetSkelMesh->GetRefSkeleton().FindBoneIndex(RootBoneToCopy) : INDEX_NONE;
for (int32 ComponentSpaceBoneId = 0; ComponentSpaceBoneId < TargetSkelMesh->GetRefSkeleton().GetNum(); ++ComponentSpaceBoneId)
{
if (SplitBoneIndex == INDEX_NONE || ComponentSpaceBoneId == SplitBoneIndex
|| TargetSkelMesh->GetRefSkeleton().BoneIsChildOf(ComponentSpaceBoneId, SplitBoneIndex))
{
FName BoneName = TargetSkelMesh->GetRefSkeleton().GetBoneName(ComponentSpaceBoneId);
BoneMapToSource.Add(ComponentSpaceBoneId, SourceSkelMesh->GetRefSkeleton().FindBoneIndex(BoneName));
}
}
}
if (bCopyCurves)
{
USkeleton* SourceSkeleton = SourceSkelMesh->GetSkeleton();
USkeleton* TargetSkeleton = TargetSkelMesh->GetSkeleton();
// you shouldn't be here if this happened
if (ensureMsgf(SourceSkeleton, TEXT("Invalid null source skeleton : %s"), *GetNameSafe(SourceSkelMesh))
&& ensureMsgf(TargetSkeleton, TEXT("Invalid null target skeleton : %s"), *GetNameSafe(TargetSkelMesh)))
{
const FSmartNameMapping* SourceContainer = SourceSkeleton->GetSmartNameContainer(USkeleton::AnimCurveMappingName);
const FSmartNameMapping* TargetContainer = TargetSkeleton->GetSmartNameContainer(USkeleton::AnimCurveMappingName);
TArray<FName> SourceCurveNames;
SourceContainer->FillNameArray(SourceCurveNames);
for (int32 Index = 0; Index < SourceCurveNames.Num(); ++Index)
{
SmartName::UID_Type UID = TargetContainer->FindUID(SourceCurveNames[Index]);
if (UID != SmartName::MaxUID)
{
// has a valid UID, add to the list
SmartName::UID_Type& Value = CurveNameToUIDMap.Add(SourceCurveNames[Index]);
Value = UID;
}
}
}
}
}
}
}