UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FPropertyPathNameTree Class Reference

#include <PropertyPathNameTree.h>

Classes

class  FConstIterator
 
struct  FConstNode
 
struct  FNode
 

Public Member Functions

 FPropertyPathNameTree ()=default
 
 FPropertyPathNameTree (FPropertyPathNameTree &&)=default
 
 FPropertyPathNameTree (const FPropertyPathNameTree &)=delete
 
FPropertyPathNameTreeoperator= (FPropertyPathNameTree &&)=default
 
FPropertyPathNameTreeoperator= (const FPropertyPathNameTree &)=delete
 
bool IsEmpty () const
 
UE_API void Empty ()
 
UE_API FNode Add (const FPropertyPathName &Path, int32 StartIndex=0)
 
UE_API bool Remove (const FPropertyPathName &Path, int32 StartIndex=0)
 
UE_API FNode Find (const FPropertyPathName &Path, int32 StartIndex=0)
 
FConstNode Find (const FPropertyPathName &Path, int32 StartIndex=0) const
 
FConstIterator CreateConstIterator () const
 

Friends

UE_API friend void AppendHash (FBlake3 &Builder, const FPropertyPathNameTree &Tree)
 

Detailed Description

A tree of property path names and their associated types.

A union of the paths that are added, ignoring any container index.

Constructor & Destructor Documentation

◆ FPropertyPathNameTree() [1/3]

UE::FPropertyPathNameTree::FPropertyPathNameTree ( )
default

◆ FPropertyPathNameTree() [2/3]

UE::FPropertyPathNameTree::FPropertyPathNameTree ( FPropertyPathNameTree &&  )
default

◆ FPropertyPathNameTree() [3/3]

UE::FPropertyPathNameTree::FPropertyPathNameTree ( const FPropertyPathNameTree )
delete

Member Function Documentation

◆ Add()

FPropertyPathNameTree::FNode UE::FPropertyPathNameTree::Add ( const FPropertyPathName Path,
int32  StartIndex = 0 
)

Adds the path to the tree. Keeps any existing nodes that match both name and type.

◆ CreateConstIterator()

FConstIterator UE::FPropertyPathNameTree::CreateConstIterator ( ) const
inline

◆ Empty()

void UE::FPropertyPathNameTree::Empty ( )

Remove every property path name from the tree.

◆ Find() [1/2]

FPropertyPathNameTree::FNode UE::FPropertyPathNameTree::Find ( const FPropertyPathName Path,
int32  StartIndex = 0 
)

Finds the path within the tree.

Parameters
OutSubTreeIf non-null, this is set to the maybe-null sub-tree at the path if the path is found.
PathPath to search within the tree.
StartIndexIndex of the segment within Path at which to start searching.
Returns
An accessor for the node at the path if it exists.

◆ Find() [2/2]

FConstNode UE::FPropertyPathNameTree::Find ( const FPropertyPathName Path,
int32  StartIndex = 0 
) const
inline

◆ IsEmpty()

bool UE::FPropertyPathNameTree::IsEmpty ( ) const
inline

True if the tree contains no property path names.

◆ operator=() [1/2]

FPropertyPathNameTree & UE::FPropertyPathNameTree::operator= ( const FPropertyPathNameTree )
delete

◆ operator=() [2/2]

FPropertyPathNameTree & UE::FPropertyPathNameTree::operator= ( FPropertyPathNameTree &&  )
default

◆ Remove()

bool UE::FPropertyPathNameTree::Remove ( const FPropertyPathName Path,
int32  StartIndex = 0 
)

Removes the path from the tree. This may create a parent with no children. If that parent also has no tag, remove it too

Friends And Related Symbol Documentation

◆ AppendHash

UE_API friend void AppendHash ( FBlake3 Builder,
const FPropertyPathNameTree Tree 
)
friend

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