You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
2d953ade9f
- One driver value can now drive multiple components - How a component is driven is now configurable (add to input, replace, add to ref pose and replace) - The range limit is now defined on the input (before the multiplier is applied) rather than the output (existing ranges are fixed up on load) - New details customization to make working with the node easier - Individual scale components can now be a driver or one of the driven components, rather than just the max component of scale - The node title now displays the driving equation (e.g., driven.rotation.z = -0.5 * driver.rotation.x) Animation: Added a custom version for AnimGraph/AnimGraphRuntime usage Upgrade Note: The exact behavior of the original node was not preserved, but there are now more configuration options, so please revisit any uses of bone driven controllers in your animation blueprints [CL 2606968 by Michael Noland in Main branch]
341 lines
14 KiB
C++
341 lines
14 KiB
C++
// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "AnimGraphPrivatePCH.h"
|
|
#include "AnimGraphNode_BoneDrivenController.h"
|
|
#include "CompilerResultsLog.h"
|
|
#include "PropertyEditing.h"
|
|
#include "AnimationCustomVersion.h"
|
|
|
|
#define LOCTEXT_NAMESPACE "A3Nodes"
|
|
|
|
UAnimGraphNode_BoneDrivenController::UAnimGraphNode_BoneDrivenController(const FObjectInitializer& ObjectInitializer)
|
|
:Super(ObjectInitializer)
|
|
{
|
|
|
|
}
|
|
|
|
void UAnimGraphNode_BoneDrivenController::Serialize(FArchive& Ar)
|
|
{
|
|
Super::Serialize(Ar);
|
|
|
|
Ar.UsingCustomVersion(FAnimationCustomVersion::GUID);
|
|
|
|
if (Ar.CustomVer(FAnimationCustomVersion::GUID) < FAnimationCustomVersion::BoneDrivenControllerMatchingMaya)
|
|
{
|
|
// The node used to be able to only drive a single component rather than a selection of components
|
|
Node.ConvertTargetComponentToBits();
|
|
|
|
// The old definition of range was clamping the output, rather than the input
|
|
if (Node.bUseRange && !FMath::IsNearlyZero(Node.Multiplier))
|
|
{
|
|
// Before: Output = clamp(Input * Multipler)
|
|
// After: Output = clamp(Input) * Multiplier
|
|
Node.RangeMin /= Node.Multiplier;
|
|
Node.RangeMax /= Node.Multiplier;
|
|
}
|
|
}
|
|
}
|
|
|
|
FText UAnimGraphNode_BoneDrivenController::GetTooltipText() const
|
|
{
|
|
return LOCTEXT("UAnimGraphNode_BoneDrivenController_ToolTip", "Drives the transform of a bone using the transform of another");
|
|
}
|
|
|
|
FText UAnimGraphNode_BoneDrivenController::GetNodeTitle(ENodeTitleType::Type TitleType) const
|
|
{
|
|
if ((Node.SourceBone.BoneName == NAME_None) && (Node.TargetBone.BoneName == NAME_None) && ((TitleType == ENodeTitleType::ListView) || (TitleType == ENodeTitleType::MenuTitle)))
|
|
{
|
|
return GetControllerDescription();
|
|
}
|
|
else
|
|
{
|
|
// Determine the mapping
|
|
FText FinalSourceExpression;
|
|
{
|
|
FFormatNamedArguments SourceArgs;
|
|
SourceArgs.Add(TEXT("SourceBone"), FText::FromName(Node.SourceBone.BoneName));
|
|
SourceArgs.Add(TEXT("SourceComponent"), ComponentTypeToText(Node.SourceComponent));
|
|
|
|
if (Node.DrivingCurve != nullptr)
|
|
{
|
|
FinalSourceExpression = LOCTEXT("BoneDrivenByCurve", "curve({SourceBone}.{SourceComponent})");
|
|
}
|
|
else
|
|
{
|
|
if (Node.Multiplier == 1.0f)
|
|
{
|
|
FinalSourceExpression = LOCTEXT("BoneMultiplierIs1", "{SourceBone}.{SourceComponent}");
|
|
}
|
|
else
|
|
{
|
|
SourceArgs.Add(TEXT("Multiplier"), FText::AsNumber(Node.Multiplier));
|
|
FinalSourceExpression = LOCTEXT("BoneMultiplierIs1", "{SourceBone}.{SourceComponent} * {Multiplier}");
|
|
}
|
|
}
|
|
|
|
FinalSourceExpression = FText::Format(FinalSourceExpression, SourceArgs);
|
|
}
|
|
|
|
FFormatNamedArguments Args;
|
|
Args.Add(TEXT("ControllerDesc"), GetControllerDescription());
|
|
Args.Add(TEXT("TargetBone"), FText::FromName(Node.TargetBone.BoneName));
|
|
|
|
// Determine the target component
|
|
int32 NumComponents = 0;
|
|
EComponentType::Type TargetComponent = EComponentType::None;
|
|
|
|
#define UE_CHECK_TARGET_COMPONENT(ComponentProperty, ComponentChoice) if (ComponentProperty) { ++NumComponents; TargetComponent = ComponentChoice; }
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetTranslationX, EComponentType::TranslationX);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetTranslationY, EComponentType::TranslationY);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetTranslationZ, EComponentType::TranslationZ);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetRotationX, EComponentType::RotationX);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetRotationY, EComponentType::RotationY);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetRotationZ, EComponentType::RotationZ);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetScaleX, EComponentType::ScaleX);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetScaleY, EComponentType::ScaleY);
|
|
UE_CHECK_TARGET_COMPONENT(Node.bAffectTargetScaleZ, EComponentType::ScaleZ);
|
|
Args.Add(TEXT("TargetComponents"), (NumComponents <= 1) ? ComponentTypeToText(TargetComponent) : LOCTEXT("MultipleTargetComponents", "multiple"));
|
|
|
|
if ((TitleType == ENodeTitleType::ListView) || (TitleType == ENodeTitleType::MenuTitle))
|
|
{
|
|
Args.Add(TEXT("Delim"), FText::FromString(TEXT(" - ")));
|
|
}
|
|
else
|
|
{
|
|
Args.Add(TEXT("Delim"), FText::FromString(TEXT("\n")));
|
|
}
|
|
|
|
Args.Add(TEXT("SourceExpression"), FinalSourceExpression);
|
|
return FText::Format(LOCTEXT("AnimGraphNode_BoneDrivenController_Title", "{TargetBone}.{TargetComponents} = {SourceExpression}{Delim}{ControllerDesc}"), Args);
|
|
}
|
|
}
|
|
|
|
FText UAnimGraphNode_BoneDrivenController::GetControllerDescription() const
|
|
{
|
|
return LOCTEXT("BoneDrivenController", "Bone Driven Controller");
|
|
}
|
|
|
|
void UAnimGraphNode_BoneDrivenController::Draw(FPrimitiveDrawInterface* PDI, USkeletalMeshComponent* SkelMeshComp) const
|
|
{
|
|
static const float ArrowHeadWidth = 5.0f;
|
|
static const float ArrowHeadHeight = 8.0f;
|
|
|
|
const int32 SourceIdx = SkelMeshComp->GetBoneIndex(Node.SourceBone.BoneName);
|
|
const int32 TargetIdx = SkelMeshComp->GetBoneIndex(Node.TargetBone.BoneName);
|
|
|
|
if ((SourceIdx != INDEX_NONE) && (TargetIdx != INDEX_NONE))
|
|
{
|
|
const FTransform SourceTM = SkelMeshComp->GetSpaceBases()[SourceIdx] * SkelMeshComp->ComponentToWorld;
|
|
const FTransform TargetTM = SkelMeshComp->GetSpaceBases()[TargetIdx] * SkelMeshComp->ComponentToWorld;
|
|
|
|
PDI->DrawLine(TargetTM.GetLocation(), SourceTM.GetLocation(), FLinearColor(0.0f, 0.0f, 1.0f), SDPG_Foreground, 0.5f);
|
|
|
|
const FVector ToTarget = TargetTM.GetTranslation() - SourceTM.GetTranslation();
|
|
const FVector UnitToTarget = ToTarget.GetSafeNormal();
|
|
FVector Midpoint = SourceTM.GetTranslation() + 0.5f * ToTarget + 0.5f * UnitToTarget * ArrowHeadHeight;
|
|
|
|
FVector YAxis;
|
|
FVector ZAxis;
|
|
UnitToTarget.FindBestAxisVectors(YAxis, ZAxis);
|
|
const FMatrix ArrowMatrix(UnitToTarget, YAxis, ZAxis, Midpoint);
|
|
|
|
DrawConnectedArrow(PDI, ArrowMatrix, FLinearColor(0.0f, 1.0f, 0.0), ArrowHeadHeight, ArrowHeadWidth, SDPG_Foreground);
|
|
|
|
PDI->DrawPoint(SourceTM.GetTranslation(), FLinearColor(0.8f, 0.8f, 0.2f), 5.0f, SDPG_Foreground);
|
|
PDI->DrawPoint(SourceTM.GetTranslation() + ToTarget, FLinearColor(0.8f, 0.8f, 0.2f), 5.0f, SDPG_Foreground);
|
|
}
|
|
}
|
|
|
|
void UAnimGraphNode_BoneDrivenController::ValidateAnimNodeDuringCompilation(USkeleton* ForSkeleton, FCompilerResultsLog& MessageLog)
|
|
{
|
|
if (ForSkeleton->GetReferenceSkeleton().FindBoneIndex(Node.SourceBone.BoneName) == INDEX_NONE)
|
|
{
|
|
MessageLog.Warning(*LOCTEXT("NoSourceBone", "@@ - You must pick a source bone as the Driver joint").ToString(), this);
|
|
}
|
|
|
|
if (Node.SourceComponent == EComponentType::None)
|
|
{
|
|
MessageLog.Warning(*LOCTEXT("NoSourceComponent", "@@ - You must pick a source component on the Driver joint").ToString(), this);
|
|
}
|
|
|
|
if (ForSkeleton->GetReferenceSkeleton().FindBoneIndex(Node.TargetBone.BoneName) == INDEX_NONE)
|
|
{
|
|
MessageLog.Warning(*LOCTEXT("NoTargetBone", "@@ - You must pick a target bone as the Driven joint").ToString(), this);
|
|
}
|
|
|
|
const bool bAffectsTranslation = Node.bAffectTargetTranslationX || Node.bAffectTargetTranslationY || Node.bAffectTargetTranslationZ;
|
|
const bool bAffectsRotation = Node.bAffectTargetRotationX || Node.bAffectTargetRotationY || Node.bAffectTargetRotationZ;
|
|
const bool bAffectsScale = Node.bAffectTargetScaleX || Node.bAffectTargetScaleY || Node.bAffectTargetScaleZ;
|
|
|
|
if (!bAffectsTranslation && !bAffectsRotation && !bAffectsScale)
|
|
{
|
|
MessageLog.Warning(*LOCTEXT("NoTargetComponent", "@@ - You must pick one or more target components on the Driven joint").ToString(), this);
|
|
}
|
|
|
|
Super::ValidateAnimNodeDuringCompilation(ForSkeleton, MessageLog);
|
|
}
|
|
|
|
void UAnimGraphNode_BoneDrivenController::AddTripletPropertyRow(const FText& Name, const FText& Tooltip, IDetailCategoryBuilder& Category, TSharedRef<IPropertyHandle> PropertyHandle, const FName XPropertyName, const FName YPropertyName, const FName ZPropertyName)
|
|
{
|
|
const float XYZPadding = 5.0f;
|
|
|
|
TSharedPtr<IPropertyHandle> XProperty = PropertyHandle->GetChildHandle(XPropertyName);
|
|
Category.GetParentLayout().HideProperty(XProperty);
|
|
|
|
TSharedPtr<IPropertyHandle> YProperty = PropertyHandle->GetChildHandle(YPropertyName);
|
|
Category.GetParentLayout().HideProperty(YProperty);
|
|
|
|
TSharedPtr<IPropertyHandle> ZProperty = PropertyHandle->GetChildHandle(ZPropertyName);
|
|
Category.GetParentLayout().HideProperty(ZProperty);
|
|
|
|
Category.AddCustomRow(Name)
|
|
.NameContent()
|
|
[
|
|
SNew(STextBlock)
|
|
.Text(Name)
|
|
.ToolTipText(Tooltip)
|
|
.Font(IDetailLayoutBuilder::GetDetailFont())
|
|
]
|
|
.ValueContent()
|
|
[
|
|
SNew(SHorizontalBox)
|
|
+ SHorizontalBox::Slot()
|
|
.Padding(0.f, 0.f, XYZPadding, 0.f)
|
|
.AutoWidth()
|
|
[
|
|
SNew(SHorizontalBox)
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
XProperty->CreatePropertyNameWidget()
|
|
]
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
XProperty->CreatePropertyValueWidget()
|
|
]
|
|
]
|
|
|
|
+ SHorizontalBox::Slot()
|
|
.Padding(0.f, 0.f, XYZPadding, 0.f)
|
|
.AutoWidth()
|
|
[
|
|
SNew(SHorizontalBox)
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
YProperty->CreatePropertyNameWidget()
|
|
]
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
YProperty->CreatePropertyValueWidget()
|
|
]
|
|
]
|
|
|
|
+ SHorizontalBox::Slot()
|
|
.Padding(0.f, 0.f, XYZPadding, 0.f)
|
|
.AutoWidth()
|
|
[
|
|
SNew(SHorizontalBox)
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
ZProperty->CreatePropertyNameWidget()
|
|
]
|
|
+ SHorizontalBox::Slot()
|
|
.AutoWidth()
|
|
[
|
|
ZProperty->CreatePropertyValueWidget()
|
|
]
|
|
]
|
|
];
|
|
}
|
|
|
|
void UAnimGraphNode_BoneDrivenController::CustomizeDetails(IDetailLayoutBuilder& DetailBuilder)
|
|
{
|
|
TSharedRef<IPropertyHandle> NodeHandle = DetailBuilder.GetProperty(GET_MEMBER_NAME_CHECKED(UAnimGraphNode_BoneDrivenController, Node), GetClass());
|
|
|
|
TAttribute<EVisibility> NotUsingCurveVisibility = TAttribute<EVisibility>::Create(TAttribute<EVisibility>::FGetter::CreateUObject(this, &UAnimGraphNode_BoneDrivenController::AreNonCurveMappingValuesVisible));
|
|
|
|
|
|
// Source (Driver) category
|
|
IDetailCategoryBuilder& SourceCategory = DetailBuilder.EditCategory(TEXT("Source (Driver)"));
|
|
|
|
// Mapping category
|
|
IDetailCategoryBuilder& MappingCategory = DetailBuilder.EditCategory(TEXT("Mapping"));
|
|
MappingCategory.AddProperty(NodeHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, DrivingCurve)));
|
|
|
|
MappingCategory.AddProperty(NodeHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, Multiplier))).Visibility(NotUsingCurveVisibility);
|
|
MappingCategory.AddProperty(NodeHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bUseRange))).Visibility(NotUsingCurveVisibility);
|
|
MappingCategory.AddProperty(NodeHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, RangeMin))).Visibility(NotUsingCurveVisibility);
|
|
MappingCategory.AddProperty(NodeHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, RangeMax))).Visibility(NotUsingCurveVisibility);
|
|
|
|
// Destination (Driven) category
|
|
IDetailCategoryBuilder& TargetCategory = DetailBuilder.EditCategory(TEXT("Destination (Driven)"));
|
|
TargetCategory.AddProperty(NodeHandle->GetChildHandle(GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, TargetBone)));
|
|
|
|
AddTripletPropertyRow(
|
|
/*Name=*/ LOCTEXT("DrivenTranslationLabel", "Translation"),
|
|
/*Tooltip=*/ LOCTEXT("DrivenTranslationTooltip", "Should the source bone drive one or more translation components of the target bone?"),
|
|
/*Category=*/ TargetCategory,
|
|
/*PropertyHandle=*/ NodeHandle,
|
|
/*X=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetTranslationX),
|
|
/*Y=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetTranslationY),
|
|
/*Z=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetTranslationZ));
|
|
|
|
AddTripletPropertyRow(
|
|
/*Name=*/ LOCTEXT("DrivenRotationLabel", "Rotation"),
|
|
/*Tooltip=*/ LOCTEXT("DrivenRotationTooltip", "Should the source bone drive one or more rotation components of the target bone?"),
|
|
/*Category=*/ TargetCategory,
|
|
/*PropertyHandle=*/ NodeHandle,
|
|
/*X=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetRotationX),
|
|
/*Y=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetRotationY),
|
|
/*Z=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetRotationZ));
|
|
|
|
AddTripletPropertyRow(
|
|
/*Name=*/ LOCTEXT("DrivenScaleLabel", "Scale"),
|
|
/*Tooltip=*/ LOCTEXT("DrivenScaleTooltip", "Should the source bone drive one or more scale components of the target bone?"),
|
|
/*Category=*/ TargetCategory,
|
|
/*PropertyHandle=*/ NodeHandle,
|
|
/*X=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetScaleX),
|
|
/*Y=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetScaleY),
|
|
/*Z=*/ GET_MEMBER_NAME_CHECKED(FAnimNode_BoneDrivenController, bAffectTargetScaleZ));
|
|
}
|
|
|
|
FText UAnimGraphNode_BoneDrivenController::ComponentTypeToText(EComponentType::Type Component)
|
|
{
|
|
switch (Component)
|
|
{
|
|
case EComponentType::TranslationX:
|
|
return LOCTEXT("ComponentType_TranslationX", "translateX");
|
|
case EComponentType::TranslationY:
|
|
return LOCTEXT("ComponentType_TranslationY", "translateY");
|
|
case EComponentType::TranslationZ:
|
|
return LOCTEXT("ComponentType_TranslationZ", "translateZ");
|
|
case EComponentType::RotationX:
|
|
return LOCTEXT("ComponentType_RotationX", "rotateX");
|
|
case EComponentType::RotationY:
|
|
return LOCTEXT("ComponentType_RotationY", "rotateY");
|
|
case EComponentType::RotationZ:
|
|
return LOCTEXT("ComponentType_RotationZ", "rotateZ");
|
|
case EComponentType::Scale:
|
|
return LOCTEXT("ComponentType_ScaleMax", "scaleMax");
|
|
case EComponentType::ScaleX:
|
|
return LOCTEXT("ComponentType_ScaleX", "scaleX");
|
|
case EComponentType::ScaleY:
|
|
return LOCTEXT("ComponentType_ScaleY", "scaleY");
|
|
case EComponentType::ScaleZ:
|
|
return LOCTEXT("ComponentType_ScaleZ", "scaleZ");
|
|
default:
|
|
return LOCTEXT("ComponentType_None", "(none)");
|
|
}
|
|
}
|
|
|
|
EVisibility UAnimGraphNode_BoneDrivenController::AreNonCurveMappingValuesVisible() const
|
|
{
|
|
return (Node.DrivingCurve != nullptr) ? EVisibility::Collapsed : EVisibility::Visible;
|
|
}
|
|
|
|
#undef LOCTEXT_NAMESPACE
|