Module |
|
Header |
/Engine/Source/Developer/CollectionManager/Public/ICollectionManager.h |
Include |
#include "ICollectionManager.h" |
class ICollectionManager
Name | Description | |
---|---|---|
|
~ICollectionManager() |
Virtual destructor |
Name | Description | ||
---|---|---|---|
|
AddToCollection ( |
||
|
AddToCollection ( |
Adds an asset to the specified collection. |
|
|
CollectionExists ( |
Returns true if the collection exists |
|
|
CreateCollection ( |
Adds a collection to the asset registry. A .collection file will be added to disk. |
|
|
CreateUniqueCollectionName ( |
Creates a unique collection name for the given type taking the form BaseName+(unique number) |
|
|
DestroyCollection ( |
Removes a collection to the asset registry. A .collection file will be deleted from disk. |
|
|
EmptyCollection ( |
Removes all assets from the specified collection. |
|
|
GetAssetsInCollection ( |
Returns a list of asset paths found in the specified collection and share type |
|
|
GetChildCollectionNames ( |
Returns the list of child collections of the given collection that are also of the specified share type |
|
|
GetChildCollections ( |
Returns the list of child collections of the given collection |
|
|
GetClassesInCollection ( |
Returns a list of class paths found in the specified collection and share type |
|
|
GetCollectionColor ( |
Gets the optional color for the specified collection |
|
|
GetCollectionNames ( |
Returns the list of collection names of the specified share type |
|
|
GetCollections ( |
Returns the list of collections |
|
|
GetCollections ( |
Returns the list of collections with the given name |
|
|
GetCollectionsContainingObject ( |
Returns a list of collections in which the specified object exists |
|
|
GetCollectionsContainingObject ( |
Returns a list of collections in which the specified object exists of the specified share type |
|
|
GetCollectionsContainingObjects ( |
Returns a list of collections in which any of the specified objects exist |
|
|
GetCollectionsStringForObject ( |
Returns a string containing a comma separated list of collections in which the specified object exists of the specified share type |
|
|
GetCollectionStatusInfo ( |
Gets the status info for the specified collection |
|
|
GetCollectionStorageMode ( |
Gets the method by which the specified collection stores its objects (static or dynamic) |
|
|
GetDynamicQueryText ( |
Gets the dynamic query text for the specified collection. |
|
|
GetLastError() |
Returns the most recent error. |
|
|
GetObjectsInCollection ( |
Returns a list of object paths found in the specified collection and share type |
|
|
GetParentCollection ( |
Returns the parent collection of the given collection, or an unset value if there is no parent set |
|
|
GetRootCollectionNames ( |
Returns the list of root-level collection names of the specified share type |
|
|
GetRootCollections ( |
Returns the list of root-level collections |
|
|
HandleFixupRedirectors ( |
Called to notify the collections that they should fix-up their object references so that they no longer contain any redirectors References are only updated in-memory, and won't be saved to disk until a redirector is deleted (which forces our hand), or the collection is saved for any other reason |
|
|
HandleObjectDeleted ( |
Called to notify the collections that an object has been deleted |
|
|
HandleObjectRenamed |
Called to notify the collections that an object has been renamed or moved |
|
|
HandleRedirectorDeleted ( |
Called to notify the collections that a redirector has been deleted and that they should ensure their on-disk representation is re-saved with the fixed up in-memory version |
|
|
HasCollectionColors ( |
Checks whether any collections have a custom color set, optionally retrieving the list of in-use colors |
|
|
HasCollections() |
Returns whether or not the collection manager contains any collections |
|
|
IsObjectInCollection ( |
Check to see if the given object exists in the given collection |
|
|
IsValidCollectionName ( |
Returns whether or not the given collection name is valid. |
|
|
IsValidParentCollection ( |
Check to see if the given collection is valid to be used as the parent of another collection. |
|
|
FAddToCollec... |
OnAddToCollectionCheckinDescriptionEvent() |
|
|
FAssetsAdded... |
OnAssetsAdded() |
|
|
FAssetsRemov... |
OnAssetsRemoved() |
|
|
FCollectionC... |
OnCollectionCreated() |
|
|
FCollectionD... |
OnCollectionDestroyed() |
|
|
FCollectionR... |
OnCollectionRenamed() |
|
|
FCollectionR... |
OnCollectionReparented() |
|
|
FCollectionU... |
OnCollectionUpdated() |
|
|
RemoveFromCollection ( |
Removes the asset from the specified collection. |
|
|
RemoveFromCollection ( |
||
|
RenameCollection ( |
Renames a collection. |
|
|
ReparentCollection ( |
Re-parents a collection. |
|
|
SaveCollection ( |
Save the collection (if dirty) and check it into source control (if under SCC control) |
|
|
SetCollectionColor ( |
Sets the optional color for the specified collection |
|
|
SetDynamicQueryText ( |
Sets the dynamic query text for the specified collection. |
|
|
TestDynamicQuery ( |
Tests the dynamic query for the specified collection against the context provided. |
|
|
UpdateCollection ( |
Update the collection to make sure it's using the latest version from source control (if under SCC control) |
Name |
Description |
|
---|---|---|
|
FAddToCollectionCheckinDescriptionEvent |
When a collection checkin happens, use this event to add additional text to the changelist description |
|
FAssetsAddedEvent |
Event for when assets are added to a collection |
|
FAssetsRemovedEvent |
Event for when assets are removed from a collection |
|
FCollectionCreatedEvent |
Event for when collections are created |
|
FCollectionDestroyedEvent |
Event for when collections are destroyed |
|
FCollectionRenamedEvent |
Event for when collections are renamed |
|
FCollectionReparentedEvent |
Event for when collections are re-parented (params: Collection, OldParent, NewParent) |
|
FCollectionUpdatedEvent |
Event for when collections is updated, or otherwise changed and we can't tell exactly how (eg, after updating from source control and merging) |