1. Epic GamesDeveloper
  3. FObjectInstancingGraph

FObjectInstancingGraph

API > API/Runtime > API/Runtime/CoreUObject

   
Name FObjectInstancingGraph
Type struct
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h
Include Path #include "UObject/Class.h"

Syntax

struct FObjectInstancingGraph

Constructors

Name Remarks Include Path Unreal Specifiers

FObjectInstancingGraph ( bool bDisableInstancing
)

 Default Constructor UObject/Class.h  
Constructor with options UObject/Class.h  

FObjectInstancingGraph ( UObject* DestinationSubobjectRoot,
EObjectInstancingGraphOptions InOptions
)

 Standard constructor UObject/Class.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCreatingArchetype bool Indicates whether we are currently instancing components for an archetype. UObject/Class.h  
bLoadingObject bool True when loading object data from disk. UObject/Class.h  
DestinationRoot UObject * The root of the object tree that is the destination used for instancing components UObject/Class.h  
DestinationToSourceMap TMap< class UObject *, class UObject * > Reverse maps the destination back to the source for dynamic instancing UObject/Class.h  
InstancingOptions EObjectInstancingGraphOptions Subobject instancing options UObject/Class.h  
SourceRoot UObject * The root of the object tree that is the source used for instancing components; UObject/Class.h  
SourceToDestinationMap TMap< class UObject *, class UObject * > Maps the source (think archetype) to the destination (think instance) UObject/Class.h  
SubobjectInstantiationExclusionList TSet< const FProperty * > List of member variable properties that should not instantiate subobjects UObject/Class.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddNewInstance ( UObject* ObjectInstance,
UObject* InArchetype
)

 Adds an object instance to the map of source objects to their instances. UObject/Class.h  

void AddNewObject ( UObject* ObjectInstance,
UObject* InArchetype
)

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

void AddPropertyToSubobjectExclusionList ( const FProperty* Property
)

 Adds a member variable property that should not instantiate subobjects UObject/Class.h  

void EnableSubobjectInstancing ( bool bEnabled
)

 Enables / disables component instancing. UObject/Class.h  

void ForEachObjectInstance ( Predicate Pred
)

 Allows looping over instances that were created during this instancing. UObject/Class.h  

UObject * GetDestinationObject ( UObject* SourceObject
)

 Finds the destination object instance corresponding to the specified source object. UObject/Class.h  

const UObject * GetDestinationRoot()

 Returns the DestinationRoot for this instancing graph. UObject/Class.h  

bool HasDestinationRoot()

 Returns whether this instancing graph has a valid destination root. UObject/Class.h  

UObject * InstancePropertyValue ( UObject* SourceComponent,
TNotNull< UObject* > CurrentValue,
TNotNull< UObject* > Owner,
EInstancePropertyValueFlags Flags
)

 Returns the component that has SourceComponent as its archetype, instancing the component as necessary. UObject/Class.h  

bool IsPropertyInSubobjectExclusionList ( const FProperty* Property
) const

 Checks if a member variable property is in subobject instantiation exclusion list UObject/Class.h  

bool IsSubobjectInstancingEnabled()

 Returns whether component instancing is enabled UObject/Class.h  

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

 Retrieves a list of objects that have the specified Outer UObject/Class.h  

void SetDestinationRoot ( UObject* DestinationSubobjectRoot,
UObject* InSourceRoot
)

 Sets the DestinationRoot for this instancing graph. UObject/Class.h  

void SetLoadingObject ( bool bIsLoading
)

 Sets whether DestinationRoot is currently being loaded from disk. UObject/Class.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page