UnrealEngineUWP/Engine/Source/Editor/AnimGraph/Private/AnimGraphDetails.cpp

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.

#include "AnimGraphDetails.h"
#include "IAnimationBlueprintEditor.h"
#include "DetailLayoutBuilder.h"
#include "DetailCategoryBuilder.h"
#include "EdGraph/EdGraph.h"
#include "AnimGraphNode_SubInput.h"
#include "Algo/Transform.h"
#include "DetailWidgetRow.h"
#include "Widgets/Text/STextBlock.h"
#include "Widgets/Layout/SBox.h"
#include "EdGraphSchema_K2_Actions.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/Images/SImage.h"
#include "AnimGraphNode_Root.h"
#include "ScopedTransaction.h"
#include "SKismetInspector.h"
#include "AnimationGraphSchema.h"
#include "Kismet2/BlueprintEditorUtils.h"
#include "Widgets/Input/SComboButton.h"
#include "Widgets/Input/SEditableTextBox.h"

#define LOCTEXT_NAMESPACE "FAnimGraphDetails"

TSharedPtr<IDetailCustomization> FAnimGraphDetails::MakeInstance(TSharedPtr<IBlueprintEditor> InBlueprintEditor)
{
	const TArray<UObject*>* Objects = (InBlueprintEditor.IsValid() ? InBlueprintEditor->GetObjectsCurrentlyBeingEdited() : nullptr);
	if (Objects && Objects->Num() == 1)
	{
		if (UAnimBlueprint* AnimBlueprint = Cast<UAnimBlueprint>((*Objects)[0]))
		{
			return MakeShareable(new FAnimGraphDetails(StaticCastSharedPtr<IAnimationBlueprintEditor>(InBlueprintEditor), AnimBlueprint));
		}
	}

	return nullptr;
}

