Unity开发者联盟收藏本站
发帖教程新人必读切换到宽版

 找回密码
 立即注册
Unity开发者联盟»论坛 › 3D Dev Asset 开发资源大全 › 学术研究 Scholarly › 《调教UE5：编纂器拓展指南》自定义数据类型 ...
返回列表 发新帖
查看: 190|回复: 0

《调教UE5：编纂器拓展指南》自定义数据类型

[复制链接]
发表于 2024-7-15 18:09 | 显示全部楼层 |阅读模式
《调教UE5》系列记录的是笔者在开发UE引擎中总结的些许经验。文中所有不雅概念和结论仅代表个人见解，作为自学笔记和日后反思之参考，亦可能存在谬误或过时之处。如有讹夺和不妥，恳请多加斧正。
<hr/><hr/>目录
不成忽略的事前筹备 ~♡
ㅤ创建 CustomDataType 模块
ㅤ创建 CustomDataTypeEditor 模块
自定义数据类型 ~♡
ㅤ新建数据类型
ㅤFactory
ㅤAssetTypeActions
为自定义数据类型构建编纂器 ~♡
导入和导出 ~♡
ㅤ导入为自定义资产类型
ㅤ重导入自定义资产类型
ㅤ导出自定义资产类型
<hr/>\large\textbf{珍贵的不是倡议誓言的决心，} \\ \large\textbf{而是恪守誓言的行为。} \\
<hr/>本章将探索自定义数据类型的方式。
本章中使用的案例原型来自 Creating a Custom Asset Type with its own Editor in C++ ，笔者仅在此基础长进行了些许学习探讨，有兴趣的读者也可前往原文阅读。
不成忽略的事前筹备 ~♡

在正式开始之前，我们需要筹备两个新模块：一个“CustomDataType”运行时模块（Runtime）和一个“CustomDataTypeEditor”编纂器模块（Editor）。运行时模块存放自定义数据类型，编纂器模块则负责存放所有与操作自定义数据类型相关的部门，诸如创建、改削和导入导出等行为。



在名为“ExtendEditor”的项目中组织如下的文件布局。



创建 CustomDataType 模块

新建“CustomDataType”模块中的文件必要文件。
  1. // Source/CustomDataType/CustomDataType.Build.cs
  3. using UnrealBuildTool;
  5. public class CustomDataType : ModuleRules
  6. {
  7.         public CustomDataType(ReadOnlyTargetRules Target) : base(Target)
  8.         {
  9.                 PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
  10.        
  11.                 PublicDependencyModuleNames.AddRange(new string[]
  12.                 {
  13.                         ”Core”,
  14.                         ”CoreUObject”,
  15.                         ”Engine”,
  16.                         ”InputCore”,
  17.                 });
  19.                 PrivateDependencyModuleNames.AddRange(new string[] { });
  20.         }
  21. }
复制代码
  1. // Source/CustomDataType/Public/CustomDataType.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Modules/ModuleManager.h”
  8. class FCustomDataTypeModule : public IModuleInterface
  9. {
  10. public:
  12.         virtual void StartupModule() override;
  13.         virtual void ShutdownModule() override;
  14. };
复制代码
  1. // Source/CustomDataType/Private/CustomDataType.cpp
  3. #pragma once
  5. #include ”CustomDataType.h”
  7. IMPLEMENT_MODULE(FCustomDataTypeModule, CustomDataType)
  10. void FCustomDataTypeModule::StartupModule()
  11. {
  12.         IModuleInterface::StartupModule();
  13. }
  15. void FCustomDataTypeModule::ShutdownModule()
  16. {
  17.         IModuleInterface::ShutdownModule();
  18. }
复制代码
将“CustomDataType”模块添加到项目依赖中。
  1. // Source/ExtendEditor.Target.cs
  3. using UnrealBuildTool;
  4. using System.Collections.Generic;
  6. public class ExtendEditorTarget : TargetRules
  7. {
  8.         public ExtendEditorTarget( TargetInfo Target) : base(Target)
  9.         {
  10.                 Type = TargetType.Game;
  11.                 DefaultBuildSettings = BuildSettingsVersion.V2;
  12.                 ExtraModuleNames.AddRange( new string[] { ”ExtendEditor”, ”CustomDataType” } );
  13.         }
  14. }
复制代码
  1. // Source/ExtendEditor.uproject
  3. {
  4.         ”FileVersion”: 3,
  5.         ”EngineAssociation”: ”5.0”,
  6.         ”Category”: ””,
  7.         ”Description”: ””,
  8.         ”Modules”: [
  9.                 {
  10.                         ”Name”: ”ExtendEditor”,
  11.                         ”Type”: ”Runtime”,
  12.                         ”LoadingPhase”: ”Default”
  13.                         ]
  14.                 },
  15.                 {
  16.                         ”Name”: ”CustomDataType”,
  17.                         ”Type”: ”Runtime”,
  18.                         ”LoadingPhase”: ”Default”
  19.                 }
  20.         ]
  21. }
复制代码

创建 CustomDataTypeEditor 模块

新建“CustomDataTypeEditor”模块中的文件必要文件。
  1. // Source/CustomDataTypeEditor/CustomDataTypeEditor.Build.cs
  3. using UnrealBuildTool;
  5. public class CustomDataTypeEditor : ModuleRules
  6. {
  7.         public CustomDataTypeEditor(ReadOnlyTargetRules Target) : base(Target)
  8.         {
  9.                 PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
  10.        
  11.                 PublicDependencyModuleNames.AddRange(new string[]
  12.                 {
  13.                         ”Core”,
  14.                         ”CoreUObject”,
  15.                         ”Engine”,
  16.                         ”InputCore”,
  17.                         ”CustomDataType”,
  18.                 });
  20.                 PrivateDependencyModuleNames.AddRange(new string[] { });
  21.         }
  22. }
复制代码
  1. // Source/CustomDataTypeEditor/Public/CustomDataTypeEditor.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Modules/ModuleManager.h”
  8. class FCustomDataTypeEditorModule : public IModuleInterface
  9. {
  10. public:
  12.         virtual void StartupModule() override;
  13.         virtual void ShutdownModule() override;
  14. };
复制代码
  1. // Source/CustomDataTypeEditor/Private/CustomDataTypeEditor.cpp
  3. #pragma once
  5. #include ”CustomDataTypeEditor.h”
  7. IMPLEMENT_MODULE(FCustomDataTypeEditorModule, CustomDataTypeEditor)
  9. void FCustomDataTypeEditorModule::StartupModule()
  10. {
  11.         IModuleInterface::StartupModule();
  12. }
  14. void FCustomDataTypeEditorModule::ShutdownModule()
  15. {
  16.         IModuleInterface::ShutdownModule();
  17. }
