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 > ISceneOutlinerTreeItem

Light Theme

Dark Theme

ISceneOutlinerTreeItem

Base tree item interface

Inheritance Hierarchy

TSharedFromThis

FComponentTreeItem

FObjectMixerEditorListRowComponent

FContentBundleTreeItem

FFolderTreeItem

FActorFolderTreeItem

FObjectMixerEditorListRowFolder

FLevelTreeItem

FObjectMixerEditorListRowUObject

FWorldTreeItem

IActorBaseTreeItem

FActorDescTreeItem

FActorTreeItem

FObjectMixerEditorListRowActor

References

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

Syntax

struct ISceneOutlinerTreeItem : public TSharedFromThis< ISceneOutlinerTreeItem >

Remarks

Base tree item interface

Variables

	Name	Description
TSet< TWeakPtr<...	Children	Array of children contained underneath this item
FlagsType	Flags	Flags for this item
TWeakPtr< IScen...	Parent	This item's parent, if any.
FOnRenameReques...	RenameRequestEvent	Broadcasts whenever a rename is requested
friend	SSceneOutliner	Friendship required for access to various internals
FSceneOutlinerT...	TreeType	Tree item type identifier
TWeakPtr< IScen...	WeakSceneOutliner	Weak Outliner pointer

Constructors

	Name	Description
	ISceneOutlinerTreeItem ( FSceneOutlinerTreeItemType InType )	Default constructor

Destructors

	Name	Description
	~ISceneOutlinerTreeItem()

Functions

	Name	Description
void	AddChild ( FSceneOutlinerTreeItemRef Child )	Add a child to this item
bool	CanInteract()	Check whether it should be possible to interact with this tree item
T *	CastTo()	Attempt to cast this item to another type if it is of that type. Returns nullptr if it fails
const T *...	CastTo()	Attempt to cast this item to another type if it is of that type. Returns nullptr if it fails
void	GenerateContextMenu ( UToolMenu* Menu, SSceneOutliner& Outliner )	Generate a context menu for this item. Only called if only this item is selected.
TSharedRef< ...	GenerateLabelWidget ( ISceneOutliner& Outliner, const STableRow< FSceneOutlinerTree... )	Generate the label widget for this item
const TSet< ...	GetChildren()	Get this item's children, if any.
FString	GetDisplayString()	Get the raw string to display for this tree item - used for sorting
FSceneOutlin...	GetID()	Get the ID that represents this tree item. Used to reference this item in a map
FSceneOutlin...	GetParent()	Get this item's parent. Can be nullptr.
bool	GetPinnedState()	Query the pinned staet of this item. Only called if the item has its own pinned state info
FFolder::FRo...	GetRootObject()	Get the optional context object root of a tree item.
bool	GetVisibility()	Query this items visibility state. Only called if the item type has visibility info
bool	HasPinnedStateInfo()	Returns true if this item can set its own pinned state
bool	HasVisibilityInfo()	Returns true if this item can set its own visibility
bool	IsA()	Returns true if this item is of the specified type
bool	IsValid()	Returns true if the data the item references is valid
void	OnExpansionChanged()	Called when this item is expanded or collapsed
void	OnLabelChanged()	Called when this item's label has changed
void	OnVisibilityChanged ( const bool bNewVisibility )	Called when this items visibility changed
void	RemoveChild ( const FSceneOutlinerTreeItemRef& C... )	Remove a child from this item
bool	ShouldShowPinnedState()	Returns true if this item should show pinned state
bool	ShouldShowVisibilityState()	Returns true if this item should show its visibility state

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.

Constants

Name	Description
Type	Static type identifier for the base class tree item

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

Take our survey

Cancel