void FAnimGraphDetails::CustomizeDetails(IDetailLayoutBuilder& DetailLayout)
{
	TArray<TWeakObjectPtr<UObject>> Objects;
	DetailLayout.GetObjectsBeingCustomized(Objects);

	Graph = CastChecked<UEdGraph>(Objects[0].Get());

	bool const bIsStateMachine = !Graph->GetOuter()->IsA(UAnimBlueprint::StaticClass());

	if(Objects.Num() > 1 || bIsStateMachine)
	{
		IDetailCategoryBuilder& InputsCategory = DetailLayout.EditCategory("Inputs", LOCTEXT("SubInputsCategory", "Inputs"));
		InputsCategory.SetCategoryVisibility(false);
		return;
	}

	TSharedPtr<IAnimationBlueprintEditor> AnimBlueprintEditor = AnimBlueprintEditorPtr.Pin();
	const bool bIsDefaultGraph = Graph->GetFName() == UEdGraphSchema_K2::GN_AnimGraph;

	if(!Graph->bAllowDeletion && !bIsDefaultGraph)
	{
		FText ReadOnlyWarning = LOCTEXT("ReadOnlyWarning", "This graph's inputs are read-only and cannot be edited");

		IDetailCategoryBuilder& InputsCategory = DetailLayout.EditCategory("Inputs", LOCTEXT("SubInputsCategory", "Inputs"));
		InputsCategory.SetCategoryVisibility(false);

		IDetailCategoryBuilder& WarningCategoryBuilder = DetailLayout.EditCategory("GraphInputs", LOCTEXT("GraphInputsCategory", "Graph Inputs"));
		WarningCategoryBuilder.AddCustomRow(ReadOnlyWarning)
			.WholeRowContent()
			[
				SNew(STextBlock)
				.Text(ReadOnlyWarning)
				.Font(IDetailLayoutBuilder::GetDetailFont())
			];

		return;
	}

	if(!bIsDefaultGraph)
	{
		IDetailCategoryBuilder& LayerCategory = DetailLayout.EditCategory("Layer", LOCTEXT("LayerCategory", "Layer"));
		{
			FText GroupLabel(LOCTEXT("LayerGroup", "Group"));
			FText GroupToolTip(LOCTEXT("LayerGroupToolTip", "The group of this layer. Grouped layers will run using the same underlying instance, so can share state."));

			RefreshGroupSource();

			LayerCategory.AddCustomRow(GroupLabel)
			.NameContent()
			[
				SNew(STextBlock)
				.Text(GroupLabel)
				.ToolTipText(GroupToolTip)
				.Font(IDetailLayoutBuilder::GetDetailFont())
			]
			.ValueContent()
			[
				SAssignNew(GroupComboButton, SComboButton)
				.ContentPadding(FMargin(0,0,5,0))
				.ToolTipText(GroupToolTip)
				.ButtonContent()
				[
					SNew(SBorder)
					.BorderImage(FEditorStyle::GetBrush("NoBorder"))
					.Padding(FMargin(0, 0, 5, 0))
					[
						SNew(SEditableTextBox)
						.Text(this, &FAnimGraphDetails::OnGetGroupText)
						.OnTextCommitted(this, &FAnimGraphDetails::OnGroupTextCommitted)
						.ToolTipText(GroupToolTip)
						.SelectAllTextWhenFocused(true)
						.RevertTextOnEscape(true)
						.Font(IDetailLayoutBuilder::GetDetailFont())
					]
				]
				.MenuContent()
				[
					SNew(SVerticalBox)
					+SVerticalBox::Slot()
					.AutoHeight()
					.MaxHeight(400.0f)
					[
						SAssignNew(GroupListView, SListView<TSharedPtr<FText>>)
						.ListItemsSource(&GroupSource)
						.OnGenerateRow(this, &FAnimGraphDetails::MakeGroupViewWidget)
						.OnSelectionChanged(this, &FAnimGraphDetails::OnGroupSelectionChanged)
					]
				]
			];
		}
	}

	IDetailCategoryBuilder& InputsCategory = DetailLayout.EditCategory("Inputs", LOCTEXT("SubInputsCategory", "Inputs"));

	DetailLayoutBuilder = &DetailLayout;

	// Gather inputs, if any
	TArray<UAnimGraphNode_SubInput*> SubInputs;
	Graph->GetNodesOfClass<UAnimGraphNode_SubInput>(SubInputs);

	TSharedRef<SHorizontalBox> InputsHeaderContentWidget = SNew(SHorizontalBox);
	TWeakPtr<SWidget> WeakInputsHeaderWidget = InputsHeaderContentWidget;
	InputsHeaderContentWidget->AddSlot()
	[
		SNew(SHorizontalBox)
	];
	InputsHeaderContentWidget->AddSlot()
	.AutoWidth()
	[
		SNew(SButton)
		.ButtonStyle(FEditorStyle::Get(), "RoundButton")
		.ForegroundColor(FEditorStyle::GetSlateColor("DefaultForeground"))
		.ContentPadding(FMargin(2, 0))
		.OnClicked(this, &FAnimGraphDetails::OnAddNewInputPoseClicked)
		.HAlign(HAlign_Right)
		.ToolTipText(LOCTEXT("NewInputPoseTooltip", "Create a new input pose"))
		.VAlign(VAlign_Center)
		[
			SNew(SHorizontalBox)
			+SHorizontalBox::Slot()
			.AutoWidth()
			.Padding(FMargin(0, 1))
			[
				SNew(SImage)
				.Image(FEditorStyle::GetBrush("Plus"))
			]
			+ SHorizontalBox::Slot()
			.VAlign(VAlign_Center)
			.AutoWidth()
			.Padding(FMargin(2, 0, 0, 0))
			[
				SNew(STextBlock)
				.Font(IDetailLayoutBuilder::GetDetailFontBold())
				.Text(LOCTEXT("NewInputPoseButtonText", "New Input Pose"))
				.Visibility(this, &FAnimGraphDetails::OnGetNewInputPoseTextVisibility, WeakInputsHeaderWidget)
				.ShadowOffset(FVector2D(1, 1))
			]
		]
	];
	InputsCategory.HeaderContent(InputsHeaderContentWidget);

	if(SubInputs.Num())
	{
		for(UAnimGraphNode_SubInput* SubInput : SubInputs)
		{
			auto GetSubInputLabel = [WeakSubInput = TWeakObjectPtr<UAnimGraphNode_SubInput>(SubInput)]()
			{
				if(WeakSubInput.IsValid())
				{
					return FText::FromName(WeakSubInput->Node.Name);
				}

				return FText::GetEmpty();
			};

			TArray<UObject*> ExternalObjects;
			ExternalObjects.Add(SubInput);
			if(IDetailPropertyRow* SubInputRow = InputsCategory.AddExternalObjects(ExternalObjects))
			{
				SubInputRow->ShouldAutoExpand(true);
				SubInputRow->CustomWidget()
				.NameContent()
				[
					SNew(SBox)
					.Padding(2.0f)
					[
						SNew(STextBlock)
						.Text(LOCTEXT("InputPose", "Input Pose"))
						.Font(IDetailLayoutBuilder::GetDetailFont())
					]
				]
				.ValueContent()
				[
					SNew(SBox)
					.Padding(2.0f)
					[
						SNew(SHorizontalBox)
						+SHorizontalBox::Slot()
						.VAlign(VAlign_Center)
						.AutoWidth()
						[
							SNew(STextBlock)
							.Text_Lambda(GetSubInputLabel)
							.Font(IDetailLayoutBuilder::GetDetailFont())
						]
						+SHorizontalBox::Slot()
						.Padding(4.0f, 0.0f, 0.0f, 0.0f)
						.VAlign(VAlign_Center)
						.HAlign(HAlign_Right)
						.FillWidth(1.0f)
						[
							SNew(SButton)
							.ButtonStyle(FEditorStyle::Get(), "HoverHintOnly")
							.ForegroundColor(FEditorStyle::GetSlateColor("DefaultForeground"))
							.ContentPadding(FMargin(2, 2))
							.OnClicked(this, &FAnimGraphDetails::OnRemoveInputPoseClicked, SubInput)
							.ToolTipText(LOCTEXT("RemoveInputPoseTooltip", "Remove this input pose"))
							[
								SNew(SImage)
								.Image(FEditorStyle::GetBrush("Cross"))
							]
						]
					]
				];
			}
		}
	}
	else
	{
		// Add a text widget to let the user know to hit the + icon to add parameters.
		InputsCategory.AddCustomRow(FText::GetEmpty())
		.WholeRowContent()
		.MaxDesiredWidth(980.f)
		[
			SNew(SHorizontalBox)
			+SHorizontalBox::Slot()
			.VAlign(VAlign_Center)
			.Padding(0.0f, 0.0f, 4.0f, 0.0f)
			.AutoWidth()
			[
				SNew(STextBlock)
				.Text(LOCTEXT("NoInputPosesAddedForAnimGraph", "Please press the + icon above to add input poses"))
				.Font(IDetailLayoutBuilder::GetDetailFont())
			]
		];
	}

	bool bIsInterface = AnimBlueprintEditor->GetBlueprintObj()->BlueprintType == BPTYPE_Interface;
	if(bIsInterface)
	{
		UAnimationGraphSchema::AutoArrangeInterfaceGraph(*Graph);
	}
}

