| FUObjectArray::FUObjectDeleteListener
|
Module |
|
Header |
/Engine/Source/Runtime/CoreUObject/Public/UObject/UObjectAnnotation.h |
Include |
#include "UObject/UObjectAnnotation.h" |
template<typename TAnnotation, bool bAutoRemove>
class FUObjectAnnotationSparse : public FUObjectArray::FUObjectDeleteListener
FUObjectAnnotationSparse is a helper class that is used to store sparse, slow, temporary, editor only, external or other low priority information about UObjects.
There is a notion of a default annotation and UObjects default to this annotation and this takes no storage.
Annotations are automatically cleaned up when UObjects are destroyed. Annotation are not "garbage collection aware", so it isn't safe to store pointers to other UObjects in an annotation unless external guarantees are made such that destruction of the other object removes the annotation.
Name | Description | |
---|---|---|
|
FUObjectAnnotationSparse() |
Constructor, initializes to nothing |
Name | Description | |
---|---|---|
|
~FUObjectAnnotationSparse() |
Destructor, removes all annotations, which removes the annotation as a uobject destruction listener |
Name | Description | ||
---|---|---|---|
|
AddAnnotation ( |
Add an annotation to the annotation list. |
|
|
AddAnnotation ( |
||
|
TAnnotation |
GetAndRemoveAnnotation ( |
Removes an annotation from the annotation list and returns the annotation if it had one |
|
TAnnotation |
GetAnnotation ( |
Return the annotation associated with a uobject |
|
const TMap< ... |
GetAnnotationMap() |
Return the annotation map. Caution, this is for low level use |
|
NotifyUObjectDeleted ( |
Interface for FUObjectAllocator::FUObjectDeleteListener |
|
|
RemoveAllAnnotations() |
Removes all annotation from the annotation list. |
|
|
RemoveAnnotation ( |
Removes an annotation from the annotation list. |
|
|
Reserve ( |
Reserves memory for the annotation map for the specified number of elements, used to avoid reallocations. |
Name | Description | ||
---|---|---|---|
|
OnUObjectArrayShutdown() |
Called when UObject Array is being shut down, this is where all listeners should be removed from it |