复制代码
将“CustomDataTypeEditor”模块添加到项目依赖中。
  1. // Source/ExtendEditorEditor.Target.cs
  3. using UnrealBuildTool;
  4. using System.Collections.Generic;
  6. public class ExtendEditorEditorTarget : TargetRules
  7. {
  8.         public ExtendEditorEditorTarget( TargetInfo Target) : base(Target)
  9.         {
  10.                 Type = TargetType.Editor;
  11.                 DefaultBuildSettings = BuildSettingsVersion.V2;
  12.                 ExtraModuleNames.AddRange( new string[]
  13.                 {
  14.                         ”ExtendEditor”,
  15.                         ”CustomDataType”,
  16.                         ”CustomDataTypeEditor”
  17.                 } );
  18.         }
  19. }
复制代码
  1. // Source/ExtendEditor.uproject
  3. {
  4.         ”FileVersion”: 3,
  5.         ”EngineAssociation”: ”5.0”,
  6.         ”Category”: ””,
  7.         ”Description”: ””,
  8.         ”Modules”: [
  9.                 {
  10.                         ”Name”: ”ExtendEditor”,
  11.                         ”Type”: ”Runtime”,
  12.                         ”LoadingPhase”: ”Default”
  13.                 },
  14.                 {
  15.                         ”Name”: ”CustomDataType”,
  16.                         ”Type”: ”Runtime”,
  17.                         ”LoadingPhase”: ”Default”
  18.                 },
  19.                 {
  20.                         ”Name”: ”CustomDataTypeEditor”,
  21.                         ”Type”: ”Editor”,
  22.                         ”LoadingPhase”: ”Default”
  23.                 }
  24.         ]
  25. }
复制代码

