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
5.5
UnrealEngineUWP/Engine/Source/Developer/CollectionManager/Private/CollectionManager.h

356 lines
22 KiB
C
Raw Permalink Normal View History

Updating copyright for Engine Developer. #rnx #rb none #ROBOMERGE-SOURCE: CL 10869240 via CL 10869516 via CL 10869902 #ROBOMERGE-BOT: (v613-10869866) [CL 10870584 by ryan durand in Main branch]
2019-12-26 15:32:37 -05:00
// Copyright Epic Games, Inc. All Rights Reserved.
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
#pragma once
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "CoreMinimal.h"
Added missing includes and forward declarations Supplied by David.Bollo of The Coalition. Fixes some non unity compile errors [FYI] David.Bollo #jira none #ROBOMERGE-SOURCE: CL 17206575 in //UE5/Main/... #ROBOMERGE-BOT: STARSHIP (Main -> Release-Engine-Test) (v855-17104924) [CL 17206608 by dan phillips in ue5-release-engine-test branch]
2021-08-17 17:47:10 -04:00
#include "Containers/Ticker.h"
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
#include "Collection.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "CollectionManagerTypes.h"
#include "ICollectionManager.h"
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
#include "Misc/Guid.h"
#include "Templates/PimplPtr.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
class ITextFilterExpressionContext;
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
namespace DirectoryWatcher{ class FFileCache; }
class FCollectionManagerCache;
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
// Objects wrapping locks to read, write, or begin-reading-then-write (for cache updates) internal state.
// Used as internal function parameters to show what lock type must be held to perform the operation and prevent
// recursive lock acquisition
// Functions taking Lock/Lock_Read need to be able to read data but not update caches
class FCollectionLock;
class FCollectionLock_Read;
// Functions taking Lock_RW may need to promote the lock to a write state to update caches
class FCollectionLock_RW;
// Functions taking Lock_Write have exclusive access and can update collections as well as update caches
class FCollectionLock_Write;
Added file watchers to detect when collections are changed outside of the collection manager UE-17782 - Editor must be restarted for New Collections to appear after syncing These use FFileCache to avoid detecting changes that are made by the collection manager itself. This also fixes some issues when merging collection sets together, and fixes some places where UI wouldn't update when a collection was changed due to an update or merge. [CL 2612319 by Jamie Dale in Main branch]
2015-07-07 10:31:39 -04:00
Made the collection manager caching lazy This used to maintain an up-to-date cache as soon as a change happened. This lead to extra complexity in some cases, and often would keep caches up-to-date that weren't currently even being used. Adding, removing, or updating a collection will now just mark the relevant parts of the cache as dirty so that they can be updated (using a well defined, safe, full update) the next time something requests them. [CL 2610959 by Jamie Dale in Main branch]
2015-07-06 09:40:48 -04:00
/** Collection info for a given object - gives the collection name, as well as the reason this object is considered to be part of this collection */
struct FObjectCollectionInfo
{
explicit FObjectCollectionInfo(const FCollectionNameType& InCollectionKey)
: CollectionKey(InCollectionKey)
, Reason(0)
{
}
FObjectCollectionInfo(const FCollectionNameType& InCollectionKey, const ECollectionRecursionFlags::Flags InReason)
: CollectionKey(InCollectionKey)
, Reason(InReason)
{
}
/** The key identifying the collection that contains this object */
FCollectionNameType CollectionKey;
/** The reason(s) why this collection contains this object - this can be tested against the recursion mode when getting the collections for an object */
ECollectionRecursionFlags::Flags Reason;
};
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
enum class ECollectionCacheFlags
[Backout] - CL33005160 [FYI] robert.millar Original CL Desc ----------------------------------------------------------------- Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33030091 by bob tellez in ue5-main branch]
2024-04-17 02:10:31 -04:00
{
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
None = 0,
Names = 1<<0,
Objects = 1<<1,
Hierarchy = 1<<2,
Colors = 1 <<3,
[Backout] - CL33005160 [FYI] robert.millar Original CL Desc ----------------------------------------------------------------- Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33030091 by bob tellez in ue5-main branch]
2024-04-17 02:10:31 -04:00
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
// Necessary cache updates for calling collection recursion worker
RecursionWorker = Names | Hierarchy,
All = Names | Objects | Hierarchy | Colors,
[Backout] - CL33005160 [FYI] robert.millar Original CL Desc ----------------------------------------------------------------- Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33030091 by bob tellez in ue5-main branch]
2024-04-17 02:10:31 -04:00
};
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
ENUM_CLASS_FLAGS(ECollectionCacheFlags);
UE_DEPRECATED(5.5, "These typedefs have been deprecated. Replace them with their concrete types.")
typedef TMap<FCollectionNameType, TSharedRef<FCollection>> FAvailableCollectionsMap;
UE_DEPRECATED(5.5, "These typedefs have been deprecated. Replace them with their concrete types.")
typedef TMap<FGuid, FCollectionNameType> FGuidToCollectionNamesMap;
UE_DEPRECATED(5.5, "These typedefs have been deprecated. Replace them with their concrete types.")
typedef TMap<FSoftObjectPath, TArray<FObjectCollectionInfo>> FCollectionObjectsMap;
UE_DEPRECATED(5.5, "These typedefs have been deprecated. Replace them with their concrete types.")
typedef TMap<FGuid, TArray<FGuid>> FCollectionHierarchyMap;
UE_DEPRECATED(5.5, "These typedefs have been deprecated. Replace them with their concrete types.")
typedef TArray<FLinearColor> FCollectionColorArray;
[Backout] - CL33005160 [FYI] robert.millar Original CL Desc ----------------------------------------------------------------- Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33030091 by bob tellez in ue5-main branch]
2024-04-17 02:10:31 -04:00
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
class FCollectionManager : public ICollectionManager
{
public:
FCollectionManager();
virtual ~FCollectionManager();
// ICollectionManager implementation
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
PRAGMA_DISABLE_DEPRECATION_WARNINGS
virtual bool GetAssetsInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FName>& AssetPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
TArray<FSoftObjectPath> Temp;
if (GetAssetsInCollection(CollectionName, ShareType, Temp, RecursionMode))
{
AssetPaths.Append(UE::SoftObjectPath::Private::ConvertSoftObjectPaths(Temp));
return true;
}
return false;
}
virtual bool GetObjectsInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FName>& ObjectPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
TArray<FSoftObjectPath> Temp;
if (GetObjectsInCollection(CollectionName, ShareType, Temp, RecursionMode))
{
ObjectPaths.Append(UE::SoftObjectPath::Private::ConvertSoftObjectPaths(Temp));
return true;
}
return false;
}
virtual bool GetClassesInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FName>& ClassPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
TArray<FTopLevelAssetPath> Temp;
if (GetClassesInCollection(CollectionName, ShareType, Temp, RecursionMode))
{
for (FTopLevelAssetPath Path : Temp)
{
ClassPaths.Add(Path.ToFName());
}
return true;
}
return false;
}
virtual void GetCollectionsContainingObject(FName ObjectPath, ECollectionShareType::Type ShareType, TArray<FName>& OutCollectionNames, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
GetCollectionsContainingObject(FSoftObjectPath(ObjectPath), ShareType, OutCollectionNames, RecursionMode);
}
virtual void GetCollectionsContainingObject(FName ObjectPath, TArray<FCollectionNameType>& OutCollections, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
GetCollectionsContainingObject(FSoftObjectPath(ObjectPath), OutCollections, RecursionMode);
}
virtual void GetCollectionsContainingObjects(const TArray<FName>& ObjectPathNames, TMap<FCollectionNameType, TArray<FName>>& OutCollectionsAndMatchedObjects, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
TArray<FSoftObjectPath> Paths = UE::SoftObjectPath::Private::ConvertObjectPathNames(ObjectPathNames);
TMap<FCollectionNameType, TArray<FSoftObjectPath>> TmpMap;
GetCollectionsContainingObjects(Paths, TmpMap, RecursionMode);
for (const TPair<FCollectionNameType, TArray<FSoftObjectPath>>& Pair : TmpMap)
{
TArray<FName>& Names = OutCollectionsAndMatchedObjects.FindOrAdd(Pair.Key);
Names.Append(UE::SoftObjectPath::Private::ConvertSoftObjectPaths(Pair.Value));
}
}
virtual FString GetCollectionsStringForObject(FName ObjectPath, ECollectionShareType::Type ShareType, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self, bool bFullPaths = true) const override
{
return GetCollectionsStringForObject(FSoftObjectPath(ObjectPath), ShareType, RecursionMode, bFullPaths);
}
virtual bool AddToCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ObjectPath) override
{
return AddToCollection(CollectionName, ShareType, FSoftObjectPath(ObjectPath));
}
virtual bool AddToCollection(FName CollectionName, ECollectionShareType::Type ShareType, const TArray<FName>& ObjectPaths, int32* OutNumAdded = nullptr) override
{
return AddToCollection(CollectionName, ShareType, UE::SoftObjectPath::Private::ConvertObjectPathNames(ObjectPaths), OutNumAdded);
}
virtual bool RemoveFromCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ObjectPath) override
{
return RemoveFromCollection(CollectionName, ShareType, FSoftObjectPath(ObjectPath));
}
virtual bool RemoveFromCollection(FName CollectionName, ECollectionShareType::Type ShareType, const TArray<FName>& ObjectPaths, int32* OutNumRemoved = nullptr) override
{
return RemoveFromCollection(CollectionName, ShareType, UE::SoftObjectPath::Private::ConvertObjectPathNames(ObjectPaths), OutNumRemoved);
}
virtual bool IsObjectInCollection(FName ObjectPath, FName CollectionName, ECollectionShareType::Type ShareType, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override
{
return IsObjectInCollection(FSoftObjectPath(ObjectPath), CollectionName, ShareType, RecursionMode);
}
virtual bool HandleRedirectorDeleted(const FName& ObjectPath) override
{
return HandleRedirectorDeleted(FSoftObjectPath(ObjectPath));
}
virtual void HandleObjectRenamed(const FName& OldObjectPath, const FName& NewObjectPath) override
{
return HandleObjectRenamed(FSoftObjectPath(OldObjectPath), FSoftObjectPath(NewObjectPath));
}
virtual void HandleObjectDeleted(const FName& ObjectPath) override
{
return HandleObjectDeleted(FSoftObjectPath(ObjectPath));
}
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
PRAGMA_ENABLE_DEPRECATION_WARNINGS
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
Optimized getting the list of collections for an object The collections manager now stores a reverse look-up from the objects within its collections, to the collections that contain that object. This avoids the GetCollectionsContainingObject and GetCollectionsContainingObjects functions having to iterate the collections for each object queried, which can be a large win for large sets of objects. This also adds some functions needed for the quick asset management feature. [CL 2570748 by Jamie Dale in Main branch]
2015-05-29 13:15:23 -04:00
virtual bool HasCollections() const override;
Added support for nested collections UETOOL-332 - Collections 2.0 UETOOL-369 - Want nested collections with collapsing We now have version 2 collections which maintain a persistent GUID for each collection. Existing collections will be lazily updated to this version when they need to be re-saved. This GUID is used by child collections to keep track their parents, and the collections view (as well as the quick asset management) now show a tree of collections. Collections in the main collection view tree can be re-parented via drag and drop. Performing Content Browser searches against a given collection will also test to see if an object exists in child collections, and the asset view will now show you folder entries for child collections when viewing a parent (if folders are enabled in your Content Browser view settings). [CL 2593321 by Jamie Dale in Main branch]
2015-06-19 07:33:02 -04:00
virtual void GetCollections(TArray<FCollectionNameType>& OutCollections) const override;
Copying //UE4/Dev-Editor to Dev-Main (//UE4/Dev-Main) for 4.24 #rb none [CL 9325047 by Chris Gagnon in Main branch]
2019-10-01 20:41:42 -04:00
virtual void GetCollections(FName CollectionName, TArray<FCollectionNameType>& OutCollections) const override;
UE4 Refactoring. Changed OVERRIDE and FINAL macros to keywords override and final. [CL 2104397 by Jaroslaw Palczynski in Main branch]
2014-06-13 06:14:46 -04:00
virtual void GetCollectionNames(ECollectionShareType::Type ShareType, TArray<FName>& CollectionNames) const override;
Added support for nested collections UETOOL-332 - Collections 2.0 UETOOL-369 - Want nested collections with collapsing We now have version 2 collections which maintain a persistent GUID for each collection. Existing collections will be lazily updated to this version when they need to be re-saved. This GUID is used by child collections to keep track their parents, and the collections view (as well as the quick asset management) now show a tree of collections. Collections in the main collection view tree can be re-parented via drag and drop. Performing Content Browser searches against a given collection will also test to see if an object exists in child collections, and the asset view will now show you folder entries for child collections when viewing a parent (if folders are enabled in your Content Browser view settings). [CL 2593321 by Jamie Dale in Main branch]
2015-06-19 07:33:02 -04:00
virtual void GetRootCollections(TArray<FCollectionNameType>& OutCollections) const override;
virtual void GetRootCollectionNames(ECollectionShareType::Type ShareType, TArray<FName>& CollectionNames) const override;
virtual void GetChildCollections(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FCollectionNameType>& OutCollections) const override;
virtual void GetChildCollectionNames(FName CollectionName, ECollectionShareType::Type ShareType, ECollectionShareType::Type ChildShareType, TArray<FName>& CollectionNames) const override;
Added support for navigating collections using the path breadcumbs in the Content Browser UE-17646 - Collections don't display bread crumb path when nested [CL 2607575 by Jamie Dale in Main branch]
2015-07-01 11:36:19 -04:00
virtual TOptional<FCollectionNameType> GetParentCollection(FName CollectionName, ECollectionShareType::Type ShareType) const override;
UE4 Refactoring. Changed OVERRIDE and FINAL macros to keywords override and final. [CL 2104397 by Jaroslaw Palczynski in Main branch]
2014-06-13 06:14:46 -04:00
virtual bool CollectionExists(FName CollectionName, ECollectionShareType::Type ShareType) const override;
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
virtual bool GetAssetsInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FSoftObjectPath>& AssetPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual bool GetObjectsInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FSoftObjectPath>& ObjectPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual bool GetClassesInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FTopLevelAssetPath>& ClassPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual void GetCollectionsContainingObject(const FSoftObjectPath& ObjectPath, ECollectionShareType::Type ShareType, TArray<FName>& OutCollectionNames, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual void GetCollectionsContainingObject(const FSoftObjectPath& ObjectPath, TArray<FCollectionNameType>& OutCollections, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual void GetCollectionsContainingObjects(const TArray<FSoftObjectPath>& ObjectPaths, TMap<FCollectionNameType, TArray<FSoftObjectPath>>& OutCollectionsAndMatchedObjects, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual FString GetCollectionsStringForObject(const FSoftObjectPath& ObjectPath, ECollectionShareType::Type ShareType, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self, bool bFullPaths = true) const override;
UE4 Refactoring. Changed OVERRIDE and FINAL macros to keywords override and final. [CL 2104397 by Jaroslaw Palczynski in Main branch]
2014-06-13 06:14:46 -04:00
virtual void CreateUniqueCollectionName(const FName& BaseName, ECollectionShareType::Type ShareType, FName& OutCollectionName) const override;
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
virtual bool IsValidCollectionName(const FString& CollectionName, ECollectionShareType::Type ShareType, FText* OutError = nullptr) const override;
virtual bool CreateCollection(FName CollectionName, ECollectionShareType::Type ShareType, ECollectionStorageMode::Type StorageMode, FText* OutError = nullptr) override;
virtual bool RenameCollection(FName CurrentCollectionName, ECollectionShareType::Type CurrentShareType, FName NewCollectionName, ECollectionShareType::Type NewShareType, FText* OutError = nullptr) override;
virtual bool ReparentCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ParentCollectionName, ECollectionShareType::Type ParentShareType, FText* OutError = nullptr) override;
virtual bool DestroyCollection(FName CollectionName, ECollectionShareType::Type ShareType, FText* OutError = nullptr) override;
virtual bool AddToCollection(FName CollectionName, ECollectionShareType::Type ShareType, const FSoftObjectPath& ObjectPath, FText* OutError = nullptr) override;
virtual bool AddToCollection(FName CollectionName, ECollectionShareType::Type ShareType, TConstArrayView<FSoftObjectPath> ObjectPaths, int32* OutNumAdded = nullptr, FText* OutError = nullptr) override;
virtual bool RemoveFromCollection(FName CollectionName, ECollectionShareType::Type ShareType, const FSoftObjectPath& ObjectPath, FText* OutError = nullptr) override;
virtual bool RemoveFromCollection(FName CollectionName, ECollectionShareType::Type ShareType, TConstArrayView<FSoftObjectPath> ObjectPaths, int32* OutNumRemoved = nullptr, FText* OutError = nullptr) override;
virtual bool SetDynamicQueryText(FName CollectionName, ECollectionShareType::Type ShareType, const FString& InQueryText, FText* OutError = nullptr) override;
virtual bool GetDynamicQueryText(FName CollectionName, ECollectionShareType::Type ShareType, FString& OutQueryText, FText* OutError = nullptr) const override;
virtual bool TestDynamicQuery(FName CollectionName, ECollectionShareType::Type ShareType, const ITextFilterExpressionContext& InContext, bool& OutResult, FText* OutError = nullptr) const override;
virtual bool EmptyCollection(FName CollectionName, ECollectionShareType::Type ShareType, FText* OutError = nullptr) override;
virtual bool SaveCollection(FName CollectionName, ECollectionShareType::Type ShareType, FText* OutError = nullptr) override;
virtual bool UpdateCollection(FName CollectionName, ECollectionShareType::Type ShareType, FText* OutError = nullptr) override;
virtual bool GetCollectionStatusInfo(FName CollectionName, ECollectionShareType::Type ShareType, FCollectionStatusInfo& OutStatusInfo, FText* OutError = nullptr) const override;
Copying //UE4/Dev-Editor to Dev-Main (//UE4/Dev-Main) for 4.24 #rb none [CL 9325047 by Chris Gagnon in Main branch]
2019-10-01 20:41:42 -04:00
virtual bool HasCollectionColors(TArray<FLinearColor>* OutColors = nullptr) const override;
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
virtual bool GetCollectionColor(FName CollectionName, ECollectionShareType::Type ShareType, TOptional<FLinearColor>& OutColor, FText* OutError = nullptr) const override;
virtual bool SetCollectionColor(FName CollectionName, ECollectionShareType::Type ShareType, const TOptional<FLinearColor>& NewColor, FText* OutError = nullptr) override;
virtual bool GetCollectionStorageMode(FName CollectionName, ECollectionShareType::Type ShareType, ECollectionStorageMode::Type& OutStorageMode, FText* OutError = nullptr) const override;
virtual bool IsObjectInCollection(const FSoftObjectPath& ObjectPath, FName CollectionName, ECollectionShareType::Type ShareType, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self, FText* OutError = nullptr) const override;
virtual bool IsValidParentCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ParentCollectionName, ECollectionShareType::Type ParentShareType, FText* OutError) const override;
UE_DEPRECATED(5.5, "Deprecated for thread safety reasons.")
virtual FText GetLastError() const override { return FText::GetEmpty(); }
Made collections robust against moving or renaming assets and classes UETOOL-332 - Collections 2.0 UETOOL-373 - Check robustness of Collections 2.0 The collection manager will now fix-up any references to redirectors within its collections once the asset registry has finished discovering all the available assets. It also adds a watcher so it can pick up any moves or deletes as they happen. All of this fix-up is applied to the in-memory copy of the collection, and doesn't get persisted to disk until it needs to be (because referenced redirectors are being deleted). This helps to minimize issues with source control availability and shared/private collections. This change also makes sure that objects that are being referenced by a collection will leave a redirector behind, and also adds some extra context (such as the collection name) to some of the source control errors that may be reported when saving a collection. [CL 2602519 by Jamie Dale in Main branch]
2015-06-26 13:13:02 -04:00
virtual void HandleFixupRedirectors(ICollectionRedirectorFollower& InRedirectorFollower) override;
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
virtual bool HandleRedirectorDeleted(const FSoftObjectPath& ObjectPath, FText* OutError = nullptr) override;
virtual bool HandleRedirectorsDeleted(TConstArrayView<FSoftObjectPath> ObjectPaths, FText* OutError = nullptr) override;
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
virtual void HandleObjectRenamed(const FSoftObjectPath& OldObjectPath, const FSoftObjectPath& NewObjectPath) override;
virtual void HandleObjectDeleted(const FSoftObjectPath& ObjectPath) override;
Optimize collection manager by allowing batch remove #rb logan.buchy [CL 30926597 by rex hill in ue5-main branch]
2024-01-26 11:33:21 -05:00
virtual void HandleObjectsDeleted(TConstArrayView<FSoftObjectPath> ObjectPaths) override;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
New batch APIs to optimize UEFN project close times by deferring and batching: - Calls to OnPluginUnload (one GC call for all plugins) - Calls to FCollectionManager::HandleObjectDeleted (one UpdateCaches call at the end) #rb Dave.Belanger, Francis.Hurteau [FYI] Rex.Hill #rnx [CL 36757086 by nick verigakis in 5.5 branch]
2024-10-01 19:26:41 -04:00
virtual void SuppressObjectDeletionHandling() override;
virtual void ResumeObjectDeletionHandling() override;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when collections are created */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FCollectionCreatedEvent, FCollectionCreatedEvent );
UE4 Refactoring. Changed OVERRIDE and FINAL macros to keywords override and final. [CL 2104397 by Jaroslaw Palczynski in Main branch]
2014-06-13 06:14:46 -04:00
virtual FCollectionCreatedEvent& OnCollectionCreated() override { return CollectionCreatedEvent; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when collections are destroyed */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FCollectionDestroyedEvent, FCollectionDestroyedEvent );
UE4 Refactoring. Changed OVERRIDE and FINAL macros to keywords override and final. [CL 2104397 by Jaroslaw Palczynski in Main branch]
2014-06-13 06:14:46 -04:00
virtual FCollectionDestroyedEvent& OnCollectionDestroyed() override { return CollectionDestroyedEvent; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when assets are added to a collection */
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
virtual FOnAssetsAddedToCollection& OnAssetsAddedToCollection() override { return AssetsAddedToCollectionDelegate; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
/** Event for when assets are removed from a collection */
virtual FOnAssetsRemovedFromCollection& OnAssetsRemovedFromCollection() override { return AssetsRemovedFromCollectionDelegate; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when collections are renamed */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FCollectionRenamedEvent, FCollectionRenamedEvent );
UE4 Refactoring. Changed OVERRIDE and FINAL macros to keywords override and final. [CL 2104397 by Jaroslaw Palczynski in Main branch]
2014-06-13 06:14:46 -04:00
virtual FCollectionRenamedEvent& OnCollectionRenamed() override { return CollectionRenamedEvent; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
Added support for nested collections UETOOL-332 - Collections 2.0 UETOOL-369 - Want nested collections with collapsing We now have version 2 collections which maintain a persistent GUID for each collection. Existing collections will be lazily updated to this version when they need to be re-saved. This GUID is used by child collections to keep track their parents, and the collections view (as well as the quick asset management) now show a tree of collections. Collections in the main collection view tree can be re-parented via drag and drop. Performing Content Browser searches against a given collection will also test to see if an object exists in child collections, and the asset view will now show you folder entries for child collections when viewing a parent (if folders are enabled in your Content Browser view settings). [CL 2593321 by Jamie Dale in Main branch]
2015-06-19 07:33:02 -04:00
/** Event for when collections are re-parented */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FCollectionReparentedEvent, FCollectionReparentedEvent );
virtual FCollectionReparentedEvent& OnCollectionReparented() override { return CollectionReparentedEvent; }
Added status information to collections This shows a little colored pip to the right of the collection items, where each color means: Grey - Up-to-date and empty Green - Up-to-date and not empty Blue - Has local changes Orange - Not at the latest revision Red - Checked out by another user, in a conflicted state, or missing its source control provider This also adds an "Update" and "Save" option to the collections context menu. Typically these won't be needed as collections mostly manage themselves, but since we now show when a collection is out-of-date or dirty, it makes sense to allow the user to take action to correct these states without having to leave the editor. [CL 2610477 by Jamie Dale in Main branch]
2015-07-03 13:54:34 -04:00
/** Event for when collections is updated, or otherwise changed and we can't tell exactly how (eg, after updating from source control and merging) */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FCollectionUpdatedEvent, FCollectionUpdatedEvent );
virtual FCollectionUpdatedEvent& OnCollectionUpdated() override { return CollectionUpdatedEvent; }
Copying //UE4/Fortnite-Staging to Dev-Main (//UE4/Dev-Main) @ 4395008 #rb #rnx #lockdown Nick.Penwarden [CL 4395058 by Marc Audy in Main branch]
2018-09-25 10:11:35 -04:00
/** Event for when collections is updated, or otherwise changed and we can't tell exactly how (eg, after updating from source control and merging) */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FAddToCollectionCheckinDescriptionEvent, FAddToCollectionCheckinDescriptionEvent);
virtual FAddToCollectionCheckinDescriptionEvent& OnAddToCollectionCheckinDescriptionEvent() override { return AddToCollectionCheckinDescriptionEvent; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
private:
Added file watchers to detect when collections are changed outside of the collection manager UE-17782 - Editor must be restarted for New Collections to appear after syncing These use FFileCache to avoid detecting changes that are made by the collection manager itself. This also fixes some issues when merging collection sets together, and fixes some places where UI wouldn't update when a collection was changed due to an update or merge. [CL 2612319 by Jamie Dale in Main branch]
2015-07-07 10:31:39 -04:00
/** Tick this collection manager so it can process any file cache events */
bool TickFileCache(float InDeltaTime);
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
/** Loads all collection files from disk. Must only be called from constructor as it does not lock for the full duration. */
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
void LoadCollections();
/** Returns true if the specified share type requires source control */
bool ShouldUseSCC(ECollectionShareType::Type ShareType) const;
Added support for nested collections UETOOL-332 - Collections 2.0 UETOOL-369 - Want nested collections with collapsing We now have version 2 collections which maintain a persistent GUID for each collection. Existing collections will be lazily updated to this version when they need to be re-saved. This GUID is used by child collections to keep track their parents, and the collections view (as well as the quick asset management) now show a tree of collections. Collections in the main collection view tree can be re-parented via drag and drop. Performing Content Browser searches against a given collection will also test to see if an object exists in child collections, and the asset view will now show you folder entries for child collections when viewing a parent (if folders are enabled in your Content Browser view settings). [CL 2593321 by Jamie Dale in Main branch]
2015-06-19 07:33:02 -04:00
/** Given a collection name and share type, work out the full filename for the collection to use on disk */
FString GetCollectionFilename(const FName& InCollectionName, const ECollectionShareType::Type InCollectionShareType) const;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Adds a collection to the lookup maps */
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
bool AddCollection(FCollectionLock_Write& InGuard, const TSharedRef<FCollection>& CollectionRef, ECollectionShareType::Type ShareType);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Removes a collection from the lookup maps */
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
bool RemoveCollection(FCollectionLock_Write& InGuard, const TSharedRef<FCollection>& CollectionRef, ECollectionShareType::Type ShareType);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
Added status information to collections This shows a little colored pip to the right of the collection items, where each color means: Grey - Up-to-date and empty Green - Up-to-date and not empty Blue - Has local changes Orange - Not at the latest revision Red - Checked out by another user, in a conflicted state, or missing its source control provider This also adds an "Update" and "Save" option to the collections context menu. Typically these won't be needed as collections mostly manage themselves, but since we now show when a collection is out-of-date or dirty, it makes sense to allow the user to take action to correct these states without having to leave the editor. [CL 2610477 by Jamie Dale in Main branch]
2015-07-03 13:54:34 -04:00
/** Removes an object from any collections that contain it */
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
void RemoveObjectFromCollections(FCollectionLock_Write& InGuard, const FSoftObjectPath& ObjectPath, TArray<FCollectionNameType>& OutUpdatedCollections);
Added status information to collections This shows a little colored pip to the right of the collection items, where each color means: Grey - Up-to-date and empty Green - Up-to-date and not empty Blue - Has local changes Orange - Not at the latest revision Red - Checked out by another user, in a conflicted state, or missing its source control provider This also adds an "Update" and "Save" option to the collections context menu. Typically these won't be needed as collections mostly manage themselves, but since we now show when a collection is out-of-date or dirty, it makes sense to allow the user to take action to correct these states without having to leave the editor. [CL 2610477 by Jamie Dale in Main branch]
2015-07-03 13:54:34 -04:00
/** Replaces an object with another in any collections that contain it */
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
void ReplaceObjectInCollections(
FCollectionLock_Write& InGuard, const FSoftObjectPath& OldObjectPath, const FSoftObjectPath& NewObjectPath,
TArray<FCollectionNameType>& OutUpdatedCollections);
Added status information to collections This shows a little colored pip to the right of the collection items, where each color means: Grey - Up-to-date and empty Green - Up-to-date and not empty Blue - Has local changes Orange - Not at the latest revision Red - Checked out by another user, in a conflicted state, or missing its source control provider This also adds an "Update" and "Save" option to the collections context menu. Typically these won't be needed as collections mostly manage themselves, but since we now show when a collection is out-of-date or dirty, it makes sense to allow the user to take action to correct these states without having to leave the editor. [CL 2610477 by Jamie Dale in Main branch]
2015-07-03 13:54:34 -04:00
Update workflows for when not using Collection Setting AutoCommitOnSave * Only AddToCollection, RemoveFromCollection, SetColor and Reparent will not commit to perforce server if setting is off * Creating collections notably must commit otherwise it will not be added to a source control working set * Tunnelled the behaviour of submitting to SCC through the Internal helper function as it does not have the context to decide what workflow is running. #rb brooke.hubert, robert.millar [CL 31892830 by logan buchy in ue5-main branch]
2024-02-28 18:50:54 -05:00
/** Internal common functionality for saving a collection
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
* bForceCommitToRevisionControl - If the collection's storage mode will save it to source control, then
* bForceCommitToRevisionControl will ensure that it is committed after save. If this is false, then the collection
* will be left as a modified file which can be advantageous for slow source control servers.
Update workflows for when not using Collection Setting AutoCommitOnSave * Only AddToCollection, RemoveFromCollection, SetColor and Reparent will not commit to perforce server if setting is off * Creating collections notably must commit otherwise it will not be added to a source control working set * Tunnelled the behaviour of submitting to SCC through the Internal helper function as it does not have the context to decide what workflow is running. #rb brooke.hubert, robert.millar [CL 31892830 by logan buchy in ue5-main branch]
2024-02-28 18:50:54 -05:00
*/
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
bool InternalSaveCollection(FCollectionLock_Write&, const TSharedRef<FCollection>& CollectionRef, FText* OutError, bool bForceCommitToRevisionControl);
/*
* Internal version of IsValidParentCollection to avoid taking lock recursively.
* Cache must be updated for recursion before calling.
*/
bool IsValidParentCollection_Locked(FCollectionLock& InGuard, FName CollectionName, ECollectionShareType::Type ShareType, FName ParentCollectionName, ECollectionShareType::Type ParentShareType, FText* OutError) const;
/**
* Check if the given collection exists.
* Using the public API function risks acquiring the lock recursively.
*/
bool CollectionExists_Locked(FCollectionLock& InGuard, FName CollectionName, ECollectionShareType::Type ShareType) const;
Copying //UE4/Fortnite-Staging to Dev-Main (//UE4/Dev-Main) @ 4395008 #rb #rnx #lockdown Nick.Penwarden [CL 4395058 by Marc Audy in Main branch]
2018-09-25 10:11:35 -04:00
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
private:
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
/** Required for updating caches as well as write operations to collections */
mutable FRWLock Lock;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** The folders that contain collections */
FString CollectionFolders[ECollectionShareType::CST_All];
/** The extension used for collection files */
Making collection manager thread safe to allow future work to run content browser search in parallel. Deprecate GetLastError and replace with FText* output parameters on fallible methods. Use hierarchy of guard types to document access requirements for internal methods. Separate cache updates from cache access. Cache updates must be performed explicitly so that read->write lock update and possible preemption is clear. #rb logan.buchy [CL 33120048 by robert millar in ue5-main branch]
2024-04-19 18:17:59 -04:00
static FStringView CollectionExtension;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
Added file watchers to detect when collections are changed outside of the collection manager UE-17782 - Editor must be restarted for New Collections to appear after syncing These use FFileCache to avoid detecting changes that are made by the collection manager itself. This also fixes some issues when merging collection sets together, and fixes some places where UI wouldn't update when a collection was changed due to an update or merge. [CL 2612319 by Jamie Dale in Main branch]
2015-07-07 10:31:39 -04:00
/** Array of file cache instances that are watching for the collection files changing on disk */
TSharedPtr<DirectoryWatcher::FFileCache> CollectionFileCaches[ECollectionShareType::CST_All];
/** Delegate handle for the TickFileCache function */
deprecated FTicker and family and replaced by thread-safe FTSTicker #jira UE-120090 #rb francis.hurteau #ROBOMERGE-SOURCE: CL 17176325 in //UE5/Main/... #ROBOMERGE-BOT: STARSHIP (Main -> Release-Engine-Test) (v855-17104924) [CL 17176374 by andriy tylychko in ue5-release-engine-test branch]
2021-08-16 11:09:22 -04:00
FTSTicker::FDelegateHandle TickFileCacheDelegateHandle;
Added file watchers to detect when collections are changed outside of the collection manager UE-17782 - Editor must be restarted for New Collections to appear after syncing These use FFileCache to avoid detecting changes that are made by the collection manager itself. This also fixes some issues when merging collection sets together, and fixes some places where UI wouldn't update when a collection was changed due to an update or merge. [CL 2612319 by Jamie Dale in Main branch]
2015-07-07 10:31:39 -04:00
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** A map of collection names to FCollection objects */
Made the collection manager caching lazy This used to maintain an up-to-date cache as soon as a change happened. This lead to extra complexity in some cases, and often would keep caches up-to-date that weren't currently even being used. Adding, removing, or updating a collection will now just mark the relevant parts of the cache as dirty so that they can be updated (using a well defined, safe, full update) the next time something requests them. [CL 2610959 by Jamie Dale in Main branch]
2015-07-06 09:40:48 -04:00
TMap<FCollectionNameType, TSharedRef<FCollection>> AvailableCollections;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
New batch APIs to optimize UEFN project close times by deferring and batching: - Calls to OnPluginUnload (one GC call for all plugins) - Calls to FCollectionManager::HandleObjectDeleted (one UpdateCaches call at the end) #rb Dave.Belanger, Francis.Hurteau [FYI] Rex.Hill #rnx [CL 36757086 by nick verigakis in 5.5 branch]
2024-10-01 19:26:41 -04:00
TArray<FSoftObjectPath> DeferredDeletedObjects;
Change field declaration order to match required constructor initialization list order. [CL 33127370 by robert millar in ue5-main branch]
2024-04-19 23:27:11 -04:00
/** Cache of collection hierarchy, identity, etc */
TPimplPtr<FCollectionManagerCache> CollectionCache;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when assets are added to a collection */
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
FOnAssetsAddedToCollection AssetsAddedToCollectionDelegate;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when assets are removed from a collection */
Updating collection manager interface to use FSoftObjectPath for the paths of assets and objects rather than FName. #jira UE-161932 #rb julien.stjean #preflight https://horde.devtools.epicgames.com/job/6324e773f258fccf98de78cf [CL 22064625 by robert millar in ue5-main branch]
2022-09-16 20:57:34 -04:00
FOnAssetsRemovedFromCollection AssetsRemovedFromCollectionDelegate;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when collections are renamed */
FCollectionRenamedEvent CollectionRenamedEvent;
Added support for nested collections UETOOL-332 - Collections 2.0 UETOOL-369 - Want nested collections with collapsing We now have version 2 collections which maintain a persistent GUID for each collection. Existing collections will be lazily updated to this version when they need to be re-saved. This GUID is used by child collections to keep track their parents, and the collections view (as well as the quick asset management) now show a tree of collections. Collections in the main collection view tree can be re-parented via drag and drop. Performing Content Browser searches against a given collection will also test to see if an object exists in child collections, and the asset view will now show you folder entries for child collections when viewing a parent (if folders are enabled in your Content Browser view settings). [CL 2593321 by Jamie Dale in Main branch]
2015-06-19 07:33:02 -04:00
/** Event for when collections are re-parented */
FCollectionReparentedEvent CollectionReparentedEvent;
Added status information to collections This shows a little colored pip to the right of the collection items, where each color means: Grey - Up-to-date and empty Green - Up-to-date and not empty Blue - Has local changes Orange - Not at the latest revision Red - Checked out by another user, in a conflicted state, or missing its source control provider This also adds an "Update" and "Save" option to the collections context menu. Typically these won't be needed as collections mostly manage themselves, but since we now show when a collection is out-of-date or dirty, it makes sense to allow the user to take action to correct these states without having to leave the editor. [CL 2610477 by Jamie Dale in Main branch]
2015-07-03 13:54:34 -04:00
/** Event for when collections are updated, or otherwise changed and we can't tell exactly how (eg, after updating from source control and merging) */
FCollectionUpdatedEvent CollectionUpdatedEvent;
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when collections are created */
FCollectionCreatedEvent CollectionCreatedEvent;
/** Event for when collections are destroyed */
FCollectionDestroyedEvent CollectionDestroyedEvent;
Copying //UE4/Fortnite-Staging to Dev-Main (//UE4/Dev-Main) @ 4395008 #rb #rnx #lockdown Nick.Penwarden [CL 4395058 by Marc Audy in Main branch]
2018-09-25 10:11:35 -04:00
/** When a collection checkin happens, use this event to add additional text to the changelist description */
FAddToCollectionCheckinDescriptionEvent AddToCollectionCheckinDescriptionEvent;
#UE Add commandline option to avoid following redirectors in collections during startup. You sometimes want to make collections of redirectors when audting content #ROBOMERGE-AUTHOR: bob.tellez #ROBOMERGE-SOURCE: CL 18327503 via CL 18327514 via CL 18327529 via CL 18328464 via CL 18328574 #ROBOMERGE-BOT: STARSHIP (Release-Engine-Staging -> Release-Engine-Test) (v895-18170469) [CL 18328663 by bob tellez in ue5-release-engine-test branch]
2021-11-30 14:20:47 -05:00
New batch APIs to optimize UEFN project close times by deferring and batching: - Calls to OnPluginUnload (one GC call for all plugins) - Calls to FCollectionManager::HandleObjectDeleted (one UpdateCaches call at the end) #rb Dave.Belanger, Francis.Hurteau [FYI] Rex.Hill #rnx [CL 36757086 by nick verigakis in 5.5 branch]
2024-10-01 19:26:41 -04:00
/** Ref count for deferring calls to HandleObjectsDeleted. When the ref count reaches 0 we flush all deferred notifications */
std::atomic<int32> SuppressObjectDeletionRefCount = 0;
#UE Add commandline option to avoid following redirectors in collections during startup. You sometimes want to make collections of redirectors when audting content #ROBOMERGE-AUTHOR: bob.tellez #ROBOMERGE-SOURCE: CL 18327503 via CL 18327514 via CL 18327529 via CL 18328464 via CL 18328574 #ROBOMERGE-BOT: STARSHIP (Release-Engine-Staging -> Release-Engine-Test) (v895-18170469) [CL 18328663 by bob tellez in ue5-release-engine-test branch]
2021-11-30 14:20:47 -05:00
/** When true, redirectors will not be automatically followed in collections during startup */
bool bNoFixupRedirectors;
Collections code clean up UETOOL-332 - Collections 2.0 Removed some duplicated data from FCollection (AssetList and AssetSet) as they had to be manually kept in sync. Only AssetSet exists now, and is converted into an array and sorted before being written to disk (to keep the order consistent for diffing). DiskAssetList has also been converted into a set (now DiskAssetSet) as this is only ever used for lookup queries. All manually memory management has been removed from FCollectionManager, and the array of maps to collections has been converted into a single map using FCollectionNameType as its key. This simplifies collection lookup code in most cases, and removes the need to manually track the total number of collections outside of the map (NumCollections has now been removed). Renamed ICollectionManager::GetCollectionsContainingAsset to ICollectionManager::GetCollectionsContainingObject as the function checks for any objects, not just assets. Renamed FCollection::IsAssetInCollection to FCollection::IsObjectInCollection as the function checks for any objects, not just assets. Made ICollectionManager::IsCollectionEmpty const. Replaced all appropriate loop usage with range-based-for, and replaced any NULL with nullptr. [CL 2560621 by Jamie Dale in Main branch]
2015-05-21 07:43:16 -04:00
};
Reference in New Issue Copy Permalink