FReply FAnimGraphDetails::OnAddNewInputPoseClicked()
{
	TSharedPtr<IAnimationBlueprintEditor> AnimBlueprintEditor = AnimBlueprintEditorPtr.Pin();

	EK2NewNodeFlags NewNodeOperation = EK2NewNodeFlags::None;
	FVector2D NewNodePosition(0.0f, 0.0f);

	bool bIsInterface = AnimBlueprintEditor->GetBlueprintObj()->BlueprintType == BPTYPE_Interface;
	if(!bIsInterface)
	{
		NewNodePosition = UAnimationGraphSchema::GetPositionForNewSubInputNode(*Graph);
	}

	FEdGraphSchemaAction_K2NewNode::SpawnNode<UAnimGraphNode_SubInput>(Graph, NewNodePosition, EK2NewNodeFlags::None);

	DetailLayoutBuilder->ForceRefreshDetails();
	
	return FReply::Handled();
}

EVisibility FAnimGraphDetails::OnGetNewInputPoseTextVisibility(TWeakPtr<SWidget> WeakInputsHeaderWidget) const
{
	return WeakInputsHeaderWidget.Pin()->IsHovered() ? EVisibility::Visible : EVisibility::Collapsed;
}

FReply FAnimGraphDetails::OnRemoveInputPoseClicked(UAnimGraphNode_SubInput* InSubInput)
{
	{
		FScopedTransaction Transaction(LOCTEXT("RemoveInputPose", "Remove Input Pose"));
		Graph->RemoveNode(InSubInput);
	}

	TSharedPtr<IAnimationBlueprintEditor> AnimBlueprintEditor = AnimBlueprintEditorPtr.Pin();
	FBlueprintEditorUtils::MarkBlueprintAsStructurallyModified(AnimBlueprintEditor->GetBlueprintObj());

	DetailLayoutBuilder->ForceRefreshDetails();

	return FReply::Handled();
}

