UnrealEngineUWP/Engine/Source/Developer/AssetTools/Public/AssetViewUtils.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "AssetData.h"
#include "Interfaces/IPluginManager.h"

class FViewport;

namespace AssetViewUtils
{
	/** Loads the specified object if needed and opens the asset editor for it */
	ASSETTOOLS_API bool OpenEditorForAsset(const FString& ObjectPath);

	/** Opens the asset editor for the specified asset */
	ASSETTOOLS_API bool OpenEditorForAsset(UObject* Asset);

	/** Opens the asset editor for the specified assets */
	ASSETTOOLS_API bool OpenEditorForAsset(const TArray<UObject*>& Assets);

	/**
	  * Makes sure the specified assets are loaded into memory.
	  * 
	  * @param ObjectPaths The paths to the objects to load.
	  * @param LoadedObjects The returned list of objects that were already loaded or loaded by this method.
	  * @return false if user canceled after being warned about loading very many packages.
	  */
	ASSETTOOLS_API bool LoadAssetsIfNeeded(const TArray<FString>& ObjectPaths, TArray<UObject*>& LoadedObjects, bool bAllowedToPromptToLoadAssets = true, bool bLoadRedirects = false);

	/**
	 * Determines the unloaded assets that need loading
	 *
	 * @param ObjectPaths		Paths to assets that may need to be loaded
	 * @param OutUnloadedObjects	List of the unloaded object paths
	 * @return true if the user should be prompted to load assets
	 */
	ASSETTOOLS_API void GetUnloadedAssets(const TArray<FString>& ObjectPaths, TArray<FString>& OutUnloadedObjects);

	/**
	 * Prompts the user to load the list of unloaded objects
 	 *
	 * @param UnloadedObjects	The list of unloaded objects that we should prompt for loading
	 * @param true if the user allows the objects to be loaded
	 */
	ASSETTOOLS_API bool PromptToLoadAssets(const TArray<FString>& UnloadedObjects);

	/** 
	 * Copies assets to a new path 
	 * @param Assets The assets to copy
	 * @param DestPath The destination folder in which to copy the assets
	 */
	ASSETTOOLS_API void CopyAssets(const TArray<UObject*>& Assets, const FString& DestPath);

	/**
	  * Moves assets to a new path
	  * 
	  * @param Assets The assets to move
	  * @param DestPath The destination folder in which to move the assets
	  * @param SourcePath If non-empty, this will specify the base folder which will cause the move to maintain folder structure
	  */
	ASSETTOOLS_API void MoveAssets(const TArray<UObject*>& Assets, const FString& DestPath, const FString& SourcePath = FString());

	/** Attempts to deletes the specified assets. Returns the number of assets deleted */
	ASSETTOOLS_API int32 DeleteAssets(const TArray<UObject*>& AssetsToDelete);

	/** Attempts to delete the specified folders and all assets inside them. Returns true if the operation succeeded. */
	ASSETTOOLS_API bool DeleteFolders(const TArray<FString>& PathsToDelete);

	/** Gets an array of assets inside the specified folders */
	ASSETTOOLS_API void GetAssetsInPaths(const TArray<FString>& InPaths, TArray<FAssetData>& OutAssetDataList);

	/** Saves all the specified packages */
	ASSETTOOLS_API bool SavePackages(const TArray<UPackage*>& Packages);

	/** Prompts to save all modified packages */
	ASSETTOOLS_API bool SaveDirtyPackages();

	/** Loads all the specified packages */
	ASSETTOOLS_API TArray<UPackage*> LoadPackages(const TArray<FString>& PackageNames);

	/** Moves all assets from the source path to the destination path, preserving path structure, deletes source path afterwards if possible */
	ASSETTOOLS_API bool RenameFolder(const FString& DestPath, const FString& SourcePath);

	/** Copies all assets in all source paths to the destination path, preserving path structure */
	ASSETTOOLS_API bool CopyFolders(const TArray<FString>& InSourcePathNames, const FString& DestPath);

	/** Moves all assets in all source paths to the destination path, preserving path structure */
	ASSETTOOLS_API bool MoveFolders(const TArray<FString>& InSourcePathNames, const FString& DestPath);

	/**
	  * A helper function for folder drag/drop which loads all assets in a path (including sub-paths) and returns the assets found
	  * 
	  * @param SourcePathNames				The paths to the folders to drag/drop
	  * @param OutSourcePathToLoadedAssets	The map of source folder paths to assets found
	  */
	ASSETTOOLS_API bool PrepareFoldersForDragDrop(const TArray<FString>& SourcePathNames, TMap< FString, TArray<UObject*> >& OutSourcePathToLoadedAssets);

	/**
	 * Capture active viewport to thumbnail and assigns that thumbnail to incoming assets
	 *
	 * @param InViewport - viewport to sample from
	 * @param InAssetsToAssign - assets that should receive the new thumbnail ONLY if they are assets that use GenericThumbnails
	 */
	ASSETTOOLS_API void CaptureThumbnailFromViewport(FViewport* InViewport, const TArray<FAssetData>& InAssetsToAssign);

	/**
	 * Clears custom thumbnails for the selected assets
	 *
	 * @param InAssetsToAssign - assets that should have their thumbnail cleared
	 */
	ASSETTOOLS_API void ClearCustomThumbnails(const TArray<FAssetData>& InAssetsToAssign);

	/** Returns true if the specified asset that uses shared thumbnails has a thumbnail assigned to it */
	ASSETTOOLS_API bool AssetHasCustomThumbnail( const FAssetData& AssetData );

