Aery的UE4 C++游戏开发之旅（4）加载资源&建立对象

目录

• 资源的硬引用
  • 硬指针
  • FObjectFinder<T> / FClassFinder<T>
• 资源的软引用
  • FSoftObjectPaths、FStringAssetReference
  • TSoftObjectPtr<T>
• 同步加载资源
  • LoadObject/LoadClass
  • TryLoad/LoadSynchronous
• 异步加载资源
  • FStreamableManager.RequestAsyncLoad()
• 卸载资源
• 建立对象
  • 建立通常对象
  • 建立Actor派生类对象
  • 建立Component派生类对象
  • 建立蓝图对象
• 参考

在UE4中，项目中的全部资源都是存储在硬盘中，当须要用到资源时，则须要将其加载进入内存中使用。为了更好的表示（引用）资源，UE4提供了两种引用资源的方式——硬引用、软引用。

资源的硬引用

---

硬性引用，即对象 A 引用对象 B，并致使对象 B 在对象 A 加载时加载。通俗点说，硬引用所表示的资源在引用初始化时就加载进内存，所以硬引用的资源几乎不须要加载方法。

硬指针

引用资源的最简单方法是建立指针UProperty并为它指定一个类别，这种称为硬指针。
在UE4中，若是有一个硬UObject指针属性引用了一个资源（每每在蓝图上设置引用），则加载包含这个属性的对象（放在贴图中，或者从gameinfo等引用）时，就会加载这个资源。

UPROPERTY(EditDefaultsOnly, Category=Building)
USoundCue* ConstructionStartStinger;

FObjectFinder<T> / FClassFinder<T>

若须要用C++代码而非蓝图来设置引用，则每每须要FObjectFinder、FClassFinder。

#include "UObject/ConstructorHelpers.h" \\须要include的头文件

在UE4源码里面，FObjectFinder构造函数里经过调用LoadObject()来加载资源，而FClassFinder构造函数里调用的也是LoadObject()。

注意在使用它们的时候还得遵照以下规则：

• 只能在类的构造函数中使用，若是在普通的逻辑代码中嵌套这份代码，会引发整个编译器的crash。（实际上里面代码就有检查是否在构造函数里，不然crash）
• 其次，FObjectFinder/FClassFinder变量必须是static的，从而保证只有一份资源实例。

1. FObjectFinder<T>：通常用来加载非蓝图资源，好比StaticMesh、Material、SoundWave、ParticlesSystem、AnimSequence、SkeletalMesh等资源：

static ConstructorHelpers::FObjectFinder<UTexture2D> ObjectFinder(TEXT("Texture2D'/Game/Textures/tex1.tex1'"));
UTexture2D* Texture2D = ObjectFinder.Object;

1. FClassFinder<T>：通常用来加载蓝图资源并获取蓝图Class。这是由于若是C++要用蓝图建立对象，必须先获取蓝图的Class，而后再经过Class生成蓝图对象：

static ConstructorHelpers::FClassFinder<AActor> BPClassFinder(TEXT("/Game/Blueprints/MyBP"));
TSubclassOf<AActor> BPClass = BPClassFinder.Class;
...//利用Class生成蓝图对象

• FClassFinder的模版名不能直接写UBlueprint，例如：FClassFinder<UBlueprint>是错误的。建立蓝图时选择的是什么父类，则写对应的父类名，假如是Actor，那么要写成：FClassFinder<AActor>，不然没法加载成功。
• FClassFinder的模版名必须和TSubclassOf变量的模版名一致，固然也可以使用UClass*代替TSubclassOf<T>。实际上TSubclassOf<T>也是UClass*，只是更增强调这个Class是从T派生出来的。
• 在启动游戏时若报错提示找不到文件而崩溃（例如：Default property warnings and errors:Error: COD Constructor (MyGameMode): Failed to find /Game/MyProject/MyBP.MyBP）
  这是由于UE4资源路径的一个规范问题，解决办法有两种：
  1. 在copy reference出来的文件路径后面加_C，例如："Blueprint'/Game/Blueprints/MyBP.MyBP_C'"（_C能够理解为获取Class的意思）。
  2. 去掉路径前缀，例如："/Game/Blueprints/MyBP"

