Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > SceneOutliner > ITreeItem

Light Theme

Dark Theme

ITreeItem

Base tree item interface

Windows

MacOS

Linux

Inheritance Hierarchy

IDropTarget

TSharedFromThis

ITreeItem

	FActorTreeItem
	FComponentTreeItem
	FFolderTreeItem
	FSubComponentTreeItem
	FWorldTreeItem

References

Module	SceneOutliner
Header	/Engine/Source/Editor/SceneOutliner/Public/ITreeItem.h
Include	#include "ITreeItem.h"

Syntax

struct ITreeItem :
public SceneOutliner::IDropTarget,
public TSharedFromThis< ITreeItem >

Remarks

Base tree item interface

Variables

	Name	Description
TArray< TWeakPt...	Children	Array of children contained underneath this item
FlagsType	Flags	Flags for this item
TWeakPtr< ITree...	Parent	This item's parent, if any.
FOnRenameReques...	RenameRequestEvent	Broadcasts whenever a rename is requested
TSharedPtr< FSh...	SharedData	Data that is common between all outliner items - owned by the Outliner itself
friend	SSceneOutliner	Friendship required for access to various internals
TArray< FTreeIt...	SubComponentItems	Array of sub-component data contained within this item

Constructors

	Name	Description
	ITreeItem()	Default constructor

Destructors

	Name	Description
	~ITreeItem()

Functions

	Name	Description
void	AddChild ( FTreeItemRef Child )	Add a child to this item
bool	CanInteract()	Check whether it should be possible to interact with this tree item
FTreeItemPtr	CreateParent()	Create this item's parent. It is valid to return nullptr if this item has no parent
FTreeItemPtr	FindParent ( const FTreeItemMap& ExistingItems )	Find this item's parent in the specified map.
void	GenerateContextMenu ( UToolMenu* Menu, SSceneOutliner& Outliner )	Generate a context menu for this item. Only called if only this item is selected.
T	Get ( const TTreeItemGetter< T >& Getter )	Get some data from this tree item using a 'getter' visitor.
const TArray...	GetChildren()	Get this item's children, if any.
FString	GetDisplayString()	Get the raw string to display for this tree item - used for sorting
FTreeItemID	GetID()	Get the ID that represents this tree item. Used to reference this item in a map
FTreeItemPtr	GetParent()	Get this item's parent. Can be nullptr.
const FShare...	GetSharedData()
const TArray...	GetSubComponentItems()	Get this item's sub-component items, if any.
int32	GetTypeSortPriority()	Get the sort priority given to this item's type
void	OnExpansionChanged()	Called when this item is expanded or collapsed
void	PopulateDragDropPayload ( FDragDropPayload& Payload )	Populate the specified drag/drop payload with any relevant information for this type
void	RemoveChild ( const FTreeItemRef& Child )	Remove a child from this item
void	SynchronizeSubItemSelection ( TSharedPtr< class SOutlinerTreeView... )
void	Visit ( const ITreeItemVisitor& Visitor )	Visit this tree item
void	Visit ( const IMutableTreeItemVisitor& Vis... )

Classes

	Name	Description
	FlagsType	Flags structure

Typedefs

Name	Description
FOnRenameRequest	Delegate for hooking up an inline editable text block to be notified that a rename is requested.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss