1. Epic GamesDeveloper
  3. FMaterialLayersFunctionsTree

FMaterialLayersFunctionsTree

API > API/Runtime > API/Runtime/Engine

   
Name FMaterialLayersFunctionsTree
Type struct
Header File /Engine/Source/Runtime/Engine/Public/Materials/MaterialLayersFunctions.h
Include Path #include "Materials/MaterialLayersFunctions.h"

Syntax

USTRUCT ()  
struct FMaterialLayersFunctionsTree

Constructors

Name Remarks Include Path Unreal Specifiers
  Materials/MaterialLayersFunctions.h  
  Materials/MaterialLayersFunctions.h  
  Materials/MaterialLayersFunctions.h  

Structs

Name Remarks
FNode  
FPayload  

Typedefs

Name Type Remarks Include Path
FNodeId int32   Materials/MaterialLayersFunctions.h
FNodeVisitor void(*)(FNodeId InNodeId, int32 InDepth, int32 InSiblingNum, const FPayload &InPayload) Traverser Utility. Materials/MaterialLayersFunctions.h
FPayloadId int32   Materials/MaterialLayersFunctions.h

Constants

Name Type Remarks Include Path
InvalidId const FNodeId   Materials/MaterialLayersFunctions.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Nodes TArray< FNode >   Materials/MaterialLayersFunctions.h  
Payloads TArray< FPayload >   Materials/MaterialLayersFunctions.h  
Root FNodeId   Materials/MaterialLayersFunctions.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNodeId AddNode ( const FPayload& InPayload,
FNodeId InParent,
int32 InAtChildIndex
)

 Add a new node with the specified Payload under the InPArent at the specified child index the new node id is returned Materials/MaterialLayersFunctions.h  

void Empty()

   Materials/MaterialLayersFunctions.h  

TArray< FNodeId > GetChildrenIds ( FNodeId InNodeId
) const

 Gather the list of children for this node. Materials/MaterialLayersFunctions.h  

FNodeId GetChildrenTailId ( FNodeId InNodeId
) const

 Find the last of the children in the specified node. Materials/MaterialLayersFunctions.h  

int32 GetDepth ( FNodeId InNodeId
) const

 Return the depth of the node in the tree, the root is depth 0 the first valid node in the tree under the root is depth 1 Materials/MaterialLayersFunctions.h  

FNode * GetNode ( FNodeId InNodeId
) const

 Find and return the node at the specified Id or null if invalid. Materials/MaterialLayersFunctions.h  

FNode * GetParent ( FNodeId InNodeId
) const

 Find and return the parent node at the specified Id or null if invalid. Materials/MaterialLayersFunctions.h  

TArray< FNodeId > GetParentIds ( FNodeId InNodeId
) const

 Gather the path of parent node up to the root from the specified node. Materials/MaterialLayersFunctions.h  

FPayload * GetPayload ( FNodeId InNodeId
) const

 Find and return the node payload at the specified Id or null if invalid. Materials/MaterialLayersFunctions.h  

FNodeId GetPreviousSiblingId ( FNodeId InNodeId
) const

 Find the node which is the previous sibling to the specified node The Next sibling is directly available in the FNode struct, not the previous one Materials/MaterialLayersFunctions.h  

FNodeId GetSiblingHeadId ( FNodeId InNodeId
) const

 Find the node which is the head of the list of siblings where InNodeID belongs. Materials/MaterialLayersFunctions.h  

bool IsEmpty()

   Materials/MaterialLayersFunctions.h  

bool IsValidId ( FNodeId Id
) const

 Authoring the Tree. Materials/MaterialLayersFunctions.h  

FString Log ( FString InTab
) const

 Logging the tree data structure, useful for debugging generate a multiline string representing the tree nodes hierarchy with the payload info per node Materials/MaterialLayersFunctions.h  

void MoveNode ( FNodeId InNodeId,
FNodeId DstParentId,
int32 InSiblingIndex
)

 Move node from one position to another. Materials/MaterialLayersFunctions.h  

std::pair< TArray< FNodeId >, TArray< FPayload > > RemoveNode ( FNodeId RemovedNodeId
)

 Remove this node detach the node from the tree hierarchy as well as all the children recursively the nodes are all cleared in the array of nodes the payloads are NOT cleared and still hold on their value return the array of Id of the removed nodes AND the array of Payloads removed Materials/MaterialLayersFunctions.h  

bool Serialize ( FArchive& Ar
)

   Materials/MaterialLayersFunctions.h  

void Traverse ( V InVisitor,
FNodeId InRootNodeId
) const

   Materials/MaterialLayersFunctions.h  

void TraverseBottomUp ( V InVisitor,
FNodeId InRootNodeId
) const

   Materials/MaterialLayersFunctions.h  

FNodeId TraverseNode ( V InVisitor,
FNodeId InNodeId,
int32 InDepth,
int32 InSiblingNum,
bool ReverseOrder
) const

   Materials/MaterialLayersFunctions.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FMaterialLayersFunctionsTree& Other
) const

   Materials/MaterialLayersFunctions.h  
  Materials/MaterialLayersFunctions.h  

bool operator== ( const FMaterialLayersFunctionsTree& Other
) const

   Materials/MaterialLayersFunctions.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page