资源的软引用

---

软性引用，即对象 A 经过间接机制（例如字符串形式的对象路径）来引用对象 B。

硬引用的问题是在容易一开始就加载所有硬引用表示的资源，这可能致使资源载入时间过长。而软引用则是可随时灵活加载资源的一种引用，而不用硬性地一开始就加载。

FSoftObjectPaths、FStringAssetReference

1. FSoftObjectPath：是一个简单的结构体，其中包含了资源的完整名称（一个字符串）。它实质就是用一个字符串来表示对应的资源，从而能够随时经过字符串找到硬盘上的目标资源，将其载入进内存。

   FSoftObjectPath.SolveObject() 能够检查其引用的资源是否已经载入在内存中，若载入则返还资源对象指针，不然返还空。
   FSoftObjectPath.IsPending() 可检查资源是否已准备好可供访问。而如何利用FSoftObjectPath加载资源进内存，后面还会说到。

2. FStringAssetReference：其实只是一个听起来更容易理解的别名，它实际在UE4源码里是这样的：

typedef FSoftObjectPath FStringAssetReference;

TSoftObjectPtr<T>

TSoftObjectPtr是包含了FSoftObjectPath的TWeakObjectPtr，可经过模板参数来设置特定资源类型，这样就能够限制编辑器UI仅容许选择特定的资源种类。

TSoftObjectPtr.Get() 能够检查其引用的资源是否已经载入在内存中，若已载入则返还资源对象指针，不然返还空。想要资源加载进内存，则能够调用ToSoftObjectPath()来获得FSoftObjectPaths用于加载。

同步加载资源

---

LoadObject/LoadClass

1. LoadObject<T>()：加载UObject，通常用来加载非蓝图资源。

UTexture2D* Texture2D  = LoadObject<UTexture2D>(nullptr,TEXT("Texture2D'/Game/Textures/tex1.tex1'"));

1. LoadClass<T>()：加载UClass，通常用来加载蓝图资源并获取蓝图Class。实际上源码里LoadClass的实现是调用LoadObject并获取类型。
   • LoadClass的模版名称，和上面FClassFinder同样，不能直接写UBlueprint。
   • LoadClass路径规范也和上面的FClassFinder同样，带_C后缀或去掉前缀。

另外有两个函数叫：StaticLoadObject()和StaticLoadClass()，是LoadObject()和LoadClass()的早期版本，前二者须要手动强转和填写冗杂参数，后二者则是前二者的封装，使用更方便，推荐使用后者。

TSubclassOf<AActor> BPClass = LoadClass<AActor>(nullptr, TEXT("/Game/Blueprints/MyBP"));

此外一提，还有一个可能经常使用的全局函数FindObject()，用来查询资源是否载入进内存，若存在则返还资源对象指针，不然返还空。可是咱们不用先查询再使用LoadXXX，由于LoadXXX里自己就有用到FindObject来检查存在性。

TryLoad/LoadSynchronous

1. TryLoad()：FSoftObjectPaths的方法，直接根据路径加载资源。
2. LoadSynchronous()：TSoftObjectPtr<T>的方法，也是直接根据路径加载资源。

因为软引用里包含资源完整路径名，所以无需再写一次路径名，而是调用如上成员方法来加载资源进内存。而软引用的做用不只如此，它还能够用于下面要介绍的资源异步加载方式。

异步加载资源

---

即便能够控制加载资源的时机，但若是加载的资源对象很大（或者同一时刻加载多个资源），仍是会形成卡顿，为了不阻塞主线程，异步加载的方式必不可少。

FStreamableManager.RequestAsyncLoad()

首先，须要建立FStreamableManager，官方建议将它放在某类全局游戏单例对象中，例如使用GameSingletonClassName在DefaultEngine.ini中指定的对象。

1. FStreamableManager.RequestAsyncLoad()：将异步加载一组资源并在完成后调用委托。

