izzy/UnrealEngineUWP
0
0
Fork 0
mirror of https://github.com/izzy2lost/UnrealEngineUWP.git synced 2026-03-26 18:15:20 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
3c2010d281269994deefcc86297a79247a9aeb34
UnrealEngineUWP/Engine/Source/Developer/AssetTools/Private/AssetTools.h
robert manuszewski d1443992e1 Deprecating ANY_PACKAGE. 
This change consists of multiple changes:

Core:
- Deprecation of ANY_PACKAGE macro. Added ANY_PACKAGE_DEPRECATED macro which can still be used for backwards compatibility purposes (only used in CoreUObject)
- Deprecation of StaticFindObjectFast* functions that take bAnyPackage parameter
- Added UStruct::GetStructPathName function that returns FTopLevelAssetPath representing the path name (package + object FName, super quick compared to UObject::GetPathName) + wrapper UClass::GetClassPathName to make it look better when used with UClasses
- Added (Static)FindFirstObject* functions that find a first object given its Name (no Outer). These functions are used in places I consider valid to do global UObject (UClass) lookups like parsing command line parameters / checking for unique object names
- Added static UClass::TryFindType function which serves a similar purpose as FindFirstObject however it's going to throw a warning (with a callstack / maybe ensure in the future?) if short class name is provided. This function is used  in places that used to use short class names but now should have been converted to use path names to catch any potential regressions and or edge cases I missed.
- Added static UClass::TryConvertShortNameToPathName utility function
- Added static UClass::TryFixShortClassNameExportPath utility function
- Object text export paths will now also include class path (Texture2D'/Game/Textures/Grass.Grass' -> /Script/Engine.Texture2D'/Game/Textures/Grass.Grass')
- All places that manually generated object export paths for objects will now use FObjectPropertyBase::GetExportPath
- Added a new startup test that checks for short type names in UClass/FProperty MetaData values

AssetRegistry:
- Deprecated any member variables (FAssetData / FARFilter) or functions that use FNames to represent class names and replaced them with FTopLevelAssetPath
- Added new member variables and new function overloads that use FTopLevelAssetPath to represent class names
- This also applies to a few other modules' APIs to match AssetRegistry changes

Everything else:
- Updated code that used ANY_PACKAGE (depending on the use case) to use FindObject(nullptr, PathToObject), UClass::TryFindType (used when path name is expected, warns if it's a short name) or FindFirstObject (usually for finding types based on user input but there's been a few legitimate use cases not related to user input)
- Updated code that used AssetRegistry API to use FTopLevelAssetPaths and USomeClass::StaticClass()->GetClassPathName() instead of GetFName()
- Updated meta data and hardcoded FindObject(ANY_PACKAGE, "EEnumNameOrClassName") calls to use path names

#jira UE-99463
#rb many.people
[FYI] Marcus.Wassmer
#preflight 629248ec2256738f75de9b32

#codereviewnumbers 20320742, 20320791, 20320799, 20320756, 20320809, 20320830, 20320840, 20320846, 20320851, 20320863, 20320780, 20320765, 20320876, 20320786

#ROBOMERGE-OWNER: robert.manuszewski
#ROBOMERGE-AUTHOR: robert.manuszewski
#ROBOMERGE-SOURCE: CL 20430220 via CL 20433854 via CL 20435474 via CL 20435484
#ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v949-20362246)

[CL 20448496 by robert manuszewski in ue5-main branch]
2022-06-01 03:46:59 -04:00

