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

237 lines
14 KiB
C
Raw Normal View History

Update copyright notices to 2015. [CL 2379638 by Ben Marsh in Main branch]
2014-12-07 19:09:38 -05:00
// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
#pragma once
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
namespace DirectoryWatcher { class FFileCache; }
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;
};
typedef TMap<FCollectionNameType, TSharedRef<FCollection>> FAvailableCollectionsMap;
typedef TMap<FGuid, FCollectionNameType> FGuidToCollectionNamesMap;
typedef TMap<FName, TArray<FObjectCollectionInfo>> FCollectionObjectsMap;
typedef TMap<FGuid, TArray<FGuid>> FCollectionHierarchyMap;
/** Wraps up the lazy caching of the collection manager */
class FCollectionManagerCache
{
public:
FCollectionManagerCache(FAvailableCollectionsMap& InAvailableCollections);
/** Dirty the parts of the cache that need to change when a collection is added to our collection manager */
void HandleCollectionAdded();
/** Dirty the parts of the cache that need to change when a collection is removed from our collection manager */
void HandleCollectionRemoved();
/** Dirty the parts of the cache that need to change when a collection is modified */
void HandleCollectionChanged();
/** Access the CachedCollectionNamesFromGuids map, ensuring that it is up-to-date */
const FGuidToCollectionNamesMap& GetCachedCollectionNamesFromGuids() const;
/** Access the CachedObjects map, ensuring that it is up-to-date */
const FCollectionObjectsMap& GetCachedObjects() const;
/** Access the CachedHierarchy map, ensuring that it is up-to-date */
const FCollectionHierarchyMap& GetCachedHierarchy() const;
enum class ERecursiveWorkerFlowControl : uint8
{
Stop,
Continue,
};
typedef TFunctionRef<ERecursiveWorkerFlowControl(const FCollectionNameType&, ECollectionRecursionFlags::Flag)> FRecursiveWorkerFunc;
void RecursionHelper_DoWork(const FCollectionNameType& InCollectionKey, const ECollectionRecursionFlags::Flags InRecursionMode, const FRecursiveWorkerFunc& InWorkerFunc) const;
ERecursiveWorkerFlowControl RecursionHelper_DoWorkOnParents(const FCollectionNameType& InCollectionKey, const FRecursiveWorkerFunc& InWorkerFunc) const;
ERecursiveWorkerFlowControl RecursionHelper_DoWorkOnChildren(const FCollectionNameType& InCollectionKey, const FRecursiveWorkerFunc& InWorkerFunc) const;
private:
/** Reference to the collections that are currently available in our owner collection manager */
FAvailableCollectionsMap& AvailableCollections;
/** A map of collection GUIDs to their associated collection names */
mutable FGuidToCollectionNamesMap CachedCollectionNamesFromGuids_Internal;
/** A map of object paths to their associated collection info - only objects that are in collections will appear in here */
mutable FCollectionObjectsMap CachedObjects_Internal;
/** A map of parent collection GUIDs to their child collection GUIDs - only collections that have children will appear in here */
mutable FCollectionHierarchyMap CachedHierarchy_Internal;
/** Flag to say whether the CachedCollectionNamesFromGuids map is dirty */
mutable bool bIsCachedCollectionNamesFromGuidsDirty : 1;
/** Flag to say whether the CachedObjects map is dirty */
mutable bool bIsCachedObjectsDirty : 1;
/** Flag to say whether the CachedHierarchy map is dirty */
mutable bool bIsCachedHierarchyDirty : 1;
};
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
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;
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;
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 bool GetAssetsInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FName>& AssetPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual bool GetObjectsInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FName>& ObjectPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual bool GetClassesInCollection(FName CollectionName, ECollectionShareType::Type ShareType, TArray<FName>& ClassPaths, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual void GetCollectionsContainingObject(FName ObjectPath, ECollectionShareType::Type ShareType, TArray<FName>& OutCollectionNames, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual void GetCollectionsContainingObject(FName ObjectPath, TArray<FCollectionNameType>& OutCollections, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual void GetCollectionsContainingObjects(const TArray<FName>& ObjectPaths, TMap<FCollectionNameType, TArray<FName>>& OutCollectionsAndMatchedObjects, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual FString GetCollectionsStringForObject(FName ObjectPath, ECollectionShareType::Type ShareType, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) 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;
Added stricter validation for collection names UE-17561 - Collections allow for several special characters that are not normally allowed UE-17549 - User gets no warning for invalid Characters when naming a Collection UE-17538 - Add a Character limit for naming a collection The list of valid characters now matches that of assets and folders in the Content Browser, and the user is informed when they try and use an invalid character. The collection name is also now restricted to NAME_SIZE to avoid a crash if a user entered a name that was too long. [CL 2609261 by Jamie Dale in Main branch]
2015-07-02 12:20:22 -04:00
virtual bool IsValidCollectionName(const FString& CollectionName, ECollectionShareType::Type ShareType) const override;
Added support for dynamic collections UETOOL-332 - Collections 2.0 UETOOL-401 - Add support for dynamic collections These collections can be created from a text search in the Content Browser, and allow you to store a search query so it can be reused or shared. They have some limitations compared to static collections: - As they never know what objects they actually contain, they can't be displayed in the "Collections" list in asset tooltips. - They cannot contain child collections. [CL 2615029 by Jamie Dale in Main branch]
2015-07-09 09:59:51 -04:00
virtual bool CreateCollection(FName CollectionName, ECollectionShareType::Type ShareType, ECollectionStorageMode::Type StorageMode) 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 RenameCollection(FName CurrentCollectionName, ECollectionShareType::Type CurrentShareType, FName NewCollectionName, ECollectionShareType::Type NewShareType) 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 bool ReparentCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ParentCollectionName, ECollectionShareType::Type ParentShareType) 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 DestroyCollection(FName CollectionName, ECollectionShareType::Type ShareType) override;
virtual bool AddToCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ObjectPath) override;
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
virtual bool AddToCollection(FName CollectionName, ECollectionShareType::Type ShareType, const TArray<FName>& ObjectPaths, int32* OutNumAdded = nullptr) 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 RemoveFromCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ObjectPath) override;
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
virtual bool RemoveFromCollection(FName CollectionName, ECollectionShareType::Type ShareType, const TArray<FName>& ObjectPaths, int32* OutNumRemoved = nullptr) override;
Added support for dynamic collections UETOOL-332 - Collections 2.0 UETOOL-401 - Add support for dynamic collections These collections can be created from a text search in the Content Browser, and allow you to store a search query so it can be reused or shared. They have some limitations compared to static collections: - As they never know what objects they actually contain, they can't be displayed in the "Collections" list in asset tooltips. - They cannot contain child collections. [CL 2615029 by Jamie Dale in Main branch]
2015-07-09 09:59:51 -04:00
virtual bool SetDynamicQueryText(FName CollectionName, ECollectionShareType::Type ShareType, const FString& InQueryText) override;
virtual bool GetDynamicQueryText(FName CollectionName, ECollectionShareType::Type ShareType, FString& OutQueryText) const override;
Dynamic collections can now be referenced in the Content Browser text filters UETOOL-332 - Collections 2.0 UETOOL-401 - Add support for dynamic collections You can now reference both static and dynamic collections in the Content Browser text filter, including recursive references (the evaluator guards against cyclic collection references). The text filter now recursively gathers up any dynamic collection references when the filter text is changed. These are then tested depth first as sub-expressions against each object, to see whether the object is "contained" within the given dynamic collection. [CL 2615416 by Jamie Dale in Main branch]
2015-07-09 14:24:02 -04:00
virtual bool TestDynamicQuery(FName CollectionName, ECollectionShareType::Type ShareType, const ITextFilterExpressionContext& InContext, bool& OutResult) 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 EmptyCollection(FName CollectionName, ECollectionShareType::Type ShareType) override;
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
virtual bool SaveCollection(FName CollectionName, ECollectionShareType::Type ShareType) override;
virtual bool UpdateCollection(FName CollectionName, ECollectionShareType::Type ShareType) override;
virtual bool GetCollectionStatusInfo(FName CollectionName, ECollectionShareType::Type ShareType, FCollectionStatusInfo& OutStatusInfo) const override;
Added support for dynamic collections UETOOL-332 - Collections 2.0 UETOOL-401 - Add support for dynamic collections These collections can be created from a text search in the Content Browser, and allow you to store a search query so it can be reused or shared. They have some limitations compared to static collections: - As they never know what objects they actually contain, they can't be displayed in the "Collections" list in asset tooltips. - They cannot contain child collections. [CL 2615029 by Jamie Dale in Main branch]
2015-07-09 09:59:51 -04:00
virtual bool GetCollectionStorageMode(FName CollectionName, ECollectionShareType::Type ShareType, ECollectionStorageMode::Type& OutStorageMode) 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 bool IsObjectInCollection(FName ObjectPath, FName CollectionName, ECollectionShareType::Type ShareType, ECollectionRecursionFlags::Flags RecursionMode = ECollectionRecursionFlags::Self) const override;
virtual bool IsValidParentCollection(FName CollectionName, ECollectionShareType::Type ShareType, FName ParentCollectionName, ECollectionShareType::Type ParentShareType) 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 FText GetLastError() const override { return LastError; }
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;
virtual bool HandleRedirectorDeleted(const FName& ObjectPath) override;
virtual void HandleObjectRenamed(const FName& OldObjectPath, const FName& NewObjectPath) override;
virtual void HandleObjectDeleted(const FName& ObjectPath) 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 */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FAssetsAddedEvent, FAssetsAddedEvent );
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 FAssetsAddedEvent& OnAssetsAdded() override { return AssetsAddedEvent; }
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Event for when assets are removed to a collection */
DECLARE_DERIVED_EVENT( FCollectionManager, ICollectionManager::FAssetsRemovedEvent, FAssetsRemovedEvent );
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 FAssetsRemovedEvent& OnAssetsRemoved() override { return AssetsRemovedEvent; }
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; }
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);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** Loads all collection files from disk */
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 */
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
bool AddCollection(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 */
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
bool RemoveCollection(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 */
void RemoveObjectFromCollections(const FName& ObjectPath, TArray<FCollectionNameType>& OutUpdatedCollections);
/** Replaces an object with another in any collections that contain it */
void ReplaceObjectInCollections(const FName& OldObjectPath, const FName& NewObjectPath, TArray<FCollectionNameType>& OutUpdatedCollections);
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
private:
/** The folders that contain collections */
FString CollectionFolders[ECollectionShareType::CST_All];
/** The extension used for collection files */
FString CollectionExtension;
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 */
FDelegateHandle TickFileCacheDelegateHandle;
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
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
/** The lazily updated cache for this collection manager */
FCollectionManagerCache CollectionCache;
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
Engine source (Main branch up to CL 2026164)
2014-03-14 14:13:41 -04:00
/** The most recent error that occurred */
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
mutable FText LastError;
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 */
FAssetsAddedEvent AssetsAddedEvent;
/** Event for when assets are removed from a collection */
FAssetsRemovedEvent AssetsRemovedEvent;
/** 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;
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