You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
1e2186b0c0
#jira UE-145358 #rb daren.cheng #preflight 6246f521323cb7b991207585 [CL 19588048 by Patrick Boutot in ue5-main branch]
381 lines
16 KiB
C++
381 lines
16 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "UMGEditorModule.h"
|
|
#include "Modules/ModuleManager.h"
|
|
#include "UObject/UObjectHash.h"
|
|
#include "Editor.h"
|
|
|
|
#include "Blueprint/UserWidget.h"
|
|
#include "Blueprint/WidgetBlueprintGeneratedClass.h"
|
|
#include "Settings/WidgetDesignerSettings.h"
|
|
#include "WidgetBlueprint.h"
|
|
#include "Animation/WidgetAnimation.h"
|
|
#include "EdGraphUtilities.h"
|
|
#include "Graph/GraphFunctionDetailsCustomization.h"
|
|
#include "Graph/UMGGraphPanelPinFactory.h"
|
|
#include "Graph/GraphVariableDetailsCustomization.h"
|
|
|
|
#include "AssetToolsModule.h"
|
|
#include "IAssetTypeActions.h"
|
|
#include "AssetTypeActions_SlateVectorArtData.h"
|
|
#include "AssetTypeActions_WidgetBlueprint.h"
|
|
#include "AssetTypeActions_WidgetBlueprintGeneratedClass.h"
|
|
#include "KismetCompilerModule.h"
|
|
#include "WidgetBlueprintCompiler.h"
|
|
|
|
#include "ISequencerModule.h"
|
|
#include "Animation/MarginTrackEditor.h"
|
|
#include "Animation/Sequencer2DTransformTrackEditor.h"
|
|
#include "Animation/WidgetMaterialTrackEditor.h"
|
|
#include "Animation/MovieSceneSequenceEditor_WidgetAnimation.h"
|
|
#include "IUMGModule.h"
|
|
#include "Designer/DesignerCommands.h"
|
|
#include "Navigation/SWidgetDesignerNavigation.h"
|
|
|
|
#include "ClassIconFinder.h"
|
|
|
|
#include "UMGEditorProjectSettings.h"
|
|
#include "ISettingsModule.h"
|
|
#include "SequencerSettings.h"
|
|
|
|
#include "BlueprintEditorModule.h"
|
|
#include "PropertyEditorModule.h"
|
|
#include "DynamicEntryBoxDetails.h"
|
|
#include "ListViewBaseDetails.h"
|
|
#include "WidgetBlueprintThumbnailRenderer.h"
|
|
#include "WidgetThumbnailCustomization.h"
|
|
|
|
#define LOCTEXT_NAMESPACE "UMG"
|
|
|
|
const FName UMGEditorAppIdentifier = FName(TEXT("UMGEditorApp"));
|
|
static TAutoConsoleVariable<bool> CVarThumbnailRenderEnable(
|
|
TEXT("UMG.ThumbnailRenderer.Enable"),
|
|
true,
|
|
TEXT("Option to enable/disable thumbnail rendering.")
|
|
);
|
|
|
|
class FUMGEditorModule : public IUMGEditorModule, public FGCObject
|
|
{
|
|
public:
|
|
/** Constructor, set up console commands and variables **/
|
|
FUMGEditorModule()
|
|
: Settings(nullptr)
|
|
, bThumbnailRenderersRegistered(false)
|
|
, bOnPostEngineInitHandled(false)
|
|
{
|
|
}
|
|
|
|
/** Called right after the module DLL has been loaded and the module object has been created */
|
|
virtual void StartupModule() override
|
|
{
|
|
FModuleManager::LoadModuleChecked<IUMGModule>("UMG");
|
|
|
|
// Any attempt to use GEditor right now will fail as it hasn't been initialized yet. Waiting for post engine init resolves that.
|
|
FCoreDelegates::OnPostEngineInit.AddRaw(this, &FUMGEditorModule::OnPostEngineInit);
|
|
|
|
if (GIsEditor)
|
|
{
|
|
FDesignerCommands::Register();
|
|
}
|
|
|
|
MenuExtensibilityManager = MakeShared<FExtensibilityManager>();
|
|
ToolBarExtensibilityManager = MakeShared<FExtensibilityManager>();
|
|
DesignerExtensibilityManager = MakeShared<FDesignerExtensibilityManager>();
|
|
|
|
DesignerExtensibilityManager->AddDesignerExtensionFactory(SWidgetDesignerNavigation::MakeDesignerExtension());
|
|
|
|
PropertyBindingExtensibilityManager = MakeShared<FPropertyBindingExtensibilityManager>();
|
|
|
|
// Register widget blueprint compiler we do this no matter what.
|
|
IKismetCompilerInterface& KismetCompilerModule = FModuleManager::LoadModuleChecked<IKismetCompilerInterface>("KismetCompiler");
|
|
KismetCompilerModule.GetCompilers().Add(&WidgetBlueprintCompiler);
|
|
|
|
// Add Customization for variable in Graph editor
|
|
if (FBlueprintEditorModule* BlueprintEditorModule = FModuleManager::GetModulePtr<FBlueprintEditorModule>("Kismet"))
|
|
{
|
|
BlueprintVariableCustomizationHandle = BlueprintEditorModule->RegisterVariableCustomization(FProperty::StaticClass(), FOnGetVariableCustomizationInstance::CreateStatic(&FGraphVariableDetailsCustomization::MakeInstance));
|
|
BlueprintFunctionCustomizationHandle = BlueprintEditorModule->RegisterFunctionCustomization(UK2Node_FunctionEntry::StaticClass(), FOnGetFunctionCustomizationInstance::CreateStatic(&FGraphFunctionDetailsCustomization::MakeInstance));
|
|
}
|
|
else
|
|
{
|
|
ModuleChangedHandle = FModuleManager::Get().OnModulesChanged().AddRaw(this, &FUMGEditorModule::HandleModuleChanged);
|
|
}
|
|
|
|
// Register asset types
|
|
IAssetTools& AssetTools = FModuleManager::LoadModuleChecked<FAssetToolsModule>("AssetTools").Get();
|
|
RegisterAssetTypeAction(AssetTools, MakeShareable(new FAssetTypeActions_SlateVectorArtData()));
|
|
RegisterAssetTypeAction(AssetTools, MakeShareable(new FAssetTypeActions_WidgetBlueprint()));
|
|
RegisterAssetTypeAction(AssetTools, MakeShareable(new FAssetTypeActions_WidgetBlueprintGeneratedClass()));
|
|
|
|
FKismetCompilerContext::RegisterCompilerForBP(UWidgetBlueprint::StaticClass(), &UWidgetBlueprint::GetCompilerForWidgetBP );
|
|
|
|
// Register with the sequencer module that we provide auto-key handlers.
|
|
ISequencerModule& SequencerModule = FModuleManager::Get().LoadModuleChecked<ISequencerModule>("Sequencer");
|
|
SequenceEditorHandle = SequencerModule.RegisterSequenceEditor(UWidgetAnimation::StaticClass(), MakeUnique<FMovieSceneSequenceEditor_WidgetAnimation>());
|
|
MarginTrackEditorCreateTrackEditorHandle = SequencerModule.RegisterPropertyTrackEditor<FMarginTrackEditor>();
|
|
TransformTrackEditorCreateTrackEditorHandle = SequencerModule.RegisterPropertyTrackEditor<F2DTransformTrackEditor>();
|
|
WidgetMaterialTrackEditorCreateTrackEditorHandle = SequencerModule.RegisterTrackEditor(FOnCreateTrackEditor::CreateStatic(&FWidgetMaterialTrackEditor::CreateTrackEditor));
|
|
|
|
RegisterSettings();
|
|
|
|
// Class detail customizations
|
|
FPropertyEditorModule& PropertyModule = FModuleManager::GetModuleChecked<FPropertyEditorModule>(TEXT("PropertyEditor"));
|
|
PropertyModule.RegisterCustomClassLayout(TEXT("DynamicEntryBoxBase"), FOnGetDetailCustomizationInstance::CreateStatic(&FDynamicEntryBoxBaseDetails::MakeInstance));
|
|
PropertyModule.RegisterCustomClassLayout(TEXT("DynamicEntryBox"), FOnGetDetailCustomizationInstance::CreateStatic(&FDynamicEntryBoxDetails::MakeInstance));
|
|
PropertyModule.RegisterCustomClassLayout(TEXT("ListViewBase"), FOnGetDetailCustomizationInstance::CreateStatic(&FListViewBaseDetails::MakeInstance));
|
|
PropertyModule.RegisterCustomClassLayout(TEXT("WidgetBlueprint"), FOnGetDetailCustomizationInstance::CreateStatic(&FWidgetThumbnailCustomization::MakeInstance));
|
|
|
|
GraphPanelPinFactory = MakeShared<FUMGGraphPanelPinFactory>();
|
|
FEdGraphUtilities::RegisterVisualPinFactory(GraphPanelPinFactory);
|
|
|
|
CVarThumbnailRenderEnable->AsVariable()->SetOnChangedCallback(FConsoleVariableDelegate::CreateStatic(&FUMGEditorModule::ThumbnailRenderingEnabled));
|
|
}
|
|
|
|
/** Called before the module is unloaded, right before the module object is destroyed. */
|
|
virtual void ShutdownModule() override
|
|
{
|
|
FCoreDelegates::OnPostEngineInit.RemoveAll(this);
|
|
FModuleManager::Get().OnModulesChanged().Remove(ModuleChangedHandle);
|
|
|
|
if (UObjectInitialized() && bThumbnailRenderersRegistered && IConsoleManager::Get().FindConsoleVariable(TEXT("UMGEditor.ThumbnailRenderer.Enable"))->GetBool())
|
|
{
|
|
UThumbnailManager::Get().UnregisterCustomRenderer(UWidgetBlueprint::StaticClass());
|
|
}
|
|
|
|
MenuExtensibilityManager.Reset();
|
|
ToolBarExtensibilityManager.Reset();
|
|
|
|
if (IKismetCompilerInterface* KismetCompilerModule = FModuleManager::GetModulePtr<IKismetCompilerInterface>("KismetCompiler"))
|
|
{
|
|
KismetCompilerModule->GetCompilers().Remove(&WidgetBlueprintCompiler);
|
|
}
|
|
|
|
// Remove Customization for variable in Graph editor
|
|
if (BlueprintVariableCustomizationHandle.IsValid() || BlueprintFunctionCustomizationHandle.IsValid())
|
|
{
|
|
if (FBlueprintEditorModule* BlueprintEditorModule = FModuleManager::GetModulePtr<FBlueprintEditorModule>("Kismet"))
|
|
{
|
|
BlueprintEditorModule->UnregisterVariableCustomization(FProperty::StaticClass(), BlueprintVariableCustomizationHandle);
|
|
BlueprintEditorModule->UnregisterFunctionCustomization(UK2Node_FunctionEntry::StaticClass(), BlueprintFunctionCustomizationHandle);
|
|
}
|
|
}
|
|
|
|
// Unregister all the asset types that we registered
|
|
if ( FModuleManager::Get().IsModuleLoaded("AssetTools") )
|
|
{
|
|
IAssetTools& AssetTools = FModuleManager::GetModuleChecked<FAssetToolsModule>("AssetTools").Get();
|
|
for ( int32 Index = 0; Index < CreatedAssetTypeActions.Num(); ++Index )
|
|
{
|
|
AssetTools.UnregisterAssetTypeActions(CreatedAssetTypeActions[Index].ToSharedRef());
|
|
}
|
|
}
|
|
CreatedAssetTypeActions.Empty();
|
|
|
|
// Unregister sequencer track creation delegates
|
|
ISequencerModule* SequencerModule = FModuleManager::GetModulePtr<ISequencerModule>( "Sequencer" );
|
|
if ( SequencerModule != nullptr )
|
|
{
|
|
SequencerModule->UnregisterSequenceEditor(SequenceEditorHandle);
|
|
|
|
SequencerModule->UnRegisterTrackEditor( MarginTrackEditorCreateTrackEditorHandle );
|
|
SequencerModule->UnRegisterTrackEditor( TransformTrackEditorCreateTrackEditorHandle );
|
|
SequencerModule->UnRegisterTrackEditor( WidgetMaterialTrackEditorCreateTrackEditorHandle );
|
|
}
|
|
|
|
UnregisterSettings();
|
|
|
|
FPropertyEditorModule* PropertyModule = FModuleManager::GetModulePtr<FPropertyEditorModule>("PropertyEditor");
|
|
if (PropertyModule != nullptr)
|
|
{
|
|
PropertyModule->UnregisterCustomClassLayout(TEXT("DynamicEntryBoxBase"));
|
|
PropertyModule->UnregisterCustomClassLayout(TEXT("DynamicEntryBox"));
|
|
PropertyModule->UnregisterCustomClassLayout(TEXT("ListViewBase"));
|
|
PropertyModule->UnregisterCustomClassLayout(TEXT("WidgetBlueprint"));
|
|
}
|
|
|
|
if (UObjectInitialized() && !IsEngineExitRequested())
|
|
{
|
|
FEdGraphUtilities::UnregisterVisualPinFactory(GraphPanelPinFactory);
|
|
}
|
|
|
|
//// Unregister the setting
|
|
//ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings");
|
|
|
|
//if ( SettingsModule != nullptr )
|
|
//{
|
|
// SettingsModule->UnregisterSettings("Editor", "ContentEditors", "WidgetDesigner");
|
|
// SettingsModule->UnregisterSettings("Project", "Editor", "UMGEditor");
|
|
//}
|
|
}
|
|
|
|
/** Gets the extensibility managers for outside entities to extend gui page editor's menus and toolbars */
|
|
virtual TSharedPtr<FExtensibilityManager> GetMenuExtensibilityManager() override { return MenuExtensibilityManager; }
|
|
virtual TSharedPtr<FExtensibilityManager> GetToolBarExtensibilityManager() override { return ToolBarExtensibilityManager; }
|
|
virtual TSharedPtr<FDesignerExtensibilityManager> GetDesignerExtensibilityManager() override { return DesignerExtensibilityManager; }
|
|
virtual TSharedPtr<FPropertyBindingExtensibilityManager> GetPropertyBindingExtensibilityManager() override { return PropertyBindingExtensibilityManager; }
|
|
|
|
/** Register settings objects. */
|
|
void RegisterSettings()
|
|
{
|
|
ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings");
|
|
|
|
if (SettingsModule != nullptr)
|
|
{
|
|
Settings = USequencerSettingsContainer::GetOrCreate<USequencerSettings>(TEXT("UMGSequencerSettings"));
|
|
|
|
SettingsModule->RegisterSettings("Editor", "ContentEditors", "UMGSequencerSettings",
|
|
LOCTEXT("UMGSequencerSettingsSettingsName", "UMG Sequence Editor"),
|
|
LOCTEXT("UMGSequencerSettingsSettingsDescription", "Configure the look and feel of the UMG Sequence Editor."),
|
|
Settings);
|
|
}
|
|
}
|
|
|
|
/** Unregister settings objects. */
|
|
void UnregisterSettings()
|
|
{
|
|
ISettingsModule* SettingsModule = FModuleManager::GetModulePtr<ISettingsModule>("Settings");
|
|
|
|
if (SettingsModule != nullptr)
|
|
{
|
|
SettingsModule->UnregisterSettings("Editor", "ContentEditors", "UMGSequencerSettings");
|
|
}
|
|
}
|
|
|
|
/** FGCObject interface */
|
|
virtual void AddReferencedObjects( FReferenceCollector& Collector ) override
|
|
{
|
|
if (Settings)
|
|
{
|
|
Collector.AddReferencedObject(Settings);
|
|
}
|
|
}
|
|
|
|
virtual FString GetReferencerName() const override
|
|
{
|
|
return "UMGEditorModule";
|
|
}
|
|
|
|
virtual FWidgetBlueprintCompiler* GetRegisteredCompiler() override
|
|
{
|
|
return &WidgetBlueprintCompiler;
|
|
}
|
|
|
|
/** Register common tabs */
|
|
virtual FOnRegisterTabs& OnRegisterTabsForEditor() override
|
|
{
|
|
return RegisterTabsForEditor;
|
|
}
|
|
|
|
virtual void AddWidgetEditorToolbarExtender(FWidgetEditorToolbarExtender&& InToolbarExtender) override
|
|
{
|
|
WidgetEditorToolbarExtenders.Add(MoveTemp(InToolbarExtender));
|
|
}
|
|
|
|
virtual TArrayView<FWidgetEditorToolbarExtender> GetAllWidgetEditorToolbarExtenders() override
|
|
{
|
|
return WidgetEditorToolbarExtenders;
|
|
}
|
|
|
|
virtual FOnRegisterLayoutExtensions& OnRegisterLayoutExtensions() override
|
|
{
|
|
return RegisterLayoutExtensions;
|
|
}
|
|
|
|
private:
|
|
void RegisterAssetTypeAction(IAssetTools& AssetTools, TSharedRef<IAssetTypeActions> Action)
|
|
{
|
|
AssetTools.RegisterAssetTypeActions(Action);
|
|
CreatedAssetTypeActions.Add(Action);
|
|
}
|
|
|
|
void HandleModuleChanged(FName ModuleName, EModuleChangeReason ChangeReason)
|
|
{
|
|
const FName KismetModule = "Kismet";
|
|
if (ModuleName == KismetModule && ChangeReason == EModuleChangeReason::ModuleLoaded)
|
|
{
|
|
if (!BlueprintVariableCustomizationHandle.IsValid())
|
|
{
|
|
if (FBlueprintEditorModule* BlueprintEditorModule = FModuleManager::GetModulePtr<FBlueprintEditorModule>(KismetModule))
|
|
{
|
|
BlueprintVariableCustomizationHandle = BlueprintEditorModule->RegisterVariableCustomization(FProperty::StaticClass(), FOnGetVariableCustomizationInstance::CreateStatic(&FGraphVariableDetailsCustomization::MakeInstance));
|
|
BlueprintFunctionCustomizationHandle = BlueprintEditorModule->RegisterFunctionCustomization(UK2Node_FunctionEntry::StaticClass(), FOnGetFunctionCustomizationInstance::CreateStatic(&FGraphFunctionDetailsCustomization::MakeInstance));
|
|
}
|
|
}
|
|
FModuleManager::Get().OnModulesChanged().Remove(ModuleChangedHandle);
|
|
ModuleChangedHandle.Reset();
|
|
}
|
|
}
|
|
|
|
void OnPostEngineInit()
|
|
{
|
|
if (GIsEditor)
|
|
{
|
|
if (IConsoleManager::Get().FindConsoleVariable(TEXT("UMG.ThumbnailRenderer.Enable"))->GetBool())
|
|
{
|
|
UThumbnailManager::Get().RegisterCustomRenderer(UWidgetBlueprint::StaticClass(), UWidgetBlueprintThumbnailRenderer::StaticClass());
|
|
bThumbnailRenderersRegistered = true;
|
|
}
|
|
}
|
|
bOnPostEngineInitHandled = true;
|
|
}
|
|
|
|
static void ThumbnailRenderingEnabled(IConsoleVariable* Variable)
|
|
{
|
|
FUMGEditorModule* UMGEditorModule = FModuleManager::GetModulePtr<FUMGEditorModule>(TEXT("UMGEditor"));
|
|
if (UObjectInitialized() && UMGEditorModule && UMGEditorModule->bOnPostEngineInitHandled)
|
|
{
|
|
if (Variable->GetBool())
|
|
{
|
|
UThumbnailManager::Get().RegisterCustomRenderer(UWidgetBlueprint::StaticClass(), UWidgetBlueprintThumbnailRenderer::StaticClass());
|
|
}
|
|
else
|
|
{
|
|
UThumbnailManager::Get().UnregisterCustomRenderer(UWidgetBlueprint::StaticClass());
|
|
}
|
|
}
|
|
}
|
|
|
|
private:
|
|
TSharedPtr<FExtensibilityManager> MenuExtensibilityManager;
|
|
TSharedPtr<FExtensibilityManager> ToolBarExtensibilityManager;
|
|
TSharedPtr<FDesignerExtensibilityManager> DesignerExtensibilityManager;
|
|
TSharedPtr<FPropertyBindingExtensibilityManager> PropertyBindingExtensibilityManager;
|
|
TSharedPtr<FGraphPanelPinFactory> GraphPanelPinFactory;
|
|
|
|
FDelegateHandle SequenceEditorHandle;
|
|
FDelegateHandle MarginTrackEditorCreateTrackEditorHandle;
|
|
FDelegateHandle TransformTrackEditorCreateTrackEditorHandle;
|
|
FDelegateHandle WidgetMaterialTrackEditorCreateTrackEditorHandle;
|
|
|
|
/** All created asset type actions. Cached here so that we can unregister it during shutdown. */
|
|
TArray< TSharedPtr<IAssetTypeActions> > CreatedAssetTypeActions;
|
|
|
|
/** All toolbar extenders. Utilized by tool palette */
|
|
TArray<FWidgetEditorToolbarExtender> WidgetEditorToolbarExtenders;
|
|
|
|
USequencerSettings* Settings;
|
|
|
|
/** Compiler customization for Widgets */
|
|
FWidgetBlueprintCompiler WidgetBlueprintCompiler;
|
|
|
|
/** */
|
|
FOnRegisterTabs RegisterTabsForEditor;
|
|
|
|
/** Support layout extensions */
|
|
FOnRegisterLayoutExtensions RegisterLayoutExtensions;
|
|
|
|
/** Handle for the FModuleManager::OnModulesChanged */
|
|
FDelegateHandle ModuleChangedHandle;
|
|
/** Handle for FBlueprintEditorModule::RegisterVariableCustomization */
|
|
FDelegateHandle BlueprintVariableCustomizationHandle;
|
|
/** Handle for FBlueprintEditorModule::RegisterFunctionCustomization */
|
|
FDelegateHandle BlueprintFunctionCustomizationHandle;
|
|
|
|
bool bThumbnailRenderersRegistered;
|
|
bool bOnPostEngineInitHandled;
|
|
};
|
|
|
|
IMPLEMENT_MODULE(FUMGEditorModule, UMGEditor);
|
|
|
|
#undef LOCTEXT_NAMESPACE
|