1. Epic GamesDeveloper
  3. UInterchangeBaseNodeContainer

UInterchangeBaseNodeContainer

The Interchange [UInterchangeBaseNode](API\Runtime\InterchangeCore\UInterchangeBaseNode) graph is a format used to feed factories and writers when they import, reimport, and export an asset or scene.

API > API/Runtime > API/Runtime/InterchangeCore

The Interchange UInterchangeBaseNode graph is a format used to feed factories and writers when they import, reimport, and export an asset or scene.

This container holds a flat list of all nodes that have been translated from the source data. Translators fill this container, and the import/export managers read it to execute the import/export process.

   
Name UInterchangeBaseNodeContainer
Type class
Header File /Engine/Source/Runtime/Interchange/Core/Public/Nodes/InterchangeBaseNodeContainer.h
Include Path #include "Nodes/InterchangeBaseNodeContainer.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInterchangeBaseNodeContainer : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UInterchangeBaseNodeContainer()

   Nodes/InterchangeBaseNodeContainer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChildrenCache TMap< FString, TArray< FString > >   Nodes/InterchangeBaseNodeContainer.h  
Nodes TMap< FString, TObjectPtr< UInterchangeBaseNode > > Flat List of the nodes. Since the nodes are variable size, we store a pointer. Nodes/InterchangeBaseNodeContainer.h
  • VisibleAnywhere
  • Category="Interchange | Node Container"

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString AddNode ( UInterchangeBaseNode* Node
)

 Add a node to the container. The node is added into a TMap. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

bool BreakableIterateNodeChildren ( const FString& NodeUniqueID,
TFunctionRef< bool(const UInterchangeBaseNode*)> IterationLambda
) const

 Recursively traverse the hierarchy starting with the specified node unique ID. Nodes/InterchangeBaseNodeContainer.h  

void BreakableIterateNodes ( TFunctionRef< bool(const FString&, UInterchangeBaseNode*)> IterationLambda
) const

 Unordered iteration of the all nodes, but can be stopped early by returning true. Nodes/InterchangeBaseNodeContainer.h  

void BreakableIterateNodesOfType ( TFunctionRef< bool(const FString&, T*)> IterationLambda
) const

   Nodes/InterchangeBaseNodeContainer.h  

bool ClearNodeParentUid ( const FString& NodeUniqueID
)

 Remove the node's ParentUid, making it into a top-level node Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void ComputeChildrenCache()

 Fill the cache of children UIDs to optimize the GetNodeChildrenUids call. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

TArray< FString > * GetCachedNodeChildrenUids ( const FString& NodeUniqueID
) const

   Nodes/InterchangeBaseNodeContainer.h  

TMap< FString, TArray< FString > > & GetChildrenCache()

 Gets the children cache. Nodes/InterchangeBaseNodeContainer.h  

UInterchangeFactoryBaseNode * GetFactoryNode ( const FString& NodeUniqueID
) const

 Get a factory node pointer. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

bool GetIsAncestor ( const FString& NodeUniqueID,
const FString& AncestorUID
) const

 Checks if ParentNodeUID is an ancestor. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node"

const UInterchangeBaseNode * GetNode ( const FString& NodeUniqueID
) const

 Get a node pointer. Once added to the container, nodes are considered const. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

UInterchangeBaseNode * GetNodeChildren ( const FString& NodeUniqueID,
int32 ChildIndex
)

 Get the nth const child of the node Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

const UInterchangeBaseNode * GetNodeChildren ( const FString& NodeUniqueID,
int32 ChildIndex
) const

 Get the nth const child of the node. Const version. Nodes/InterchangeBaseNodeContainer.h  

int32 GetNodeChildrenCount ( const FString& NodeUniqueID
) const

 Get the number of children the node has. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

TArray< FString > GetNodeChildrenUids ( const FString& NodeUniqueID
) const

 Get the UIDs of all the node's children. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void GetNodes ( const UClass* ClassNode,
TArray< FString >& OutNodes
) const

 Return all nodes that are of the ClassNode type. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void GetNodeUIDsOfType ( TArray< FString >& OutNodeUIDs
) const

   Nodes/InterchangeBaseNodeContainer.h  

void GetRoots ( TArray< FString >& RootNodes
) const

 Return all nodes that do not have any parent. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

bool IsNodeUidValid ( const FString& NodeUniqueID
) const

 Return true if the node unique ID exists in the container. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void IterateNodeChildren ( const FString& NodeUniqueID,
TFunctionRef< void(const UInterchangeBaseNode*)> IterationLambda
) const

 Recursively traverse the hierarchy starting with the specified node unique ID. Nodes/InterchangeBaseNodeContainer.h  

void IterateNodes ( TFunctionRef< void(const FString&, UInterchangeBaseNode*)> IterationLambda
) const

 Unordered iteration of the all nodes. Nodes/InterchangeBaseNodeContainer.h  

void IterateNodesOfType ( TFunctionRef< void(const FString&, T*)> IterationLambda
) const

   Nodes/InterchangeBaseNodeContainer.h  

void LoadFromFile ( const FString& Filename
)

 Serialize the node container from the specified file. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void RemoveNode ( const FString& NodeUniqueID
)

 Removes node from Nodes map with the given NodeUniqueID. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void ReplaceNode ( const FString& NodeUniqueID,
UInterchangeFactoryBaseNode* NewNode
)

   Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void Reset()

 Empty the container. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void ResetChildrenCache()

 Reset the cache of children UIDs. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void SaveToFile ( const FString& Filename
)

 Serialize the node container into the specified file. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"
This function serializes the node container and all node sub-objects it points . Nodes/InterchangeBaseNodeContainer.h  

void SetChildrenCache ( const TMap< FString, TArray< FString > >& InChildrenCache
)

 Sets the children cache from an incoming data set. Nodes/InterchangeBaseNodeContainer.h  

void SetNamespace ( const FString& Namespace,
UClass* TargetClass
)

 Set a namespace to all node of the target class in this container. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

bool SetNodeDesiredChildIndex ( const FString& NodeUniqueID,
const int32& NewNodeDesiredChildIndex
)

 Set the desired child index of the node. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

bool SetNodeParentUid ( const FString& NodeUniqueID,
const FString& NewParentNodeUid
)

 Set the ParentUid of the node. Nodes/InterchangeBaseNodeContainer.h
  • BlueprintCallable
  • Category="Interchange | Node Container"

void SetupAndReplaceFactoryNode ( UInterchangeFactoryBaseNode* Node,
const FString& NodeUID,
const FString& DisplayLabel,
EInterchangeNodeContainerType ContainerType,
const FString& OldNodeUID,
const FString& ParentNodeUID
)

   Nodes/InterchangeBaseNodeContainer.h  

void SetupNode ( UInterchangeBaseNode* Node,
const FString& NodeUID,
const FString& DisplayLabel,
EInterchangeNodeContainerType ContainerType,
const FString& ParentNodeUID
)

   Nodes/InterchangeBaseNodeContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page