{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

自定义数据类型 ~♡

要在 UE5 中添加一个可在 ContentBrowser 中进行基本操作的自定义数据类型，一共需要三样内容：

  • 自定义的数据类型
  • 与该数据类型关联的 Factory
  • 与该数据类型关联的 AssetTypeActions



新建数据类型

首先来新建自定义数据类型，我们将新的数据类型定名为“UCustomNormalDistribution”，担任自 UObject。这个数据类型用于描述一个正态分布，并有一个函数用于给出符合该正态分布的随机值。



在 CustomDataType 文件夹下新建文件“CustomNormalDistribution.h”和“CustomNormalDistribution.cpp”。

  1. // CustomNormalDistribution.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include <random>
  7. #include ”CustomNormalDistribution.generated.h”
  9. UCLASS(BlueprintType)
  10. class CUSTOMDATATYPE_API UCustomNormalDistribution : public UObject
  11. {
  12.         GENERATED_BODY()
  13.        
  14. public:
  15.         UCustomNormalDistribution();
  17.         UFUNCTION(BlueprintCallable)
  18.         float DrawSample();
  20.         UFUNCTION(CallInEditor)
  21.         void LogSample();
  23. public:
  24.         UPROPERTY(EditAnywhere)
  25.         float Mean;
  27.         UPROPERTY(EditAnywhere)
  28.         float StandardDeviation;
  30. private:
  31.         std::mt19937 RandomNumberGenerator;
  32. };
复制代码
  1. // CustomNormalDistribution.cpp
  3. #pragma once
  5. #include ”CustomNormalDistribution.h”
  7. UCustomNormalDistribution::UCustomNormalDistribution()
  8.         : Mean(0.5f)
  9.         , StandardDeviation(0.2f)
  10. {}
  12. float UCustomNormalDistribution::DrawSample()
  13. {
  14.         return std::normal_distribution<>(Mean, StandardDeviation)(RandomNumberGenerator);
  15. }
  17. void UCustomNormalDistribution::LogSample()
  18. {
  19.         UE_LOG(LogTemp, Log, TEXT(”%f”), DrawSample())
  20. }
复制代码

{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

Factory

UFactory 是一个工厂类，用于创建和导入新对象。它是一个抽象类，不能直接实例化，它的子类必需实现 FactoryCreateNew 函数，以便在 ContentBrowser 中创建资产。
可以理解为 UFactory 定义了资源创建的方式，除了必需实现的 FactoryCreateNew 函数，还可以通过定义内部变量或覆写虚函数的方式来自定义相关的法则。



UFactory 内部变量



UFactory 部门函数

为 UCustomNormalDistribution 创建相关的 Factory，我们将它定名为“UCustomNormalDistributionFactory”，担任自 UFactory。



在 CustomDataTypeEditor 文件夹下新建文件“CustomNormalDistributionFactory.h”和“CustomNormalDistributionFactory.cpp”。



在 UCustomNormalDistributionFactory 的构造函数中将工厂与 UCustomNormalDistribution 绑定，并允许其创建新资产的行为。
  1. // CustomNormalDistributionFactory.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Factories/Factory.h”
  7. #include ”CustomNormalDistributionFactory.generated.h”
  9. UCLASS()
  10. class UCustomNormalDistributionFactory : public UFactory
  11. {
  12.         GENERATED_BODY()
  13. public:
  14.         UCustomNormalDistributionFactory();
  15.         virtual UObject* FactoryCreateNew(UClass* Class, UObject* InParent, FName Name, EObjectFlags Flags, UObject* Context, FFeedbackContext* Warn) override;
  16. };
复制代码
  1. // CustomNormalDistributionFactory.cpp
  3. #include ”CustomNormalDistributionFactory.h”
  4. #include ”CustomNormalDistribution.h”
  6. UCustomNormalDistributionFactory::UCustomNormalDistributionFactory()
  7. {
  8.         SupportedClass = UCustomNormalDistribution::StaticClass();
  9.         bCreateNew = true;
  10. }
  12. UObject* UCustomNormalDistributionFactory::FactoryCreateNew(UClass* Class, UObject* InParent, FName Name, EObjectFlags Flags, UObject* Context, FFeedbackContext* Warn)
  13. {
  14.         return NewObject<UCustomNormalDistribution>(InParent, Class, Name, Flags, Context);
  15. }
复制代码
  1. // CustomDataTypeEditor.Build.cs
  3. using UnrealBuildTool;
  5. public class CustomDataTypeEditor : ModuleRules
  6. {
  7.         public CustomDataTypeEditor(ReadOnlyTargetRules Target) : base(Target)
  8.         {
  9.                 PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
  10.        
  11.                 PublicDependencyModuleNames.AddRange(new string[]
  12.                 {
  13.                         ”Core”,
  14.                         ”CoreUObject”,
  15.                         ”Engine”,
  16.                         ”InputCore”,
  17.                         ”CustomDataType”,
  18.                         ”UnrealEd”,
  19.                 });
  21.                 PrivateDependencyModuleNames.AddRange(new string[] { });
  22.         }
  23. }
复制代码
{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

AssetTypeActions

FAssetTypeActions_Base 是所有 AssetTypeActions 的基类，提供有关特定资产类型的操作和其他信息。它是可选的，但一般默认需要提供，否则无法完成诸如双击打开资产编纂器等操作。
当编纂器在 ContentBrowser 中措置资产操作（创建资产、双击打开编纂资源等）时，会搜寻是否有对应的 AssetTypeActionsClass 被注册。
AssetTypeActions 中有各种与资产操作以及资产信息显示有关的虚函数，我们可以通过覆写它们来自定义资产操作的行为和资产显示方式。



FAssetTypeActions_Base 部门函数

为 UCustomNormalDistribution 创建相关的 AssetTypeActions，我们将它定名为“FCustomNormalDistributionActions”，担任自 FAssetTypeActions_Base。



在 CustomDataTypeEditor 文件夹下新建文件“CustomNormalDistributionActions.h”和“CustomNormalDistributionActions.cpp”。



我们通过 FCustomNormalDistributionActions 自定义在 ContentBrowser 中使用右键菜单创建 UCustomNormalDistribution 时的颜色和友好显示名称。而且我们为 UCustomNormalDistribution  这个特定资产类型的右键菜单里添加一个“Custom Action”按钮。稍后，我们将注册一个单独的 Category 供从右键菜单创建 UCustomNormalDistribution 时使用。
  1. // CustomNormalDistributionActions.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”AssetTypeActions_Base.h”
  8. class FCustomNormalDistributionActions : public FAssetTypeActions_Base
  9. {
  10. public:
  11.         FCustomNormalDistributionActions(EAssetTypeCategories::Type InAssetCategory);
  12.        
  13.         virtual UClass* GetSupportedClass() const override;
  14.         virtual FText GetName() const override;
  15.         virtual FColor GetTypeColor() const override;
  16.         virtual uint32 GetCategories() override;
  17.        
  18.         virtual void GetActions(const TArray<UObject*>& InObjects, FMenuBuilder& MenuBuilder) override;
  19.         virtual bool HasActions(const TArray<UObject*>& InObjects) const override;
  21. private:
  23.         EAssetTypeCategories::Type AssetCategory;
  24. };
复制代码
  1. // CustomNormalDistributionActions.cpp
  3. #include ”CustomNormalDistributionActions.h”
  4. #include ”CustomNormalDistribution.h”
  7. FCustomNormalDistributionActions::FCustomNormalDistributionActions(EAssetTypeCategories::Type InAssetCategory)
  8.         : AssetCategory(InAssetCategory)
  9. {
  10. }
  12. UClass* FCustomNormalDistributionActions::GetSupportedClass() const
  13. {
  14.         return UCustomNormalDistribution::StaticClass();
  15. }
  17. FText FCustomNormalDistributionActions::GetName() const
  18. {
  19.         return INVTEXT(”Custom Normal Distribution”);
  20. }
  22. FColor FCustomNormalDistributionActions::GetTypeColor() const
  23. {
  24.         return FColor::Orange;
  25. }
  27. uint32 FCustomNormalDistributionActions::GetCategories()
  28. {
  29.         return AssetCategory;
  30. }
  32. void FCustomNormalDistributionActions::GetActions(const TArray<UObject*>& InObjects, FMenuBuilder& MenuBuilder)
  33. {
  34.         FAssetTypeActions_Base::GetActions(InObjects, MenuBuilder);
  35.        
  36.         MenuBuilder.AddMenuEntry(
  37.                 FText::FromString(”Custom Action”),
  38.                 FText::FromString(”This is a custom action”),
  39.                 FSlateIcon(),
  40.                 FUIAction()
  41.                 );
  43. }
  45. // HasActions() 必需返回 true 以使 GetActions() 有效
  46. bool FCustomNormalDistributionActions::HasActions(const TArray<UObject*>& InObjects) const
  47. {
  48.         return true;
  49. }
复制代码
在 CustomDataTypeEditor 模块启动时注册 FCustomNormalDistributionActions。
  1. // CustomDataTypeEditor.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Modules/ModuleManager.h”
  7. #include ”CustomNormalDistributionActions.h”
  9. class FCustomDataTypeEditorModule : public IModuleInterface
  10. {
  11. public:
  13.         /** IModuleInterface implementation */
  14.         virtual void StartupModule() override;
  15.         virtual void ShutdownModule() override;
  17. private:
  18.         // 记录注册的 AssetTypeActions 以供模块停用时卸载
  19.         TSharedPtr<FCustomNormalDistributionActions> CustomNormalDistributionActions;
  20. };
复制代码
  1. // CustomDataTypeEditor.cpp
  3. #pragma once
  5. #include ”CustomDataTypeEditor.h”
  7. #include ”AssetToolsModule.h”
  8. #include ”AssetTypeCategories.h”
  10. IMPLEMENT_MODULE(FCustomDataTypeEditorModule, CustomDataTypeEditor)
  12. void FCustomDataTypeEditorModule::StartupModule()
  13. {
  14.         // 注册新的 Category
  15.         EAssetTypeCategories::Type Category =
  16.                 FAssetToolsModule::GetModule().Get().RegisterAdvancedAssetCategory(
  17.                         FName(TEXT(”Example”)), FText::FromString(”Example”));
  18.         // 注册 AssetTypeActions
  19.         CustomNormalDistributionActions = MakeShared<FCustomNormalDistributionActions>(Category);
  20.         FAssetToolsModule::GetModule().Get().RegisterAssetTypeActions(
  21.                 CustomNormalDistributionActions.ToSharedRef());
  22. }
  24. void FCustomDataTypeEditorModule::ShutdownModule()
  25. {
  26.         if (FModuleManager::Get().IsModuleLoaded(”AssetTools”))
  27.         {
  28.                 FAssetToolsModule::GetModule().Get().UnregisterAssetTypeActions(
  29.                         CustomNormalDistributionActions.ToSharedRef());
  30.         }
  31. }
复制代码
  1. // CustomDataTypeEditor.Build.cs
  3. using UnrealBuildTool;
  5. public class CustomDataTypeEditor : ModuleRules
  6. {
  7.         public CustomDataTypeEditor(ReadOnlyTargetRules Target) : base(Target)
  8.         {
  9.                 PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
  10.        
  11.                 PublicDependencyModuleNames.AddRange(new string[]
  12.                 {
  13.                         ”Core”,
  14.                         ”CoreUObject”,
  15.                         ”Engine”,
  16.                         ”InputCore”,
  17.                         ”CustomDataType”,
  18.                         ”UnrealEd”,
  19.                         ”AssetTools”,
  20.                 });
  22.                 PrivateDependencyModuleNames.AddRange(new string[] { });
  23.         }
  24. }
复制代码
编译并重启编纂器，我们可以通过右键菜单创建新的 UCustomNormalDistribution 资产，在该资产上单击右键，会看到右键菜单里添加了一个 Custom Action 按钮。





{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

为自定义数据类型构建编纂器 ~♡



双击资产打开编纂器这个操作的入口在 UAssetEditorSubsystem::OpenEditorForAsset()，我们可以顺藤摸瓜来寻找合适的介入时机。



当 UAssetEditorSubsystem::OpenEditorForAsset() 开始执行时，会调用 IAssetTypeActions 中的 OpenAssetEditor() 虚函数，这时如果没有提供任何子类的重写，则会默认打开一个 SimpleAssetEditor，查看得知，FSimpleAssetEditor 是一个担任自 FAssetEditorToolkit 的类。
因此我们要做的就是在本身的 AssetTypeActions 中重写 OpenAssetEditor()，然后用它调用自定义的 FAssetEditorToolkit 类，来打开本身的编纂器。我们假设将这个 FAssetEditorToolkit 类定名为“FCustomNormalDistributionEditorToolkit”。于是这个流程变成了如下这样。



当我们双击打开一个 UObject 时，这个 UObject 将以输入参数的形式逐级传递，并最终抵达 InitEditor()。
InitEditor() 负责规划窗口布局并调用 FAssetEditorToolkit::InitAssetEditor()。RegisterTabSpawners() 向规划好的布局中填充内容。这是我们需要存眷的两个重点函数。
每个 AssetEditor 都有本身的 TabSpawners，而每个 AssetEditor 都是在运行时动态创建的。因此每次打开一个新的 AssetEditor 时，都需要从头注册 TabSpawners。

弄清楚道理后就好操作了。首先在 CustomNormalDistributionActions 中重写 OpenAssetEditor()。
这里暂时忽略 OpenAssetEditor() 的 EditWithinLevelEditor 输入，只传递 InObjects 输入。而且假设接下来的 FCustomNormalDistributionEditorToolkit 里的入口函数为 InitEditor()。
  1. // CustomNormalDistributionActions.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”AssetTypeActions_Base.h”
  8. class FCustomNormalDistributionActions : public FAssetTypeActions_Base
  9. {
  10. public:
  11.         ...
  13.         virtual void OpenAssetEditor(const TArray<UObject*>& InObjects, TSharedPtr<class IToolkitHost> EditWithinLevelEditor) override;
  14. };
复制代码
  1. // CustomNormalDistributionActions.cpp
  3. #include ”CustomNormalDistributionEditorToolkit.h”
  5. void FCustomNormalDistributionActions::OpenAssetEditor(const TArray<UObject*>& InObjects,
  6.         TSharedPtr<IToolkitHost> EditWithinLevelEditor)
  7. {
  8.         MakeShared<FCustomNormalDistributionEditorToolkit>()->InitEditor(InObjects);
  9. }
复制代码
然后在 CustomDayaTypeEditor 模块下新建 FCustomNormalDistributionEditorToolkit 类。
RegisterTabSpawners() 和 UnregisterTabSpawners() 是关键函数。如前所述，我们在 InitEditor() 创建布局，并在 RegisterTabSpawners() 中注册 TabSpawners。
我们提前假设了已经存在一个 SCustomNormalDistributionWidget 小部件类，我们在稍后很快会来创建它。


  1. // CustomNormalDistributionEditorToolkit.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”CustomNormalDistribution.h”
  7. #include ”Toolkits/AssetEditorToolkit.h”
  9. class FCustomNormalDistributionEditorToolkit : public FAssetEditorToolkit
  10. {
  11. public:
  12.         // 外部调用的入口，它可以是任意名字，可以具有任意参数。
  13.         void InitEditor(const TArray<UObject*>& InObjects);
  15.         // 必需实现的虚函数
  16.         virtual void RegisterTabSpawners(const TSharedRef<class FTabManager>& TabManager) override;
  17.         virtual void UnregisterTabSpawners(const TSharedRef<class FTabManager>& TabManager) override;
  18.         virtual FName GetToolkitFName() const override { return ”CustomNormalDistributionEditor”; }
  19.         virtual FText GetBaseToolkitName() const override { return INVTEXT(”Custom Normal Distribution Editor”); }
  20.         virtual FString GetWorldCentricTabPrefix() const override { return ”Custom Normal Distribution”; }
  21.         virtual FLinearColor GetWorldCentricTabColorScale() const override { return {}; }
  23.         float GetMean() const;
  24.         float GetStandardDeviation() const;
  25.         void SetMean(float Mean);
  26.         void SetStandardDeviation(float StandardDeviation);
  27.        
  28. private:
  29.        
  30.         UCustomNormalDistribution* NormalDistribution = nullptr;
  31. };
复制代码
  1. // CustomNormalDistributionEditorToolkit.cpp
  3. #pragma once
  5. #include ”CustomNormalDistributionEditorToolkit.h”
  6. #include ”Widgets/Docking/SDockTab.h”
  7. #include ”SCustomNormalDistributionWidget.h”
  8. #include ”Modules/ModuleManager.h”
  10. void FCustomNormalDistributionEditorToolkit::InitEditor(const TArray<UObject*>& InObjects)
  11. {
  12.         NormalDistribution = Cast<UCustomNormalDistribution>(InObjects[0]);
  14.         const TSharedRef<FTabManager::FLayout> Layout =
  15.                 FTabManager::NewLayout(”CustomNormalDistributionEditorLayout”)
  16.                 ->AddArea
  17.                 (
  18.                         FTabManager::NewPrimaryArea()->SetOrientation(Orient_Vertical)
  19.                         ->Split
  20.                         (
  21.                                 FTabManager::NewSplitter()
  22.                                 ->SetSizeCoefficient(0.6f)
  23.                                 ->SetOrientation(Orient_Horizontal)
  24.                                 ->Split
  25.                                 (
  26.                                         FTabManager::NewStack()
  27.                                         ->SetSizeCoefficient(0.8f)
  28.                                         ->AddTab(”CustomNormalDistributionPDFTab”, ETabState::OpenedTab)
  29.                                 )
  30.                                 ->Split
  31.                                 (
  32.                                         FTabManager::NewStack()
  33.                                         ->SetSizeCoefficient(0.2f)
  34.                                         ->AddTab(”CustomNormalDistributionDetailsTab”, ETabState::OpenedTab)
  35.                                 )
  36.                         )
  37.                         ->Split
  38.                         (
  39.                                 FTabManager::NewStack()
  40.                                 ->SetSizeCoefficient(0.4f)
  41.                                 ->AddTab(”OutputLog”, ETabState::OpenedTab)
  42.                         )
  43.                 );
  45.         FAssetEditorToolkit::InitAssetEditor(EToolkitMode::Standalone, {}, ”CustomNormalDistributionEditor”, Layout, true, true, InObjects);
  46. }
  48. void FCustomNormalDistributionEditorToolkit::RegisterTabSpawners(const TSharedRef<class FTabManager>& InTabManager)
  49. {
  50.         FAssetEditorToolkit::RegisterTabSpawners(InTabManager);
  52.         WorkspaceMenuCategory =
  53.                 InTabManager->AddLocalWorkspaceMenuCategory(INVTEXT(”CustomNormalDistributionTabs”));
  55.         // 注册 SCustomNormalDistributionWidget TabSpawner
  56.         InTabManager->RegisterTabSpawner(”CustomNormalDistributionPDFTab”,
  57.                 FOnSpawnTab::CreateLambda([=](const FSpawnTabArgs&)
  58.                 {
  59.                         return SNew(SDockTab)
  60.                         [
  61.                                 SNew(SCustomNormalDistributionWidget)
  62.                                 .Mean(this, &FCustomNormalDistributionEditorToolkit::GetMean)
  63.                                 .StandardDeviation(this, &FCustomNormalDistributionEditorToolkit::GetStandardDeviation)
  64.                                 .OnMeanChanged(this, &FCustomNormalDistributionEditorToolkit::SetMean)
  65.                                 .OnStandardDeviationChanged(this, &FCustomNormalDistributionEditorToolkit::SetStandardDeviation)
  66.                         ];
  67.                 }))
  68.         .SetDisplayName(INVTEXT(”PDF”))
  69.         .SetGroup(WorkspaceMenuCategory.ToSharedRef());
  71.         // 创建 CustomNormalDistribution DetailsView
  72.         FPropertyEditorModule& PropertyEditorModule =
  73.                 FModuleManager::GetModuleChecked<FPropertyEditorModule>(”PropertyEditor”);
  74.         FDetailsViewArgs DetailsViewArgs;
  75.         DetailsViewArgs.NameAreaSettings = FDetailsViewArgs::HideNameArea;
  76.         TSharedRef<IDetailsView> DetailsView = PropertyEditorModule.CreateDetailView(DetailsViewArgs);
  77.         DetailsView->SetObjects(TArray<UObject*>{ NormalDistribution });
  79.         // 注册 CustomNormalDistribution DetailsView TabSpawner
  80.         InTabManager->RegisterTabSpawner(”CustomNormalDistributionDetailsTab”,
  81.                 FOnSpawnTab::CreateLambda([=](const FSpawnTabArgs&)
  82.                 {
  83.                         return SNew(SDockTab)
  84.                         [
  85.                                 DetailsView
  86.                         ];
  87.                 }))
  88.         .SetDisplayName(INVTEXT(”Details”))
  89.         .SetGroup(WorkspaceMenuCategory.ToSharedRef());
  90. }
  92. void FCustomNormalDistributionEditorToolkit::UnregisterTabSpawners(const TSharedRef<class FTabManager>& InTabManager)
  93. {
  94.         FAssetEditorToolkit::UnregisterTabSpawners(InTabManager);
  95.         InTabManager->UnregisterTabSpawner(”CustomNormalDistributionPDFTab”);
  96.         InTabManager->UnregisterTabSpawner(”CustomNormalDistributionDetailsTab”);
  97. }
  99. float FCustomNormalDistributionEditorToolkit::GetMean() const
  100. {
  101.         return NormalDistribution->Mean;
  102. }
  104. float FCustomNormalDistributionEditorToolkit::GetStandardDeviation() const
  105. {
  106.         return NormalDistribution->StandardDeviation;
  107. }
  109. void FCustomNormalDistributionEditorToolkit::SetMean(float Mean)
  110. {
  111.         NormalDistribution->Modify();
  112.         NormalDistribution->Mean = Mean;
  113. }
  115. void FCustomNormalDistributionEditorToolkit::SetStandardDeviation(float StandardDeviation)
  116. {
  117.         NormalDistribution->Modify();
  118.         NormalDistribution->StandardDeviation = StandardDeviation;
  119. }
复制代码
继续在 CustomDayaTypeEditor 模块下新建 SCustomNormalDistributionWidget 小部件类。
向 UCustomNormalDistribution 传递数据的逻辑位于 OnMouseMove() 中。OnPaint() 读取 UCustomNormalDistribution 中的数据并按照读取到的数据绘制由512个点组成的线段图形。


  1. // SCustomNormalDistributionWidget.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Widgets/SLeafWidget.h”
  8. DECLARE_DELEGATE_OneParam(FOnMeanChanged, float /*NewMean*/)
  9. DECLARE_DELEGATE_OneParam(FOnStandardDeviationChanged, float /*NewStandardDeviation*/)
  11. class SCustomNormalDistributionWidget : public SLeafWidget
  12. {
  13. public:
  14.        
  15.         SLATE_BEGIN_ARGS(SCustomNormalDistributionWidget)
  16.                 : _Mean(0.5f)
  17.                 , _StandardDeviation(0.2f)
  18.         {}
  19.        
  20.         SLATE_ATTRIBUTE(float, Mean)
  21.         SLATE_ATTRIBUTE(float, StandardDeviation)
  22.         SLATE_EVENT(FOnMeanChanged, OnMeanChanged)
  23.         SLATE_EVENT(FOnStandardDeviationChanged, OnStandardDeviationChanged)
  24.        
  25.         SLATE_END_ARGS()
  27. public:
  28.        
  29.         void Construct(const FArguments& InArgs);
  31.         virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
  32.         virtual FVector2D ComputeDesiredSize(float) const override;
  34.         virtual FReply OnMouseButtonDown(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent) override;
  35.         virtual FReply OnMouseButtonUp(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent) override;
  36.         virtual FReply OnMouseMove(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent) override;
  38. private:
  39.        
  40.         TAttribute<float> Mean;
  41.         TAttribute<float> StandardDeviation;
  43.         FOnMeanChanged OnMeanChanged;
  44.         FOnStandardDeviationChanged OnStandardDeviationChanged;
  46.         FTransform2D GetPointsTransform(const FGeometry& AllottedGeometry) const;
  47. };
复制代码
  1. // SCustomNormalDistributionWidget.cpp
  3. #pragma once
  5. #include ”SCustomNormalDistributionWidget.h”
  7. void SCustomNormalDistributionWidget::Construct(const FArguments& InArgs)
  8. {
  9.     Mean = InArgs._Mean;
  10.     StandardDeviation = InArgs._StandardDeviation;
  11.     OnMeanChanged = InArgs._OnMeanChanged;
  12.     OnStandardDeviationChanged = InArgs._OnStandardDeviationChanged;
  13. }
  15. int32 SCustomNormalDistributionWidget::OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const
  16. {
  17.     const int32 NumPoints = 512;
  18.     TArray<FVector2D> Points;
  19.     Points.Reserve(NumPoints);
  20.     const FTransform2D PointsTransform = GetPointsTransform(AllottedGeometry);
  21.     for (int32 PointIndex = 0; PointIndex < NumPoints; ++PointIndex)
  22.     {
  23.         const float X = PointIndex / (NumPoints - 1.0);
  24.         const float D = (X - Mean.Get()) / StandardDeviation.Get();
  25.         const float Y = FMath::Exp(-0.5f * D * D);
  26.         Points.Add(PointsTransform.TransformPoint(FVector2D(X, Y)));
  27.     }
  28.     FSlateDrawElement::MakeLines(OutDrawElements, LayerId, AllottedGeometry.ToPaintGeometry(), Points);
  29.     return LayerId;
  30. }
  32. FVector2D SCustomNormalDistributionWidget::ComputeDesiredSize(float) const
  33. {
  34.     return FVector2D(200.0, 200.0);
  35. }
  37. FReply SCustomNormalDistributionWidget::OnMouseButtonDown(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent)
  38. {
  39.     if (GEditor && GEditor->CanTransact() && ensure(!GIsTransacting))
  40.         GEditor->BeginTransaction(TEXT(””), INVTEXT(”Edit Normal Distribution”), nullptr);
  41.     return FReply::Handled().CaptureMouse(SharedThis(this));
  42. }
  44. FReply SCustomNormalDistributionWidget::OnMouseButtonUp(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent)
  45. {
  46.     if (GEditor) GEditor->EndTransaction();
  47.     return FReply::Handled().ReleaseMouseCapture();
  48. }
  50. FReply SCustomNormalDistributionWidget::OnMouseMove(const FGeometry& AllottedGeometry, const FPointerEvent& MouseEvent)
  51. {
  52.     if (!HasMouseCapture()) return FReply::Unhandled();
  53.     const FTransform2D PointsTransform = GetPointsTransform(AllottedGeometry);
  54.     const FVector2D LocalPosition = AllottedGeometry.AbsoluteToLocal(MouseEvent.GetScreenSpacePosition());
  55.     const FVector2D NormalizedPosition = PointsTransform.Inverse().TransformPoint(LocalPosition);
  56.     if (OnMeanChanged.IsBound())
  57.         OnMeanChanged.Execute(NormalizedPosition.X);
  58.     if (OnStandardDeviationChanged.IsBound())
  59.         OnStandardDeviationChanged.Execute(FMath::Max(0.025f, FMath::Lerp(0.025f, 0.25f, NormalizedPosition.Y)));
  60.     return FReply::Handled();
  61. }
  63. FTransform2D SCustomNormalDistributionWidget::GetPointsTransform(const FGeometry& AllottedGeometry) const
  64. {
  65.     const double Margin = 0.05 * AllottedGeometry.GetLocalSize().GetMin();
  66.     const FScale2D Scale((AllottedGeometry.GetLocalSize() - 2.0 * Margin) * FVector2D(1.0, -1.0));
  67.     const FVector2D Translation(Margin, AllottedGeometry.GetLocalSize().Y - Margin);
  68.     return FTransform2D(Scale, Translation);
  69. }
复制代码
  1. // CustomDataTpeEditor.Build.cs
  3. using UnrealBuildTool;
  5. public class CustomDataTypeEditor : ModuleRules
  6. {
  7.         public CustomDataTypeEditor(ReadOnlyTargetRules Target) : base(Target)
  8.         {
  9.                 PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
  10.        
  11.                 PublicDependencyModuleNames.AddRange(new string[]
  12.                 {
  13.                         ”Core”,
  14.                         ”CoreUObject”,
  15.                         ”Engine”,
  16.                         ”InputCore”,
  17.                         ”CustomDataType”,
  18.                         ”UnrealEd”,
  19.                         ”AssetTools”,
  20.                         ”Slate”,
  21.                         ”SlateCore”,
  22.                 });
  24.                 PrivateDependencyModuleNames.AddRange(new string[] { });
  25.         }
  26. }
复制代码
编译并重启编纂器，创建一个 UCustomNormalDistribution 资产，双击打开编纂器。



{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

导入和导出 ~♡

导入为自定义资产类型

探索发现，新建和导入的功能似乎无法同时存在于一个工厂里，概念上确实讲得通。如果有读者知道如何让他们共存的方式，欢迎奉告我。
为了能够实现导入的功能，我们需要增加一个新的工厂。


从文件导入

先来到 CustomNormalDistribution.h 里，添加一个路径变量，这个变量用于记录数据的导入来源。
  1. // CustomNormalDistribution.h
  3. UCLASS(BlueprintType)
  4. class CUSTOMDATATYPE_API UCustomNormalDistribution : public UObject
  5. {
  6.         GENERATED_BODY()
  7.        
  8. public:
  9.         UCustomNormalDistribution();
  11.         UFUNCTION(BlueprintCallable)
  12.         float DrawSample();
  14.         UFUNCTION(CallInEditor)
  15.         void LogSample();
  17. public:
  18.         UPROPERTY(EditAnywhere)
  19.         float Mean;
  21.         UPROPERTY(EditAnywhere)
  22.         float StandardDeviation;
  24. // 新增部门
  25. #if WITH_EDITORONLY_DATA
  26.         UPROPERTY(VisibleAnywhere)
  27.         FString SourceFilePath;
  28. #endif
  30. private:
  31.         std::mt19937 RandomNumberGenerator;
  32. };
复制代码
然后创建新工厂。在 CustomDataTypeEditor 文件夹下创建“CustomNormalDistributionImportFactory.h”和“CustomNormalDistributionImportFactory.cpp”。



我们需要重写虚函数 FactoryCreateText() 和 FactoryCanImport()，GetValueFromFile() 是一个辅助函数，辅佐我们从文件读取参数。
  1. // CustomNormalDistributionImportFactory.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Factories/Factory.h”
  7. #include ”CustomNormalDistributionImportFactory.generated.h”
  9. UCLASS()
  10. class UCustomNormalDistributionImportFactory : public UFactory
  11. {
  12.         GENERATED_BODY()
  13. public:
  14.         UCustomNormalDistributionImportFactory();
  16.         virtual UObject* FactoryCreateText(UClass* InClass, UObject* InParent, FName InName, EObjectFlags Flags, UObject* Context, const TCHAR* Type, const TCHAR*& Buffer, const TCHAR* BufferEnd, FFeedbackContext* Warn) override;
  17.         virtual bool FactoryCanImport(const FString& Filename) override;
  19.         FString GetValueFromFile(const TCHAR*& Buffer, FString SectionName, FString VarName);
  20. };
复制代码
首先，我们需要在构造函数里设定 UCustomNormalDistributionImportFactory 的行为。我们添加一个可导入的后缀名 .cnd，并在 FactoryCanImport() 中进行判断。我们假设数据的文件格式与 .ini 文件类似，它具有一些 Section，每个 Section 下有名称分歧的参数，且 Section 之间可能具有同名参数，就像这样：



这样的好处是，由于我们使用了与 .ini 文件同样的格式，我们可以使用 ConfigCacheIni.h 中的现有的功能来读取文件。当然也可以替换为任意的自定义法则。
  1. // CustomNormalDistributionImportFactory.cpp
  3. #include ”CustomNormalDistributionImportFactory.h”
  4. #include ”CustomNormalDistribution.h”
  5. #include ”EditorFramework/AssetImportData.h”
  6. // #include ”Misc/ConfigCacheIni.h”
  8. UCustomNormalDistributionImportFactory::UCustomNormalDistributionImportFactory()
  9. {
  10.         SupportedClass = UCustomNormalDistribution::StaticClass();
  12.         // 必需封锁可新建
  13.         // 添加可导入的文件名后缀
  14.         // 开启可导入
  15.         // 导入的文件格式为 Text（另一种格式为二进制）
  16.         bCreateNew = false;
  17.         Formats.Add(TEXT(”cnd;Custom Normal Distribution”));
  18.         bEditorImport = true;
  19.         bText = true;
  20. }
  22. UObject* UCustomNormalDistributionImportFactory::FactoryCreateText(UClass* InClass, UObject* InParent, FName InName,
  23.         EObjectFlags Flags, UObject* Context, const TCHAR* Type, const TCHAR*& Buffer, const TCHAR* BufferEnd,
  24.         FFeedbackContext* Warn)
  25. {
  27.         GEditor->GetEditorSubsystem<UImportSubsystem>()->OnAssetPreImport.Broadcast(this, InClass, InParent, InName, Type);
  29.         // 查抄传入的类型和后缀名
  30.         if (InClass != UCustomNormalDistribution::StaticClass()
  31.                 || FCString::Stricmp(Type, TEXT(”cnd”)) != 0) return nullptr;
  33.         UCustomNormalDistribution* Data = CastChecked<UCustomNormalDistribution>(
  34.                 NewObject<UCustomNormalDistribution>(InParent, InName, Flags));
  36.         // 从文件获取值
  37.         Data->Mean = FCString::Atof(*GetValueFromFile(Buffer, ”[MySection]”, ”Mean”));
  38.         Data->StandardDeviation = FCString::Atof(*GetValueFromFile(Buffer, ”[MySection]”, ”StandardDeviation”));
  40.         // 从文件获取值的另一种方式。我们特意将文件内容的书写格式与.ini相似，所以也可以借用.ini方式措置。
  41.         // FConfigCacheIni Config(EConfigCacheType::Temporary);
  42.         // Config.LoadFile(CurrentFilename);
  43.         // Config.GetFloat(TEXT(”MySection”), TEXT(”Mean”), Data->Mean, CurrentFilename);
  44.         // Config.GetFloat(TEXT(”MySection”), TEXT(”StandardDeviation”), Data->StandardDeviation, CurrentFilename);
  46.         // 储存导入的路径
  47.         Data->SourceFilePath = UAssetImportData::SanitizeImportFilename(CurrentFilename, Data->GetPackage());
  49.         GEditor->GetEditorSubsystem<UImportSubsystem>()->OnAssetPostImport.Broadcast(this, Data);
  50.        
  51.         return Data;
  52. }
  54. bool UCustomNormalDistributionImportFactory::FactoryCanImport(const FString& Filename)
  55. {
  56.         return FPaths::GetExtension(Filename).Equals(TEXT(”cnd”));
  57. }
  59. FString UCustomNormalDistributionImportFactory::GetValueFromFile(const TCHAR*& Buffer, FString SectionName, FString VarName)
  60. {
  61.         FString Str(Buffer);
  63.         Str = Str.Replace(TEXT(”\r”), TEXT(””));
  64.        
  65.         TArray<FString> Lines;
  66.         Str.ParseIntoArray(Lines, TEXT(”\n”), true);
  67.        
  68.         bool bInSection = false;
  69.        
  70.         for (FString Line : Lines)
  71.         {
  72.                 if (Line == SectionName)
  73.                 {
  74.                         bInSection = true;
  75.                 }
  76.                 else if (Line.StartsWith(”[”) && Line.EndsWith(”]”))
  77.                 {
  78.                         bInSection = false;
  79.                 }
  81.                 if (bInSection)
  82.                 {
  83.                         int32 Pos = Line.Find(”=”);
  84.                         if (Pos != INDEX_NONE)
  85.                         {
  86.                                 FString Name = Line.Left(Pos);
  87.                                 FString Value = Line.Mid(Pos + 1);
  89.                                 if (Name == VarName)
  90.                                 {
  91.                                         return Value;
  92.                                 }
  93.                         }
  94.                 }
  95.         }
  96.        
  97.         return ””;
  98. }
复制代码
编译并重启编纂器，拖拽我们的文件到 ContentBrowser 或使用面板上的导入按钮，此刻就可以导入本身的 .cnd 文件了。



TODO：导入时对话框



{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

重导入自定义资产类型

重导入需要实现三个虚函数：CanReimport()，SetReimportPaths() 和 Reimport()。我们可以将重导入的逻辑写在之前的 UCustomNormalDistributionImportFactory 工厂里。



来到 CustomNormalDistributionImportFactory.h 拓展 UCustomNormalDistributionImportFactory 工厂类。
  1. // CustomNormalDistributionImportFactory.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Factories/Factory.h”
  7. #include ”EditorReimportHandler.h” // 新增头文件
  8. #include ”CustomNormalDistributionImportFactory.generated.h”
  10. UCLASS()
  11. class UCustomNormalDistributionImportFactory : public UFactory, public FReimportHandler
  12. {
  13.         GENERATED_BODY()
  14. public:
  15.         UCustomNormalDistributionImportFactory();
  17.         virtual UObject* FactoryCreateText(UClass* InClass, UObject* InParent, FName InName, EObjectFlags Flags, UObject* Context, const TCHAR* Type, const TCHAR*& Buffer, const TCHAR* BufferEnd, FFeedbackContext* Warn) override;
  18.         virtual bool FactoryCanImport(const FString& Filename) override;
  20.         FString GetValueFromFile(const TCHAR*& Buffer, FString SectionName, FString VarName);
  22.         // 新增 Reimporter 虚函数实现
  23.         virtual bool CanReimport(UObject* Obj, TArray<FString>& OutFilenames) override;
  24.         virtual void SetReimportPaths(UObject* Obj, const TArray<FString>& NewReimportPaths) override;
  25.         virtual EReimportResult::Type Reimport(UObject* Obj) override;
  26. };
复制代码
与导入文件分歧，重导入时我们要使用辅助类 FileHelper 来本身读取文件内容。
  1. // CustomNormalDistributionImportFactory.cpp
  3. #include ”Misc/FileHelper.h”
  5. bool UCustomNormalDistributionImportFactory::CanReimport(UObject* Obj, TArray<FString>& OutFilenames)
  6. {
  7.         UCustomNormalDistribution* Data = Cast<UCustomNormalDistribution>(Obj);
  8.         if (Data)
  9.         {
  10.                 OutFilenames.Add(UAssetImportData::ResolveImportFilename(
  11.                         Data->SourceFilePath, Data->GetPackage()));
  12.                 return true;
  13.         }
  14.         return false;
  15. }
  17. void UCustomNormalDistributionImportFactory::SetReimportPaths(UObject* Obj, const TArray<FString>& NewReimportPaths)
  18. {
  19.         UCustomNormalDistribution* Data = Cast<UCustomNormalDistribution>(Obj);
  20.         if (Data && ensure(NewReimportPaths.Num() == 1))
  21.         {
  22.                 Data->SourceFilePath =
  23.                         UAssetImportData::SanitizeImportFilename(NewReimportPaths[0], Data->GetPackage());
  24.         }
  25. }
  27. EReimportResult::Type UCustomNormalDistributionImportFactory::Reimport(UObject* Obj)
  28. {
  29.         UCustomNormalDistribution* Data = Cast<UCustomNormalDistribution>(Obj);
  30.         if (!Data)
  31.         {
  32.                 return EReimportResult::Failed;
  33.         }
  35.         const FString Filename =
  36.                 UAssetImportData::ResolveImportFilename(Data->SourceFilePath, Data->GetPackage());
  37.         if (!FPaths::GetExtension(Filename).Equals(TEXT(”cnd”)))
  38.         {
  39.                 return EReimportResult::Failed;
  40.         }
  42.         CurrentFilename = Filename;
  43.         FString LoadedData;
  44.         if (FFileHelper::LoadFileToString(LoadedData, *CurrentFilename))
  45.         {
  46.                 const TCHAR* LoadedDataChar = *LoadedData;
  47.                 Data->Modify();
  48.                 Data->MarkPackageDirty();
  50.                 Data->Mean = FCString::Atof(*GetValueFromFile(LoadedDataChar, ”[MySection]”, ”Mean”));
  51.                 Data->StandardDeviation =
  52.                         FCString::Atof(*GetValueFromFile(LoadedDataChar, ”[MySection]”, ”StandardDeviation”));
  54.                 Data->SourceFilePath =
  55.                         UAssetImportData::SanitizeImportFilename(CurrentFilename, Data->GetPackage());
  56.         }
  58.         return EReimportResult::Succeeded;
  59. }
复制代码
然后我们给 UCustomNormalDistribution 资产的右键菜单添加一个“Reimport”按钮，调用 UCustomNormalDistributionImportFactory::Reimport。来到 UCustomNormalDistributionActions.h 中添加如下函数。
  1. // UCustomNormalDistributionActions.h
  3. class FCustomNormalDistributionActions : public FAssetTypeActions_Base
  4. {
  5. public:
  6.         ...
  7.         void ExecuteReimport(TArray<TWeakObjectPtr<class UCustomNormalDistribution>> Objects);
  9. ...
  10. };
复制代码
实现 ExecuteReimport()。
  1. // UCustomNormalDistributionActions.cpp
  3. #include ”EditorReimportHandler.h”
  5. void FCustomNormalDistributionActions::ExecuteReimport(TArray<TWeakObjectPtr<UCustomNormalDistribution>> Objects)
  6. {
  7.         for (auto ObjIt = Objects.CreateConstIterator(); ObjIt; ++ObjIt)
  8.         {
  9.                 auto Object = (*ObjIt).Get();
  10.                 if (Object)
  11.                 {
  12.                         FReimportManager::Instance()->Reimport(Object, /*bAskForNewFileIfMissing=*/true);
  13.                 }
  14.         }
  15. }
复制代码
编译并重启编纂器，导入一个 .cnd 文件资产，就可以通过右键菜单中的 Reimport 进行重导入了。

TODO：从新文件重导入资产



{♡☘♡☘♡  \quad今天的捉弄结束了 \quad ♡☘♡☘♡}\\

导出自定义资产类型

我们可以担任一个 UExporter 类，来定义自定义数据类型的导出操作。



在 CustomDataTypeEditor 文件夹下新建“CustomNormalDistributionExporter.h”和“CustomNormalDistributionExporter.cpp”文件。



与 UFactory 类似，我们需要在构造函数中设定 UCustomNormalDistributionExporter 的行为，并重写 SupportsObject() 和 ExportText() 两个虚函数。
此处使用 ExportText()，因为我们但愿直接将数据保留为 .cnd 文件，如果要保留为二进制，则可以使用 ExportBinary()。
  1. // CustomNormalDistributionExporter.h
  3. #pragma once
  5. #include ”CoreMinimal.h”
  6. #include ”Exporters/Exporter.h”
  7. #include ”CustomNormalDistributionExporter.generated.h”
  9. UCLASS()
  10. class UCustomNormalDistributionExporter : public UExporter
  11. {
  12.         GENERATED_BODY()
  13.        
  14. public:
  16.         UCustomNormalDistributionExporter();
  17.        
  18.         virtual bool SupportsObject(UObject* Object) const override;
  19.         virtual bool ExportText(const FExportObjectInnerContext* Context, UObject* Object, const TCHAR* Type, FOutputDevice& Ar, FFeedbackContext* Warn, uint32 PortFlags) override;
  20.        
  21. };
复制代码
要使用 ExportText()，则需要将 bText 设置为 true，否则默认不会调用 ExportText() 而是 ExportBinary()。
  1. // CustomNormalDistributionExporter.cpp
  3. #pragma once
  5. #include ”CustomNormalDistributionExporter.h”
  6. #include ”CustomNormalDistribution.h”
  8. UCustomNormalDistributionExporter::UCustomNormalDistributionExporter()
  9. {
  10.         SupportedClass = UCustomNormalDistribution::StaticClass();
  11.         PreferredFormatIndex = 0;
  12.         FormatExtension.Add(TEXT(”cnd”));
  13.         FormatDescription.Add(TEXT(”Custom Normal Distribution”));
  14.         bText = true;
  15. }
  17. bool UCustomNormalDistributionExporter::SupportsObject(UObject* Object) const
  18. {
  19.         return (SupportedClass && Object->IsA(SupportedClass));
  20. }
  22. bool UCustomNormalDistributionExporter::ExportText(const FExportObjectInnerContext* Context, UObject* Object,
  23.         const TCHAR* Type, FOutputDevice& Ar, FFeedbackContext* Warn, uint32 PortFlags)
  24. {
  25.         UCustomNormalDistribution* Data = Cast<UCustomNormalDistribution>(Object);
  27.         if (!Data)
  28.         {
  29.                 return false;
  30.         }
  31.        
  32.         // 输出内容
  33.         Ar.Log(TEXT(”[MySection]\r\n”));
  34.         Ar.Logf(TEXT(”Mean=%f\r\n”), Data->Mean);
  35.         Ar.Logf(TEXT(”StandardDeviation=%f”), Data->StandardDeviation);
  36.        
  37.         return true;
  38. }
复制代码
此刻编译并重启编纂器，任意改削一个 UCustomNormalDistribution 资产，并导出，可以看到它被正确导出到磁盘了。



本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

×
回复

使用道具 举报

返回列表 发新帖
懒得打字嘛，点击右侧快捷回复 【右侧内容，后台自定义】
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

小黑屋|手机版|Unity开发者联盟 ( 粤ICP备20003399号 )

GMT+8, 2024-11-21 21:57 , Processed in 0.130438 second(s), 27 queries .

Powered by Discuz! X3.5 Licensed

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表