	/** Returns true if the passed-in path is a project folder */
	ASSETTOOLS_API bool IsProjectFolder(const FString& InPath, const bool bIncludePlugins = false);

	/** Returns true if the passed-in path is a engine folder */
	ASSETTOOLS_API bool IsEngineFolder(const FString& InPath, const bool bIncludePlugins = false);

	/** Returns true if the passed-in path is a developers folder */
	ASSETTOOLS_API bool IsDevelopersFolder( const FString& InPath );

	/** Returns true if the passed-in path is a plugin folder, optionally reporting where the plugin was loaded from */
	ASSETTOOLS_API bool IsPluginFolder(const FString& InPath, EPluginLoadedFrom* OutPluginSource = nullptr);

	/** Returns true if the passed-in path is a plugin folder, optionally reporting where the plugin was loaded from.
	 *  Pass in a prefiltered list of plugins to consider -- more efficient when called many times.
	 */
	ASSETTOOLS_API bool IsPluginFolder(const FString& InPath, const TArray<TSharedRef<IPlugin>>& InPlugins, EPluginLoadedFrom* OutPluginSource = nullptr);

	/** Get all the objects in a list of asset data */
	ASSETTOOLS_API void GetObjectsInAssetData(const TArray<FAssetData>& AssetList, TArray<UObject*>& OutDroppedObjects);

	/** Returns true if the supplied folder name can be used as part of a package name */
	ASSETTOOLS_API bool IsValidFolderName(const FString& FolderName, FText& Reason);

	/** Returns true if the path specified exists as a folder in the asset registry */
	ASSETTOOLS_API bool DoesFolderExist(const FString& FolderPath);

	/**
	 * Loads the color of this path from the config
	 *
	 * @param FolderPath - The path to the folder
	 * @return The color the folder should appear as, will be NULL if not customized
	 */
	ASSETTOOLS_API const TSharedPtr<FLinearColor> LoadColor(const FString& FolderPath);

	/**
	 * Saves the color of the path to the config
	 *
	 * @param FolderPath - The path to the folder
	 * @param FolderColor - The color the folder should appear as
	 * @param bForceAdd - If true, force the color to be added for the path
	 */
	ASSETTOOLS_API void SaveColor(const FString& FolderPath, const TSharedPtr<FLinearColor>& FolderColor, bool bForceAdd = false);

	/**
	 * Checks to see if any folder has a custom color, optionally outputs them to a list
	 *
	 * @param OutColors - If specified, returns all the custom colors being used
	 * @return true, if custom colors are present
	 */
	ASSETTOOLS_API bool HasCustomColors( TArray< FLinearColor >* OutColors = NULL );

	/** Gets the default color the folder should appear as */
	ASSETTOOLS_API FLinearColor GetDefaultColor();

	/** Returns true if the specified path is available for object creation */
	ASSETTOOLS_API bool IsValidObjectPathForCreate(const FString& ObjectPath, FText& OutErrorMessage, bool bAllowExistingAsset = false);
	
	/** Returns true if the specified path is available for object creation */
	ASSETTOOLS_API bool IsValidObjectPathForCreate(const FString& ObjectPath, const UClass* ObjectClass, FText& OutErrorMessage, bool bAllowExistingAsset = false);

	/** Returns true if the specified folder name in the specified path is available for folder creation */
	ASSETTOOLS_API bool IsValidFolderPathForCreate(const FString& FolderPath, const FString& NewFolderName, FText& OutErrorMessage);

	/** Returns the relative path, from the workspace root, of the package */
	ASSETTOOLS_API FString GetPackagePathWithinRoot(const FString& PackageName);

	/** Returns the length of the computed cooked package name and path whether it's run on a build machine or locally */
	ASSETTOOLS_API int32 GetPackageLengthForCooking(const FString& PackageName, bool IsInternalBuild);

	/** Checks to see whether the path is within the size restrictions for cooking */
	ASSETTOOLS_API bool IsValidPackageForCooking(const FString& PackageName, FText& OutErrorMessage);

	/** Gets the maximum path length for an asset package file. Changes behavior based on whether the editor experimental setting for long paths is enabled. */
	ASSETTOOLS_API int32 GetMaxAssetPathLen();

	/** Gets the maximum path length for a cooked file. Changes behavior based on whether the editor experimental setting for long paths is enabled. */
	ASSETTOOLS_API int32 GetMaxCookPathLen();

	/** Syncs the specified packages from source control, other than any level assets which are currently being edited */
	ASSETTOOLS_API void SyncPackagesFromSourceControl(const TArray<FString>& PackageNames);

	/** Syncs the content from the specified paths from source control, other than any level assets which are currently being edited */
	ASSETTOOLS_API void SyncPathsFromSourceControl(const TArray<FString>& ContentPaths);

	/** Show an error notification toast if the given error message is not empty */
	ASSETTOOLS_API void ShowErrorNotifcation(const FText& InErrorMsg);

	/** Callback used when a folder should be forced to be visible in the Content Browser */
	DECLARE_MULTICAST_DELEGATE_OneParam(FOnAlwaysShowPath, const FString& /*InPath*/);
	ASSETTOOLS_API FOnAlwaysShowPath& OnAlwaysShowPath();

	/** Called when a folder is moved or renamed */
	using FMovedContentFolder = TTuple<FString /*OldPath*/, FString /*NewPath*/>;
	DECLARE_MULTICAST_DELEGATE_OneParam(FOnFolderPathChanged, TArrayView<const FMovedContentFolder> /*ChangedPaths*/);
	ASSETTOOLS_API FOnFolderPathChanged& OnFolderPathChanged();
}