Navigation
API > API/Editor > API/Editor/SceneOutliner
A tree item that represents a folder in the world
| Name | FFolderTreeItem |
| Type | struct |
| Header File | /Engine/Source/Editor/SceneOutliner/Public/FolderTreeItem.h |
| Include Path | #include "FolderTreeItem.h" |
Syntax
struct FFolderTreeItem : public ISceneOutlinerTreeItem
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFolderTreeItem
(
FName InPath |
Constructor that takes a path to this folder (including leaf-name) | FolderTreeItem.h | |
FFolderTreeItem
(
const FFolder& InFolder |
FolderTreeItem.h | ||
FFolderTreeItem
(
const FFolder& InFolder, |
FolderTreeItem.h | ||
FFolderTreeItem
(
FName InPath, |
Constructor that takes a path to this folder and a subclass tree item type (used for subclassing FFolderTreeItem) | FolderTreeItem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFilterPredicate | TBaseDelegate_OneParam< bool, const FFolder & > | FolderTreeItem.h | |
| FInteractivePredicate | TBaseDelegate_OneParam< bool, const FFolder & > | FolderTreeItem.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Type | const FSceneOutlinerTreeItemType | Static type identifier for this tree item class | FolderTreeItem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LeafName | FName | The leaf name of this folder | FolderTreeItem.h | |
| Path | FName | The path of this folder. / separated. | FolderTreeItem.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| RootObject | FFolder::FRootObject | Folder's root object (can be null) | FolderTreeItem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Delete
(
const FFolder& InNewParentFolder |
Delete this folder, children will be reparented to provided new parent path | FolderTreeItem.h | |
bool Filter
(
FFilterPredicate Pred |
FolderTreeItem.h | ||
virtual FFolder GetFolder() |
FolderTreeItem.h | ||
bool GetInteractiveState
(
FInteractivePredicate Pred |
FolderTreeItem.h | ||
const FName & GetLeafName() |
FolderTreeItem.h | ||
const FName & GetPath() |
FolderTreeItem.h | ||
virtual void MoveTo
(
const FFolder& InNewParentFolder |
Move this folder to a new parent | FolderTreeItem.h | |
virtual void SetPath
(
const FName& InNewPath |
FolderTreeItem.h |
Overridden from ISceneOutlinerTreeItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanInteract() |
Check whether it should be possible to interact with this tree item | FolderTreeItem.h | |
virtual void GenerateContextMenu
(
UToolMenu* Menu, |
Generate a context menu for this item. Only called if only this item is selected. | FolderTreeItem.h | |
virtual FString GetDisplayString() |
Get the raw string to display for this tree item - used for sorting | FolderTreeItem.h | |
virtual FSceneOutlinerTreeItemID GetID() |
Get the ID that represents this tree item. Used to reference this item in a map | FolderTreeItem.h | |
virtual FFolder::FRootObject GetRootObject() |
Get the optional context object root of a tree item. | FolderTreeItem.h | |
virtual bool HasPinnedStateInfo() |
Returns true if this item can set its own pinned state | FolderTreeItem.h | |
virtual bool IsValid() |
Begin ISceneOutlinerTreeItem Implementation | FolderTreeItem.h | |
virtual bool ShouldShowPinnedState() |
Returns true if this item should show pinned state | FolderTreeItem.h |