FObjectInstancingGraph Struct Reference

#include <Class.h>

Public Member Functions
COREUOBJECT_API	FObjectInstancingGraph (bool bDisableInstancing=false)
COREUOBJECT_API	FObjectInstancingGraph (EObjectInstancingGraphOptions InOptions)
COREUOBJECT_API	FObjectInstancingGraph (class UObject *DestinationSubobjectRoot, EObjectInstancingGraphOptions InOptions=EObjectInstancingGraphOptions::None)
bool	HasDestinationRoot () const
const UObject *	GetDestinationRoot () const
COREUOBJECT_API void	SetDestinationRoot (class UObject *DestinationSubobjectRoot, class UObject *InSourceRoot=nullptr)
COREUOBJECT_API class UObject *	GetDestinationObject (class UObject *SourceObject)
COREUOBJECT_API class UObject *	InstancePropertyValue (class UObject *SourceComponent, TNotNull< UObject * > CurrentValue, TNotNull< UObject * > Owner, EInstancePropertyValueFlags Flags=EInstancePropertyValueFlags::None)
COREUOBJECT_API void	AddNewObject (class UObject *ObjectInstance, class UObject *InArchetype=nullptr)
COREUOBJECT_API void	AddNewInstance (class UObject *ObjectInstance, class UObject *InArchetype=nullptr)
COREUOBJECT_API void	RetrieveObjectInstances (class UObject *SearchOuter, TArray< class UObject * > &out_Objects)
template<typename Predicate >
void	ForEachObjectInstance (Predicate Pred)
void	EnableSubobjectInstancing (bool bEnabled)
bool	IsSubobjectInstancingEnabled () const
void	SetLoadingObject (bool bIsLoading)
void	AddPropertyToSubobjectExclusionList (const FProperty *Property)
bool	IsPropertyInSubobjectExclusionList (const FProperty *Property) const

Constructor & Destructor Documentation

FObjectInstancingGraph() [1/3]

FObjectInstancingGraph::FObjectInstancingGraph ( bool  bDisableInstancing = false )

explicit

Default Constructor

Parameters

bDisableInstancing

- if true, start with component instancing disabled

FObjectInstancingGraph() [2/3]

FObjectInstancingGraph::FObjectInstancingGraph ( EObjectInstancingGraphOptions  InOptions )

explicit

Constructor with options

Parameters

InOptions

Additional options to modify the behavior of this graph

FObjectInstancingGraph() [3/3]

FObjectInstancingGraph::FObjectInstancingGraph ( class UObject *  DestinationSubobjectRoot, EObjectInstancingGraphOptions  InOptions = EObjectInstancingGraphOptions::None  )

explicit

Standard constructor

Parameters

DestinationSubobjectRoot	the top-level object that is being created
InOptions	Additional options to modify the behavior of this graph

Member Function Documentation

AddNewInstance()

void FObjectInstancingGraph::AddNewInstance	(	class UObject *	ObjectInstance,
		class UObject *	InArchetype = nullptr
	)

Adds an object instance to the map of source objects to their instances. If there is already a mapping for this object, it will be replaced and the value corresponding to ObjectInstance's archetype will now point to ObjectInstance.

Parameters

ObjectInstance	the object that should be added as the corresopnding instance for ObjectSource
InArchetype	Archetype of ObjectInstance

AddNewObject()

void FObjectInstancingGraph::AddNewObject	(	class UObject *	ObjectInstance,
		class UObject *	InArchetype = nullptr
	)

Adds a partially built object instance to the map(s) of source objects to their instances.

Parameters

ObjectInstance	Object that was just allocated, but has not been constructed yet
InArchetype	Archetype of ObjectInstance

AddPropertyToSubobjectExclusionList()

void FObjectInstancingGraph::AddPropertyToSubobjectExclusionList ( const FProperty *  Property )

inline

Adds a member variable property that should not instantiate subobjects

EnableSubobjectInstancing()

void FObjectInstancingGraph::EnableSubobjectInstancing ( bool  bEnabled )

inline

Enables / disables component instancing.

ForEachObjectInstance()

template<typename Predicate >

void FObjectInstancingGraph::ForEachObjectInstance ( Predicate  Pred )

inline

Allows looping over instances that were created during this instancing.

Parameters

Pred	the object to retrieve object instances for

GetDestinationObject()

UObject * FObjectInstancingGraph::GetDestinationObject

(

class UObject *

SourceObject

)

Finds the destination object instance corresponding to the specified source object.

Parameters

SourceObject

the object to find the corresponding instance for

GetDestinationRoot()

const UObject * FObjectInstancingGraph::GetDestinationRoot ( ) const

inline

Returns the DestinationRoot for this instancing graph.

HasDestinationRoot()

bool FObjectInstancingGraph::HasDestinationRoot ( ) const

inline

Returns whether this instancing graph has a valid destination root.

InstancePropertyValue()

UObject * FObjectInstancingGraph::InstancePropertyValue	(	class UObject *	SourceComponent,
		TNotNull< UObject * >	CurrentValue,
		TNotNull< UObject * >	Owner,
		EInstancePropertyValueFlags	Flags = EInstancePropertyValueFlags::None
	)

Returns the component that has SourceComponent as its archetype, instancing the component as necessary.

Parameters

SourceComponent	the component to find the corresponding component instance for
CurrentValue	the component currently assigned as the value for the component property being instanced. Used when updating archetypes to ensure that the new instanced component replaces the existing component instance in memory.
Owner	the object that owns the component property currently being instanced; this is NOT necessarily the object that should be the Outer for the new component.
Flags	reinstancing flags - see EInstancePropertyValueFlags

Returns

As with GetInstancedSubobject, above, but also deals with archetype creation and a few other special cases

IsPropertyInSubobjectExclusionList()

bool FObjectInstancingGraph::IsPropertyInSubobjectExclusionList ( const FProperty *  Property ) const

inline

Checks if a member variable property is in subobject instantiation exclusion list

IsSubobjectInstancingEnabled()

bool FObjectInstancingGraph::IsSubobjectInstancingEnabled ( ) const

inline

Returns whether component instancing is enabled

RetrieveObjectInstances()

void FObjectInstancingGraph::RetrieveObjectInstances	(	class UObject *	SearchOuter,
		TArray< class UObject * > &	out_Objects
	)

Retrieves a list of objects that have the specified Outer

Parameters

SearchOuter	the object to retrieve object instances for
out_Components	receives the list of objects contained by SearchOuter

SetDestinationRoot()

void FObjectInstancingGraph::SetDestinationRoot	(	class UObject *	DestinationSubobjectRoot,
		class UObject *	InSourceRoot = nullptr
	)

Sets the DestinationRoot for this instancing graph.

Parameters

DestinationSubobjectRoot	the top-level object that is being created
InSourceRoot	Archetype of DestinationSubobjectRoot

SetLoadingObject()

void FObjectInstancingGraph::SetLoadingObject ( bool  bIsLoading )

inline

Sets whether DestinationRoot is currently being loaded from disk.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h
• Engine/Source/Runtime/CoreUObject/Private/UObject/CoreNative.cpp