void UGameCheatManager::GrantItems()
{      
       //获取 FStreamableManager的单例对象引用
       FStreamableManager& Streamable = ...;

       //获得一组软引用
       TArray<FSoftObjectPath> ItemsToStream;
       for(int32 i = 0; i < ItemList.Num(); ++i)
       ItemsToStream.AddUnique(ItemList[i].ToStringReference());

       //根据一组软引用来异步加载一组资源，加载完后调用委托
       Streamable.RequestAsyncLoad(ItemsToStream, FStreamableDelegate::CreateUObject(this, &UGameCheatManager::GrantItemsDeferred));
}

void UGameCheatManager::GrantItemsDeferred()
{
       //do something....
}

FStreamableManager其实也有同步加载的方法：SynchronousLoad()方法将进行一次简单的块加载并返回对象。

卸载资源

---

若是资源永再也不使用，想将资源对象从内存上卸载，代码以下：

Texture2D* mytex; //这里假设mytex合法有效  

mytex->ConditionalBeginDestroy();  
mytex = NULL;  
GetWorld()->ForceGarbageCollection(true);

建立对象

---

UE4的对象（即从UObject派生出来的类对象）最好不要用C++的new/delete，而应使用UE4提供的对象生成方法，要否则继承UObject的垃圾回收能力就无从用处。

建立通常对象

若是有UObject的派生类（非Actor、非Component），那么可以使用NewObject()模板函数来建立其实例对象：

UMyObject* MyObject = NewObject<UMyObject>();

建立Actor派生类对象

生成AActor派生类对象不要用NewObject或new，而要用UWorld::SpawnActor()

UWorld* World = GetWorld();
FVector pos(150, 0, 20);
AMyActor* MyActor = World->SpawnActor<AMyActor>(pos,FRotator::ZeroRotator);

注意SpawnActor不能放在构造函数，可是能够放在其余时期的函数里，例如BeginPlay()、Tick()...不然可能会编译后就crash。

建立Component派生类对象

为Actor建立组件，可以使用UObject::CreateDefaultSubobject()模板函数

UCameraComponent* Camera = CreateDefaultSubobject<UCameraComponent>(TEXT("Camera0"));

• CreateDefaultSubobject必须写在Actor的无参构造函数中，不然crash。
• CreateDefaultSubobject中的TEXT或者FName参数在同一个Actor中不能重复，不然crash。
• 必定要添加RegisterComponent()，不然编辑器不会显示。

建立蓝图对象

蓝图因为本质是一种脚本，不是直接的C++类，所以每每须要借助动态类型来生成蓝图对象。全部的加载资源并建立到场景中的方式都离不开SpawnActor这一句代码。

1.经过已肯定的父类来生成蓝图对象

AMyActor* spawnActor = GetWorld()->SpawnActor<AMyActor>(AMyActor::StaticClass());

若是你的蓝图派生于某个C++类,那么能够直接访问该类的StaticClass()并用于SpawnActor来建立蓝图对象。

2.经过UClass生成蓝图对象

UClass* BPClass = LoadClass<AActor>(nullptr, TEXT("/Game/Blueprints/MyBP"));    //TSubclassOf<AActor>同理
    AActor* spawnActor = GetWorld()->SpawnActor<AActor>(BPClass);

3.经过UObject生成蓝图对象

若获得UObject则须要先转换成UBlueprint，再经过GeneratedClass获取UClass来生成蓝图对象

FStringAssetReference asset = "Blueprint'/Game/BluePrint/TestObj.TestObj'";  
    UObject* itemObj = asset.ResolveObject();  
    UBlueprint* gen = Cast<UBlueprint>(itemObj);  
    if (gen != NULL)   
    {  
        AActor* spawnActor = GetWorld()->SpawnActor<AActor>(gen->GeneratedClass);  
    }

参考

---

虚幻引擎4 官方文档 | 引用资源

虚幻引擎4 官方文档 | 异步资源加载

UE4:四种加载资源的方式

[UE4]C++实现动态加载的问题：LoadClass ()和LoadObject ()

Unreal Cook Book：建立对象的的几种姿式（C++）

ue4 c++加载蓝图类，资源方式

[UE4]C++实现动态加载的问题

系列其余文章：Aery的UE4 C++开发之旅系列文章