UE::GC::TDefaultCollector< ProcessorType > Class Template Reference

#include <FastReferenceCollector.h>

Inheritance diagram for UE::GC::TDefaultCollector< ProcessorType >:

Public Member Functions
	TDefaultCollector (ProcessorType &InProcessor, UE::GC::FWorkerContext &InContext)
virtual void	HandleObjectReference (UObject *&Object, const UObject *ReferencingObject, const FProperty *ReferencingProperty) override
virtual void	HandleObjectReferences (UObject **InObjects, const int32 ObjectNum, const UObject *ReferencingObject, const FProperty *InReferencingProperty) override
virtual bool	IsIgnoringArchetypeRef () const override
virtual bool	IsIgnoringTransient () const override
Public Member Functions inherited from FReferenceCollector
virtual COREUOBJECT_API	~FReferenceCollector ()
virtual COREUOBJECT_API void	AddStableReference (TObjectPtr< UObject > *Object)
virtual COREUOBJECT_API void	AddStableReferenceArray (TArray< TObjectPtr< UObject > > *Objects)
virtual COREUOBJECT_API void	AddStableReferenceSet (TSet< TObjectPtr< UObject > > *Objects)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddStableReferenceMap (TMapBase< KeyType, ValueType, Allocator, KeyFuncs > &Map)
virtual COREUOBJECT_API void	AddStableReference (UObject **Object)
virtual COREUOBJECT_API void	AddStableReferenceArray (TArray< UObject * > *Objects)
virtual COREUOBJECT_API void	AddStableReferenceSet (TSet< UObject * > *Objects)
template<class UObjectType >
void	AddStableReference (UObjectType **Object)
template<class UObjectType >
void	AddStableReferenceArray (TArray< UObjectType * > *Objects)
template<class UObjectType >
void	AddStableReferenceSet (TSet< UObjectType * > *Objects)
template<class UObjectType >
UE_FORCEINLINE_HINT void	AddStableReference (TObjectPtr< UObjectType > *Object)
template<class UObjectType >
UE_FORCEINLINE_HINT void	AddStableReferenceArray (TArray< TObjectPtr< UObjectType > > *Objects)
template<class UObjectType >
UE_FORCEINLINE_HINT void	AddStableReferenceSet (TSet< TObjectPtr< UObjectType > > *Objects)
template<class UObjectType >
void	AddReferencedObject (UObjectType *&Object, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObject (const UObjectType *&Object, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObjects (TArray< UObjectType * > &ObjectArray, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObjects (TArray< const UObjectType * > &ObjectArray, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObjects (TSet< UObjectType * > &ObjectSet, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddReferencedObjects (TMapBase< KeyType *, ValueType, Allocator, KeyFuncs > &Map, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddReferencedObjects (TMapBase< KeyType, ValueType *, Allocator, KeyFuncs > &Map, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddReferencedObjects (TMapBase< KeyType *, ValueType *, Allocator, KeyFuncs > &Map, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObject (TObjectPtr< UObjectType > &Object, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObject (TObjectPtr< const UObjectType > &Object, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObjects (TArray< TObjectPtr< UObjectType > > &ObjectArray, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObjects (TArray< TObjectPtr< const UObjectType > > &ObjectArray, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<class UObjectType >
void	AddReferencedObjects (TSet< TObjectPtr< UObjectType > > &ObjectSet, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddReferencedObjects (TMapBase< TObjectPtr< KeyType >, ValueType, Allocator, KeyFuncs > &Map, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddReferencedObjects (TMapBase< KeyType, TObjectPtr< ValueType >, Allocator, KeyFuncs > &Map, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename KeyType , typename ValueType , typename Allocator , typename KeyFuncs >
void	AddReferencedObjects (TMapBase< TObjectPtr< KeyType >, TObjectPtr< ValueType >, Allocator, KeyFuncs > &Map, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
template<typename T >
void	AddReferencedObject (TWeakObjectPtr< T > &P, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
COREUOBJECT_API void	AddReferencedObject (FWeakObjectPtr &P, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
COREUOBJECT_API void	AddReferencedObjects (const UScriptStruct *&ScriptStruct, void *Instance, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
COREUOBJECT_API void	AddReferencedObjects (TObjectPtr< const UScriptStruct > &ScriptStruct, void *Instance, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
COREUOBJECT_API void	AddReferencedObjects (TWeakObjectPtr< const UScriptStruct > &ScriptStruct, void *Instance, const UObject *ReferencingObject=nullptr, const FProperty *ReferencingProperty=nullptr)
COREUOBJECT_API void	AddPropertyReferences (const UStruct *Struct, void *Instance, const UObject *ReferencingObject=nullptr)
COREUOBJECT_API void	AddPropertyReferencesWithStructARO (const UScriptStruct *Struct, void *Instance, const UObject *ReferencingObject=nullptr)
COREUOBJECT_API void	AddPropertyReferencesWithStructARO (const UClass *Class, void *Instance, const UObject *ReferencingObject=nullptr)
COREUOBJECT_API void	AddPropertyReferencesLimitedToObjectProperties (const UStruct *Struct, void *Instance, const UObject *ReferencingObject=nullptr)
virtual bool	NeedsPropertyReferencer () const
virtual void	AllowEliminatingReferences (bool bAllow)
virtual void	SetSerializedProperty (class FProperty *Inproperty)
virtual class FProperty *	GetSerializedProperty () const
virtual bool	MarkWeakObjectReferenceForClearing (UObject **WeakReference, UObject *ReferenceOwner)
virtual void	SetIsProcessingNativeReferences (bool bIsNative)
virtual bool	IsProcessingNativeReferences () const
virtual bool	NeedsInitialReferences () const
FReferenceCollectorArchive &	GetVerySlowReferenceCollectorArchive ()

Protected Attributes
ProcessorType &	Processor
UE::GC::FWorkerContext &	Context

Additional Inherited Members
Protected Member Functions inherited from FReferenceCollector
virtual COREUOBJECT_API void	HandleObjectReferences (FObjectPtr *InObjects, const int32 ObjectNum, const UObject *InReferencingObject, const FProperty *InReferencingProperty)

Detailed Description

template<typename ProcessorType>
class UE::GC::TDefaultCollector< ProcessorType >

Default reference collector for CollectReferences()

Constructor & Destructor Documentation

TDefaultCollector()

template<typename ProcessorType >

UE::GC::TDefaultCollector< ProcessorType >::TDefaultCollector ( ProcessorType &  InProcessor, UE::GC::FWorkerContext &  InContext  )

inline

Member Function Documentation

HandleObjectReference()

template<typename ProcessorType >

virtual void UE::GC::TDefaultCollector< ProcessorType >::HandleObjectReference ( UObject *&  InObject, const UObject *  InReferencingObject, const FProperty *  InReferencingProperty  )

inlineoverridevirtual

Handle object reference. Called by AddReferencedObject.

Parameters

Object	Referenced object.
ReferencingObject	Referencing object (if available).
ReferencingProperty	Referencing property (if available).

Implements FReferenceCollector.

HandleObjectReferences()

template<typename ProcessorType >

virtual void UE::GC::TDefaultCollector< ProcessorType >::HandleObjectReferences ( UObject **  InObjects, const int32  ObjectNum, const UObject *  InReferencingObject, const FProperty *  InReferencingProperty  )

inlineoverridevirtual

Handle multiple object references. Called by AddReferencedObjects. DEFAULT IMPLEMENTATION IS SLOW as it calls HandleObjectReference multiple times. In order to optimize it, provide your own implementation.

Parameters

Object	Referenced object.
ReferencingObject	Referencing object (if available).
ReferencingProperty	Referencing property (if available).

Reimplemented from FReferenceCollector.

IsIgnoringArchetypeRef()

template<typename ProcessorType >

virtual bool UE::GC::TDefaultCollector< ProcessorType >::IsIgnoringArchetypeRef ( ) const

inlineoverridevirtual

If true archetype references should not be added to this collector.

Implements FReferenceCollector.

IsIgnoringTransient()

template<typename ProcessorType >

virtual bool UE::GC::TDefaultCollector< ProcessorType >::IsIgnoringTransient ( ) const

inlineoverridevirtual

If true transient objects should not be added to this collector.

Implements FReferenceCollector.

Member Data Documentation

Context

template<typename ProcessorType >

UE::GC::FWorkerContext& UE::GC::TDefaultCollector< ProcessorType >::Context

protected

Processor

template<typename ProcessorType >

ProcessorType& UE::GC::TDefaultCollector< ProcessorType >::Processor

protected

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/CoreUObject/Public/UObject/FastReferenceCollector.h