FText FAnimGraphDetails::OnGetGroupText() const
{
	UAnimGraphNode_Root* Root = FBlueprintEditorUtils::GetAnimGraphRoot(Graph);
	if(Root->Node.Group == NAME_None)
	{
		return LOCTEXT("DefaultGroup", "Default");
	}
		
	return FText::FromName(Root->Node.Group);
}

void FAnimGraphDetails::OnGroupTextCommitted(const FText& NewText, ETextCommit::Type InTextCommit)
{
	if (InTextCommit == ETextCommit::OnEnter || InTextCommit == ETextCommit::OnUserMovedFocus)
	{
		// Remove excess whitespace and prevent categories with just spaces
		FText GroupName = FText::TrimPrecedingAndTrailing(NewText);
		if(GroupName.ToString().Equals(TEXT("Default")))
		{
			GroupName = FText::GetEmpty();
		}

		FBlueprintEditorUtils::SetAnimationGraphLayerGroup(Graph, GroupName);

		AnimBlueprintEditorPtr.Pin()->RefreshMyBlueprint();

		RefreshGroupSource();
	}
}

void FAnimGraphDetails::OnGroupSelectionChanged(TSharedPtr<FText> ProposedSelection, ESelectInfo::Type SelectInfo)
{
	if(ProposedSelection.IsValid())
	{
		FText GroupName = *ProposedSelection.Get();
		if(GroupName.ToString().Equals(TEXT("Default")))
		{
			GroupName = FText::GetEmpty();
		}

		FBlueprintEditorUtils::SetAnimationGraphLayerGroup(Graph, GroupName);
		AnimBlueprintEditorPtr.Pin()->RefreshMyBlueprint();

		GroupListView.Pin()->ClearSelection();
		GroupComboButton.Pin()->SetIsOpen(false);

		RefreshGroupSource();
	}
}

TSharedRef< ITableRow > FAnimGraphDetails::MakeGroupViewWidget( TSharedPtr<FText> Item, const TSharedRef< STableViewBase >& OwnerTable )
{
	return 
		SNew(STableRow<TSharedPtr<FString>>, OwnerTable)
		[
			SNew(STextBlock)
			.Text(*Item.Get())
		];
}

void FAnimGraphDetails::RefreshGroupSource()
{
	TSharedPtr<IAnimationBlueprintEditor> AnimBlueprintEditor = AnimBlueprintEditorPtr.Pin();
	UClass* Class = AnimBlueprintEditor->GetBlueprintObj()->SkeletonGeneratedClass;

	GroupSource.Empty();

	UAnimGraphNode_Root* Root = FBlueprintEditorUtils::GetAnimGraphRoot(Graph);
	if(Root->Node.Group != NAME_None)
	{
		GroupSource.Add(MakeShared<FText>(LOCTEXT("DefaultGroup", "Default")));
	}

	// Pull groups from implemented functions
	for (TFieldIterator<UFunction> FunctionIt(Class, EFieldIteratorFlags::IncludeSuper); FunctionIt; ++FunctionIt)
	{
		const UFunction* Function = *FunctionIt;
				
		if(Function->HasMetaData(FBlueprintMetadata::MD_AnimBlueprintFunction))
		{
			FText Group = Function->GetMetaDataText(FBlueprintMetadata::MD_FunctionCategory, TEXT("UObjectCategory"), Function->GetFullGroupName(false));

			if (!Group.IsEmpty())
			{
				bool bNewCategory = true;
				for (int32 GroupIndex = 0; GroupIndex < GroupSource.Num() && bNewCategory; ++GroupIndex)
				{
					bNewCategory &= !GroupSource[GroupIndex].Get()->EqualTo(Group);
				}

				if (bNewCategory)
				{
					GroupSource.Add(MakeShared<FText>(Group));
				}
			}
		}
	}

	if(GroupListView.IsValid())
	{
		GroupListView.Pin()->RequestListRefresh();
	}
}

#undef LOCTEXT_NAMESPACE