You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
290 lines
11 KiB
C++
290 lines
11 KiB
C++
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "BlueprintGraphPrivatePCH.h"
|
|
#include "BlueprintVariableNodeSpawner.h"
|
|
#include "K2Node_Variable.h"
|
|
#include "EditorStyleSettings.h" // for bShowFriendlyNames
|
|
#include "Editor/EditorEngine.h" // for GetFriendlyName()
|
|
#include "ObjectEditorUtils.h" // for GetCategory()
|
|
#include "EdGraphSchema_K2.h" // for ConvertPropertyToPinType()
|
|
#include "EditorCategoryUtils.h" // for BuildCategoryString()
|
|
#include "BlueprintActionFilter.h" // for FBlueprintActionContext
|
|
|
|
#define LOCTEXT_NAMESPACE "BlueprintVariableNodeSpawner"
|
|
|
|
/*******************************************************************************
|
|
* UBlueprintVariableNodeSpawner
|
|
******************************************************************************/
|
|
|
|
//------------------------------------------------------------------------------
|
|
UBlueprintVariableNodeSpawner* UBlueprintVariableNodeSpawner::Create(TSubclassOf<UK2Node_Variable> NodeClass, UProperty const* VarProperty, UObject* Outer/*= nullptr*/)
|
|
{
|
|
check(VarProperty != nullptr);
|
|
if (Outer == nullptr)
|
|
{
|
|
Outer = GetTransientPackage();
|
|
}
|
|
|
|
//--------------------------------------
|
|
// Constructing the Spawner
|
|
//--------------------------------------
|
|
|
|
UBlueprintVariableNodeSpawner* NodeSpawner = NewObject<UBlueprintVariableNodeSpawner>(Outer);
|
|
NodeSpawner->NodeClass = NodeClass;
|
|
NodeSpawner->Field = VarProperty;
|
|
|
|
//--------------------------------------
|
|
// Default UI Signature
|
|
//--------------------------------------
|
|
|
|
FBlueprintActionUiSpec& MenuSignature = NodeSpawner->DefaultMenuSignature;
|
|
FString const VarSubCategory = FObjectEditorUtils::GetCategory(VarProperty);
|
|
MenuSignature.Category = FEditorCategoryUtils::BuildCategoryString(FCommonEditorCategory::Variables, FText::FromString(VarSubCategory));
|
|
|
|
FText const VarName = NodeSpawner->GetVariableName();
|
|
// @TODO: NodeClass could be modified post Create()
|
|
if (NodeClass->IsChildOf(UK2Node_VariableGet::StaticClass()))
|
|
{
|
|
MenuSignature.MenuName = FText::Format(LOCTEXT("GetterMenuName", "Get {0}"), VarName);
|
|
MenuSignature.Tooltip = UK2Node_VariableGet::GetPropertyTooltip(VarProperty);
|
|
}
|
|
else if (NodeClass->IsChildOf(UK2Node_VariableSet::StaticClass()))
|
|
{
|
|
MenuSignature.MenuName = FText::Format(LOCTEXT("SetterMenuName", "Set {0}"), VarName);
|
|
MenuSignature.Tooltip = UK2Node_VariableSet::GetPropertyTooltip(VarProperty);
|
|
}
|
|
// add at least one character, so that PrimeDefaultMenuSignature() doesn't
|
|
// attempt to query the template node
|
|
//
|
|
// @TODO: maybe UPROPERTY() fields should have keyword metadata like functions
|
|
MenuSignature.Keywords = TEXT(" ");
|
|
MenuSignature.IconName = UK2Node_Variable::GetVarIconFromPinType(NodeSpawner->GetVarType(), MenuSignature.IconTint);
|
|
|
|
//--------------------------------------
|
|
// Post-Spawn Setup
|
|
//--------------------------------------
|
|
|
|
auto MemberVarSetupLambda = [](UEdGraphNode* NewNode, UField const* Field)
|
|
{
|
|
if (UProperty const* Property = Cast<UProperty>(Field))
|
|
{
|
|
UBlueprint* Blueprint = FBlueprintEditorUtils::FindBlueprintForNodeChecked(NewNode);
|
|
UClass* OwnerClass = Property->GetOwnerClass();
|
|
|
|
// We need to use a generated class instead of a skeleton class for IsChildOf, so if the OwnerClass has a Blueprint, grab the GeneratedClass
|
|
if(OwnerClass)
|
|
{
|
|
OwnerClass = OwnerClass->GetAuthoritativeClass();
|
|
}
|
|
bool const bIsSelfContext = Blueprint->SkeletonGeneratedClass->GetAuthoritativeClass() == OwnerClass || Blueprint->SkeletonGeneratedClass->IsChildOf(OwnerClass);
|
|
|
|
UK2Node_Variable* VarNode = CastChecked<UK2Node_Variable>(NewNode);
|
|
VarNode->SetFromProperty(Property, bIsSelfContext);
|
|
}
|
|
};
|
|
NodeSpawner->SetNodeFieldDelegate = FSetNodeFieldDelegate::CreateStatic(MemberVarSetupLambda);
|
|
|
|
return NodeSpawner;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
UBlueprintVariableNodeSpawner* UBlueprintVariableNodeSpawner::Create(TSubclassOf<UK2Node_Variable> NodeClass, UEdGraph* VarContext, FBPVariableDescription const& VarDesc, UObject* Outer/*= nullptr*/)
|
|
{
|
|
check(VarContext != nullptr);
|
|
if (Outer == nullptr)
|
|
{
|
|
Outer = GetTransientPackage();
|
|
}
|
|
|
|
//--------------------------------------
|
|
// Constructing the Spawner
|
|
//--------------------------------------
|
|
|
|
// @TODO: consider splitting out local variable spawners (since they don't
|
|
// conform to UBlueprintFieldNodeSpawner
|
|
UBlueprintVariableNodeSpawner* NodeSpawner = NewObject<UBlueprintVariableNodeSpawner>(Outer);
|
|
NodeSpawner->NodeClass = NodeClass;
|
|
NodeSpawner->LocalVarOuter = VarContext;
|
|
NodeSpawner->LocalVarDesc = VarDesc;
|
|
|
|
//--------------------------------------
|
|
// Default UI Signature
|
|
//--------------------------------------
|
|
|
|
FBlueprintActionUiSpec& MenuSignature = NodeSpawner->DefaultMenuSignature;
|
|
MenuSignature.Category = FEditorCategoryUtils::BuildCategoryString(FCommonEditorCategory::Variables, FText::FromName(VarDesc.Category));
|
|
|
|
FText const VarName = NodeSpawner->GetVariableName();
|
|
// @TODO: NodeClass could be modified post Create()
|
|
if (NodeClass->IsChildOf(UK2Node_VariableGet::StaticClass()))
|
|
{
|
|
MenuSignature.MenuName = FText::Format(LOCTEXT("LocalGetterMenuName", "Get {0}"), VarName);
|
|
MenuSignature.Tooltip = UK2Node_VariableGet::GetBlueprintVarTooltip(VarDesc);
|
|
}
|
|
else if (NodeClass->IsChildOf(UK2Node_VariableSet::StaticClass()))
|
|
{
|
|
MenuSignature.MenuName = FText::Format(LOCTEXT("LocalSetterMenuName", "Set {0}"), VarName);
|
|
MenuSignature.Tooltip = UK2Node_VariableSet::GetBlueprintVarTooltip(VarDesc);
|
|
}
|
|
// add at least one character, so that PrimeDefaultMenuSignature() doesn't
|
|
// attempt to query the template node
|
|
MenuSignature.Keywords = TEXT(" ");
|
|
MenuSignature.IconName = UK2Node_Variable::GetVarIconFromPinType(NodeSpawner->GetVarType(), MenuSignature.IconTint);
|
|
|
|
return NodeSpawner;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
UBlueprintVariableNodeSpawner::UBlueprintVariableNodeSpawner(class FPostConstructInitializeProperties const& PCIP)
|
|
: Super(PCIP)
|
|
{
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
void UBlueprintVariableNodeSpawner::Prime()
|
|
{
|
|
// we expect that you don't need a node template to construct menu entries
|
|
// from this, so we choose not to pre-cache one here
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
FBlueprintNodeSignature UBlueprintVariableNodeSpawner::GetSpawnerSignature() const
|
|
{
|
|
FBlueprintNodeSignature SpawnerSignature(NodeClass);
|
|
if (IsLocalVariable())
|
|
{
|
|
SpawnerSignature.AddSubObject(LocalVarOuter);
|
|
static const FName LocalVarSignatureKey(TEXT("LocalVarName"));
|
|
SpawnerSignature.AddNamedValue(LocalVarSignatureKey, LocalVarDesc.VarName.ToString());
|
|
}
|
|
|
|
return SpawnerSignature;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
FBlueprintActionUiSpec UBlueprintVariableNodeSpawner::GetUiSpec(FBlueprintActionContext const& Context, FBindingSet const& Bindings) const
|
|
{
|
|
UEdGraph* TargetGraph = (Context.Graphs.Num() > 0) ? Context.Graphs[0] : nullptr;
|
|
FBlueprintActionUiSpec MenuSignature = PrimeDefaultUiSpec(TargetGraph);
|
|
|
|
if (UProperty const* WrappedVariable = GetVarProperty())
|
|
{
|
|
checkSlow(Context.Blueprints.Num() > 0);
|
|
UBlueprint const* TargetBlueprint = Context.Blueprints[0];
|
|
|
|
// @TODO: this is duplicated in a couple places, move it to some shared resource
|
|
UClass const* TargetClass = (TargetBlueprint->GeneratedClass != nullptr) ? TargetBlueprint->GeneratedClass : TargetBlueprint->ParentClass;
|
|
for (UEdGraphPin* Pin : Context.Pins)
|
|
{
|
|
if ((Pin->PinType.PinCategory == UEdGraphSchema_K2::PC_Object) &&
|
|
Pin->PinType.PinSubCategoryObject.IsValid())
|
|
{
|
|
TargetClass = CastChecked<UClass>(Pin->PinType.PinSubCategoryObject.Get());
|
|
}
|
|
}
|
|
|
|
UClass const* VariableClass = WrappedVariable->GetOwnerClass()->GetAuthoritativeClass();
|
|
if (!TargetClass->IsChildOf(VariableClass))
|
|
{
|
|
MenuSignature.Category = FEditorCategoryUtils::BuildCategoryString(FCommonEditorCategory::Class,
|
|
FText::FromString(VariableClass->GetDisplayNameText().ToString()));
|
|
}
|
|
}
|
|
DynamicUiSignatureGetter.ExecuteIfBound(Context, Bindings, &MenuSignature);
|
|
return MenuSignature;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
UEdGraphNode* UBlueprintVariableNodeSpawner::Invoke(UEdGraph* ParentGraph, FBindingSet const& Bindings, FVector2D const Location) const
|
|
{
|
|
UEdGraphNode* NewNode = nullptr;
|
|
// @TODO: consider splitting out local variable spawners (since they don't
|
|
// conform to UBlueprintFieldNodeSpawner
|
|
if (IsLocalVariable())
|
|
{
|
|
auto LocalVarSetupLambda = [](UEdGraphNode* NewNode, bool bIsTemplateNode, FName VarName, UObject const* VarOuter, FGuid VarGuid, FCustomizeNodeDelegate UserDelegate)
|
|
{
|
|
UK2Node_Variable* VarNode = CastChecked<UK2Node_Variable>(NewNode);
|
|
VarNode->VariableReference.SetLocalMember(VarName, VarOuter->GetName(), VarGuid);
|
|
UserDelegate.ExecuteIfBound(NewNode, bIsTemplateNode);
|
|
};
|
|
|
|
FCustomizeNodeDelegate PostSpawnDelegate = CustomizeNodeDelegate;
|
|
if (UObject const* LocalVarOuter = GetVarOuter())
|
|
{
|
|
PostSpawnDelegate = FCustomizeNodeDelegate::CreateStatic(LocalVarSetupLambda, LocalVarDesc.VarName, LocalVarOuter, LocalVarDesc.VarGuid, CustomizeNodeDelegate);
|
|
}
|
|
|
|
NewNode = UBlueprintNodeSpawner::SpawnNode(NodeClass, ParentGraph, Bindings, Location, PostSpawnDelegate);
|
|
}
|
|
else
|
|
{
|
|
NewNode = Super::Invoke(ParentGraph, Bindings, Location);
|
|
}
|
|
|
|
return NewNode;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
bool UBlueprintVariableNodeSpawner::IsLocalVariable() const
|
|
{
|
|
return (LocalVarDesc.VarName != NAME_None);
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
UObject const* UBlueprintVariableNodeSpawner::GetVarOuter() const
|
|
{
|
|
UObject const* VarOuter = nullptr;
|
|
if (IsLocalVariable())
|
|
{
|
|
VarOuter = LocalVarOuter;
|
|
}
|
|
else if (UProperty const* MemberVariable = GetVarProperty())
|
|
{
|
|
VarOuter = MemberVariable->GetOuter();
|
|
}
|
|
return VarOuter;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
UProperty const* UBlueprintVariableNodeSpawner::GetVarProperty() const
|
|
{
|
|
// Get() does IsValid() checks for us
|
|
return Cast<UProperty>(GetField());
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
FEdGraphPinType UBlueprintVariableNodeSpawner::GetVarType() const
|
|
{
|
|
FEdGraphPinType VarType;
|
|
if (IsLocalVariable())
|
|
{
|
|
VarType = LocalVarDesc.VarType;
|
|
}
|
|
else if (UProperty const* VarProperty = GetVarProperty())
|
|
{
|
|
UEdGraphSchema_K2 const* K2Schema = GetDefault<UEdGraphSchema_K2>();
|
|
K2Schema->ConvertPropertyToPinType(VarProperty, VarType);
|
|
}
|
|
return VarType;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
FText UBlueprintVariableNodeSpawner::GetVariableName() const
|
|
{
|
|
FText VarName;
|
|
|
|
bool bShowFriendlyNames = GetDefault<UEditorStyleSettings>()->bShowFriendlyNames;
|
|
if (IsLocalVariable())
|
|
{
|
|
VarName = bShowFriendlyNames ? FText::FromString(LocalVarDesc.FriendlyName) : FText::FromName(LocalVarDesc.VarName);
|
|
}
|
|
else if (UProperty const* MemberVariable = GetVarProperty())
|
|
{
|
|
VarName = bShowFriendlyNames ? FText::FromString(UEditorEngine::GetFriendlyName(MemberVariable)) : FText::FromName(MemberVariable->GetFName());
|
|
}
|
|
return VarName;
|
|
}
|
|
|
|
#undef LOCTEXT_NAMESPACE
|