1. Epic GamesDeveloper
  3. FPathTree

FPathTree

API > API/Runtime > API/Runtime/AssetRegistry

   
Name FPathTree
Type class
Header File /Engine/Source/Runtime/AssetRegistry/Public/AssetRegistry/PathTree.h
Include Path #include "AssetRegistry/PathTree.h"

Syntax

class FPathTree

Constructors

Name Remarks Include Path Unreal Specifiers

FPathTree()

   AssetRegistry/PathTree.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChildPathToParentPath TMap< FName, FName > A one-to-one mapping between a child path and its parent path. AssetRegistry/PathTree.h  
ParentPathToChildPaths TMap< FName, TSet< FName > > A one-to-many mapping between a parent path and its child paths. AssetRegistry/PathTree.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CachePath ( FName Path,
TFunctionRef< void(FName)> OnPathAdded
)

 Adds the specified path to the tree, creating nodes as needed and calling OnPathAdded for any new paths added. AssetRegistry/PathTree.h  

void EnsureAdditionalCapacity ( int32 NumNewPaths
)

 Reserve extra space for the expected number of paths that will be added in future. AssetRegistry/PathTree.h  

void EnumerateAllPaths ( TFunctionRef< bool(FName)> Callback
) const

 Enumerate all of the paths we know about AssetRegistry/PathTree.h  

bool EnumerateSubPaths ( FName BasePath,
TFunctionRef< bool(FName)> Callback,
bool bRecurse
) const

 Recursively enumerates all child paths from the specified base path relative to this node AssetRegistry/PathTree.h  

SIZE_T GetAllocatedSize()

   AssetRegistry/PathTree.h  

bool GetAllPaths ( TSet< FName >& OutPaths
) const

 Get all of the paths we know about AssetRegistry/PathTree.h  

bool GetSubPaths ( FName BasePath,
TSet< FName >& OutPaths,
bool bRecurse
) const

 Recursively gathers all child paths from the specified base path relative to this node AssetRegistry/PathTree.h  

int32 NumPaths()

   AssetRegistry/PathTree.h  

bool PathExists ( FName Path
) const

 Checks whether the given path is one that we know about AssetRegistry/PathTree.h  

bool RemovePath ( FName Path,
TFunctionRef< void(FName)> OnPathRemoved
)

 Removes the specified path from the tree, calling OnPathRemoved for any existing paths removed. AssetRegistry/PathTree.h  

void Shrink()

 Shrinks the internal structures reducing the memory they use. AssetRegistry/PathTree.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName NormalizePackagePath ( FName In
)

 Normalize the given PackagePath (/Game/SubDir) by removing a trailing slash if it exists. AssetRegistry/PathTree.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page