237 lines
15 KiB
C++
Raw Blame History

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "IAssetTools.h"
#include "IAssetTypeActions.h"
#include "AssetRegistry/AssetData.h"
#include "AssetRenameManager.h"
#include "Misc/NamePermissionList.h"
#include "UObject/StrongObjectPtr.h"
#include "Factories/Factory.h"
#include "AssetTools.generated.h"
class FAssetFixUpRedirectors;
class UToolMenu;
class IClassTypeActions;
class UAutomatedAssetImportData;
class UAssetImportTask;
struct ReportPackageData;
/** Parameters for importing specific set of files */
struct FAssetImportParams
{
FAssetImportParams()
: SpecifiedFactory(nullptr)
, ImportData(nullptr)
, AssetImportTask(nullptr)
, bSyncToBrowser(true)
, bForceOverrideExisting(false)
, bAutomated(false)
, bAllowAsyncImport(false)
, bSceneImport(false)
{}
/** Factory to use for importing files */
TStrongObjectPtr<UFactory> SpecifiedFactory;
/** Data used to determine rules for importing assets through the automated command line interface */
const UAutomatedAssetImportData* ImportData;
/** Script exposed rules and state for importing assets */
UAssetImportTask* AssetImportTask;
/** Whether or not to sync the content browser to the assets after import */
bool bSyncToBrowser : 1;
/** Whether or not we are forcing existing assets to be overriden without asking */
bool bForceOverrideExisting : 1;
/** Whether or not this is an automated import */
bool bAutomated : 1;
/** Temporary setting to enable the async import. (We will figure a better solution in a later release) */
bool bAllowAsyncImport : 1;
/** Whether or not this is a scene import */
bool bSceneImport : 1;
};
/** For backwards compatibility */
typedef class UAssetToolsImpl FAssetTools;
PRAGMA_DISABLE_DEPRECATION_WARNINGS
UCLASS(transient)
class UAssetToolsImpl : public UObject, public IAssetTools
{
GENERATED_BODY()
public:
UAssetToolsImpl(const FObjectInitializer& ObjectInitializer);
// IAssetTools implementation
virtual void RegisterAssetTypeActions(const TSharedRef<IAssetTypeActions>& NewActions) override;
virtual void UnregisterAssetTypeActions(const TSharedRef<IAssetTypeActions>& ActionsToRemove) override;
virtual void GetAssetTypeActionsList( TArray<TWeakPtr<IAssetTypeActions>>& OutAssetTypeActionsList ) const override;
virtual TWeakPtr<IAssetTypeActions> GetAssetTypeActionsForClass(const UClass* Class) const override;
virtual TArray<TWeakPtr<IAssetTypeActions>> GetAssetTypeActionsListForClass(const UClass* Class) const override;
virtual EAssetTypeCategories::Type RegisterAdvancedAssetCategory(FName CategoryKey, FText CategoryDisplayName) override;
virtual EAssetTypeCategories::Type FindAdvancedAssetCategory(FName CategoryKey) const override;
virtual void GetAllAdvancedAssetCategories(TArray<FAdvancedAssetCategory>& OutCategoryList) const override;
virtual void RegisterClassTypeActions(const TSharedRef<IClassTypeActions>& NewActions) override;
virtual void UnregisterClassTypeActions(const TSharedRef<IClassTypeActions>& ActionsToRemove) override;
virtual void GetClassTypeActionsList( TArray<TWeakPtr<IClassTypeActions>>& OutClassTypeActionsList ) const override;
virtual TWeakPtr<IClassTypeActions> GetClassTypeActionsForClass( UClass* Class ) const override;
virtual UObject* CreateAsset(const FString& AssetName, const FString& PackagePath, UClass* AssetClass, UFactory* Factory, FName CallingContext = NAME_None) override;
virtual UObject* CreateAssetWithDialog(UClass* AssetClass, UFactory* Factory, FName CallingContext = NAME_None) override;
virtual UObject* CreateAssetWithDialog(const FString& AssetName, const FString& PackagePath, UClass* AssetClass, UFactory* Factory, FName CallingContext = NAME_None, const bool bCallConfigureProperties = true) override;
virtual UObject* DuplicateAsset(const FString& AssetName, const FString& PackagePath, UObject* OriginalObject) override;
virtual UObject* DuplicateAssetWithDialog(const FString& AssetName, const FString& PackagePath, UObject* OriginalObject) override;
virtual UObject* DuplicateAssetWithDialogAndTitle(const FString& AssetName, const FString& PackagePath, UObject* OriginalObject, FText DialogTitle) override;
virtual void SetCreateAssetsAsExternallyReferenceable(bool bValue) override;
virtual bool GetCreateAssetsAsExternallyReferenceable() override;
virtual bool RenameAssets(const TArray<FAssetRenameData>& AssetsAndNames) override;
virtual EAssetRenameResult RenameAssetsWithDialog(const TArray<FAssetRenameData>& AssetsAndNames, bool bAutoCheckout = false) override;
virtual void FindSoftReferencesToObject(FSoftObjectPath TargetObject, TArray<UObject*>& ReferencingObjects) override;
virtual void FindSoftReferencesToObjects(const TArray<FSoftObjectPath>& TargetObjects, TMap<FSoftObjectPath, TArray<UObject*>>& ReferencingObjects) override;
virtual void RenameReferencingSoftObjectPaths(const TArray<UPackage *> PackagesToCheck, const TMap<FSoftObjectPath, FSoftObjectPath>& AssetRedirectorMap) override;
virtual TArray<UObject*> ImportAssetsWithDialog(const FString& DestinationPath) override;
virtual void ImportAssetsWithDialogAsync(const FString& DestinationPath) override;
virtual TArray<UObject*> ImportAssets(const TArray<FString>& Files, const FString& DestinationPath, UFactory* ChosenFactory, bool bSyncToBrowser = true, TArray<TPair<FString, FString>>* FilesAndDestinations = nullptr, bool bAllowAsyncImport = false, bool bSceneImport = false) const override;
virtual TArray<UObject*> ImportAssetsAutomated(const UAutomatedAssetImportData* ImportData) override;
virtual void ImportAssetTasks(const TArray<UAssetImportTask*>& ImportTasks) override;
virtual void ExportAssets(const TArray<FString>& AssetsToExport, const FString& ExportPath) override;
virtual void ExportAssets(const TArray<UObject*>& AssetsToExport, const FString& ExportPath) const override;
virtual void ExportAssetsWithDialog(const TArray<UObject*>& AssetsToExport, bool bPromptForIndividualFilenames) override;
virtual void ExportAssetsWithDialog(const TArray<FString>& AssetsToExport, bool bPromptForIndividualFilenames) override;
virtual void CreateUniqueAssetName(const FString& InBasePackageName, const FString& InSuffix, FString& OutPackageName, FString& OutAssetName) override;
virtual bool AssetUsesGenericThumbnail( const FAssetData& AssetData ) const override;
virtual void DiffAgainstDepot(UObject* InObject, const FString& InPackagePath, const FString& InPackageName) const override;
virtual void DiffAssets(UObject* OldAsset1, UObject* NewAsset, const struct FRevisionInfo& OldRevision, const struct FRevisionInfo& NewRevision) const override;
virtual FString DumpAssetToTempFile(UObject* Asset) const override;
virtual bool CreateDiffProcess(const FString& DiffCommand, const FString& OldTextFilename, const FString& NewTextFilename, const FString& DiffArgs = FString("")) const override;
virtual void MigratePackages(const TArray<FName>& PackageNamesToMigrate) const override;
virtual void BeginAdvancedCopyPackages(const TArray<FName>& InputNamesToCopy, const FString& TargetPath) const override;
virtual void FixupReferencers(const TArray<UObjectRedirector*>& Objects, bool bCheckoutDialogPrompt = true, ERedirectFixupMode FixupMode = ERedirectFixupMode::DeleteFixedUpRedirectors) const override;
virtual bool IsFixupReferencersInProgress() const override;
virtual FAssetPostRenameEvent& OnAssetPostRename() override { return AssetRenameManager->OnAssetPostRenameEvent(); }
virtual void ExpandDirectories(const TArray<FString>& Files, const FString& DestinationPath, TArray<TPair<FString, FString>>& FilesAndDestinations) const override;
virtual bool AdvancedCopyPackages(const FAdvancedCopyParams& CopyParams, const TArray<TMap<FString, FString>> PackagesAndDestinations) const override;
virtual bool AdvancedCopyPackages(const TMap<FString, FString>& SourceAndDestPackages, const bool bForceAutosave, const bool bCopyOverAllDestinationOverlaps, FDuplicatedObjects* OutDuplicatedObjects) const override;
virtual void GenerateAdvancedCopyDestinations(FAdvancedCopyParams& InParams, const TArray<FName>& InPackageNamesToCopy, const class UAdvancedCopyCustomization* CopyCustomization, TMap<FString, FString>& OutPackagesAndDestinations) const override;
virtual bool FlattenAdvancedCopyDestinations(const TArray<TMap<FString, FString>> PackagesAndDestinations, TMap<FString, FString>& FlattenedPackagesAndDestinations) const override;
virtual bool ValidateFlattenedAdvancedCopyDestinations(const TMap<FString, FString>& FlattenedPackagesAndDestinations) const override;
virtual void GetAllAdvancedCopySources(FName SelectedPackage, FAdvancedCopyParams& CopyParams, TArray<FName>& OutPackageNamesToCopy, TMap<FName, FName>& DependencyMap, const class UAdvancedCopyCustomization* CopyCustomization) const override;
virtual void InitAdvancedCopyFromCopyParams(FAdvancedCopyParams CopyParams) const override;
virtual void OpenEditorForAssets(const TArray<UObject*>& Assets) override;
virtual void ConvertVirtualTextures(const TArray<UTexture2D*>& Textures, bool bConvertBackToNonVirtual, const TArray<UMaterial*>* RelatedMaterials = nullptr) const override;
virtual bool IsAssetClassSupported(const UClass* AssetClass) const override;
virtual TArray<UFactory*> GetNewAssetFactories() const override;
UE_DEPRECATED(5.1, "Class names are now represented by path names. Please use GetAssetClassPathPermissionList.")
virtual TSharedRef<FNamePermissionList>& GetAssetClassPermissionList() override;
UE_DEPRECATED(5.1, "Class names are now represented by path names. Please use GetAssetClassPathPermissionList.")
TSharedRef<FNamePermissionList>& GetAssetClassPermissionList(EAssetClassAction AssetClassAction);
virtual TSharedRef<FPathPermissionList>& GetAssetClassPathPermissionList(EAssetClassAction AssetClassAction) override;
virtual TSharedRef<FPathPermissionList>& GetFolderPermissionList() override;
virtual TSharedRef<FPathPermissionList>& GetWritableFolderPermissionList() override;
virtual bool AllPassWritableFolderFilter(const TArray<FString>& InPaths) const override;
virtual void NotifyBlockedByWritableFolderFilter() const;
virtual void SyncBrowserToAssets(const TArray<UObject*>& AssetsToSync) override;
virtual void SyncBrowserToAssets(const TArray<FAssetData>& AssetsToSync) override;
public:
/** Gets the asset tools singleton as a FAssetTools for asset tools module use */
static UAssetToolsImpl& Get();
/** The manager to handle renaming assets */
TSharedPtr<FAssetRenameManager> AssetRenameManager;
/** The manager to handle fixing up redirectors */
TSharedPtr<FAssetFixUpRedirectors> AssetFixUpRedirectors;
private:
static FString GenerateAdvancedCopyDestinationPackageName(const FString& SourcePackage, const FString& SourcePath, const FString& DestinationFolder);
/** Checks to see if a package is marked for delete then ask the user if he would like to check in the deleted file before he can continue. Returns true when it is safe to proceed. */
bool CheckForDeletedPackage(const UPackage* Package) const;
/** Returns true if the supplied Asset name and package are currently valid for creation. */
bool CanCreateAsset(const FString& AssetName, const FString& PackageName, const FText& OperationText) const;
/** Begins the package migration, after assets have been discovered */
void PerformMigratePackages(TArray<FName> PackageNamesToMigrate) const;
TArray<FName> ExpandAssetsAndFoldersToJustAssets(TArray<FName> SelectedAssetAndFolderNames) const;
/** Begins the package advanced copy, after assets have been discovered */
void PerformAdvancedCopyPackages(TArray<FName> SelectedPackageNames, FString TargetPath) const;
/** Copies files after the final list was confirmed */
void MigratePackages_ReportConfirmed(TSharedPtr<TArray<ReportPackageData>> PackageDataToMigrate) const;
/** Copies files after the final list was confirmed */
void AdvancedCopyPackages_ReportConfirmed(FAdvancedCopyParams CopyParam, TArray<TMap<FString, FString>> DestinationMap) const;
/** Gets the dependencies of the specified package recursively */
void RecursiveGetDependencies(const FName& PackageName, TSet<FName>& AllDependencies, TSet<FString>& ExternalObjectsPaths) const;
/** Gets the dependencies of the specified package recursively while omitting things that don't pass the FARFilter passed in from FAdvancedCopyParams */
void RecursiveGetDependenciesAdvanced(const FName& PackageName, FAdvancedCopyParams& CopyParams, TArray<FName>& AllDependencies, TMap<FName, FName>& DependencyMap, const class UAdvancedCopyCustomization* CopyCustomization, TArray<FAssetData>& OptionalAssetData) const;
/** Records the time taken for an import and reports it to engine analytics, if available */
static void OnNewImportRecord(UClass* AssetType, const FString& FileExtension, bool bSucceeded, bool bWasCancelled, const FDateTime& StartTime);
/** Records what assets users are creating */
static void OnNewCreateRecord(UClass* AssetType, bool bDuplicated);
/** Internal method that performs the actual asset importing */
TArray<UObject*> ImportAssetsInternal(const TArray<FString>& Files, const FString& RootDestinationPath, TArray<TPair<FString, FString>> *FilesAndDestinationsPtr, const FAssetImportParams& ImportParams) const;
/** Internal method to export assets. If no export path is created a user will be prompted for one. if bPromptIndividualFilenames is true a user will be asked per file */
void ExportAssetsInternal(const TArray<UObject*>& ObjectsToExport, bool bPromptIndividualFilenames, const FString& ExportPath) const;
UObject* PerformDuplicateAsset(const FString& AssetName, const FString& PackagePath, UObject* OriginalObject, bool bWithDialog);
/** Internal method that performs actions when asset class deny list filter changes */
void AssetClassPermissionListChanged(EAssetClassAction AssetClassAction);
/**
* Add sub content deny list filter for a new mount point
* @param InMount The mount point
*/
void AddSubContentDenyList(const FString& InMount);
/** Called when a new mount is added to add the proper sub content deny list to it. */
void OnContentPathMounted(const FString& InAssetPath, const FString& FileSystemPath);
/** Implementation for the import with dialog functions */
TArray<UObject*> ImportAssetsWithDialogImplementation(const FString& DestinationPath, bool bAllowAsyncImport);
private:
/** The list of all registered AssetTypeActions */
TArray<TSharedRef<IAssetTypeActions>> AssetTypeActionsList;
/** The list of all registered ClassTypeActions */
TArray<TSharedRef<IClassTypeActions>> ClassTypeActionsList;
/** The categories that have been allocated already */
TMap<FName, FAdvancedAssetCategory> AllocatedCategoryBits;
/** The next user category bit to allocate (set to 0 when there are no more bits left) */
uint32 NextUserCategoryBit;
/** This should be removed with the removal of GetAssetClassPermissionList functions */
TSharedRef<FNamePermissionList> AssetClassPermissionList_DEPRECATED;
/** Permission lists of assets by class path name, one for each EAssetClassAction */
TArray<TSharedRef<FPathPermissionList>> AssetClassPermissionList;
/** Permission list of folder paths */
TSharedRef<FPathPermissionList> FolderPermissionList;
/** Permission list of folder paths to write to */
TSharedRef<FPathPermissionList> WritableFolderPermissionList;
/** List of sub content paths denied for every mount. */
TArray<FString> SubContentDenyListPaths;
bool CreateAssetsAsExternallyReferenceable;
};
PRAGMA_ENABLE_DEPRECATION_WARNINGS
Reference in New Issue View Git Blame Copy Permalink