UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
DirectoryTree.h File Reference
#include "Containers/Array.h"
#include "Containers/ArrowWrapper.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/PathViews.h"
#include "Misc/ScopeExit.h"
#include "Misc/StringBuilder.h"
#include "Templates/Tuple.h"
#include "Templates/TypeCompatibleBytes.h"
#include "Templates/UniquePtr.h"

Go to the source code of this file.

Classes

class  TDirectoryTree< ValueType >
 
struct  TDirectoryTree< ValueType >::FIterationSentinel
 
struct  TDirectoryTree< ValueType >::TIterator< ViewedValueType >
 
struct  TDirectoryTree< ValueType >::TPointerIterator< ViewedValueType >
 

Namespaces

namespace  UE
 
namespace  UE::DirectoryTree
 

Enumerations

enum class  EDirectoryTreeGetFlags { None = 0 , Recursive = 0x1 , ImpliedParent = 0x1 << 1 , ImpliedChildren = 0x1 << 2 }
 

Functions

void UE::DirectoryTree::FixupPathSeparator (FStringBuilderBase &InOutPath, int32 StartIndex, TCHAR InPathSeparator)
 
int32 UE::DirectoryTree::FindInsertionIndex (int32 NumChildNodes, const TUniquePtr< FString[]> &RelPaths, FStringView FirstPathComponent, bool &bOutExists)
 
 ENUM_CLASS_FLAGS (EDirectoryTreeGetFlags)
 

Enumeration Type Documentation

◆ EDirectoryTreeGetFlags

Enumerator
None 
Recursive 

If Recursive flag is present, GetChildren will return direct subpaths of a discovered directory and their transitive subpaths. If false, it will return only the direct subpaths.

Recursive=false and ImpliedChildren=false is an exception to this simple definition. In that case the reported results for a requested directory will include the highest level childpaths under it that have been added to the tree. These may be in transitive subpaths of the parent directory, and in that case their parent directories in between the requested directory and their path will not be reported because they are implied directories.

ImpliedParent 

If ImpliedParent flag is present, then the requested directory will return results even if it is an implied directory (directory with child paths but not added itself,

See also
TDirectoryTree). If not present, only directories that have been added to the tree will return non-empty results.
ImpliedChildren 

If ImpliedChildren is present, then all child paths discovered (either direct or recursive, depending on whether Recursive flag is present) will be reported in the results, even if they are implied directories (directory with child paths but not added itself,

See also
TDirectoryTree). If not present, only files and directories that have been added to the tree will be returned in the results.

Function Documentation

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( EDirectoryTreeGetFlags  )