Navigation
API > API/Editor > API/Editor/SceneOutliner
Base tree item interface
| Name | ISceneOutlinerTreeItem |
| Type | struct |
| Header File | /Engine/Source/Editor/SceneOutliner/Public/ISceneOutlinerTreeItem.h |
| Include Path | #include "ISceneOutlinerTreeItem.h" |
Syntax
struct ISceneOutlinerTreeItem : public TSharedFromThis< ISceneOutlinerTreeItem >
Inheritance Hierarchy
- TSharedFromThis< ISceneOutlinerTreeItem > → ISceneOutlinerTreeItem
Derived Classes
ISceneOutlinerTreeItem derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ISceneOutlinerTreeItem
(
FSceneOutlinerTreeItemType InType |
Default constructor | ISceneOutlinerTreeItem.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISceneOutlinerTreeItem() |
ISceneOutlinerTreeItem.h |
Structs
| Name | Remarks |
|---|---|
| FlagsType | Flags structure |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFilterPredicate | TBaseDelegate_OneParam< bool, const ISceneOutlinerTreeItem &Item > | ISceneOutlinerTreeItem.h | |
| FInteractivePredicate | TBaseDelegate_OneParam< bool, const ISceneOutlinerTreeItem &Item > | ISceneOutlinerTreeItem.h | |
| FOnRenameRequest | TBaseDelegate_NoParams< void > | Delegate for hooking up an inline editable text block to be notified that a rename is requested. | ISceneOutlinerTreeItem.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Type | const FSceneOutlinerTreeItemType | Static type identifier for the base class tree item | ISceneOutlinerTreeItem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Flags | FlagsType | Flags for this item | ISceneOutlinerTreeItem.h | |
| RenameRequestEvent | FOnRenameRequest | Broadcasts whenever a rename is requested | ISceneOutlinerTreeItem.h | |
| SSceneOutliner | friend | Friendship required for access to various internals | ISceneOutlinerTreeItem.h | |
| WeakSceneOutliner | TWeakPtr< ISceneOutliner > | Weak Outliner pointer | ISceneOutlinerTreeItem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddChild
(
FSceneOutlinerTreeItemRef Child |
Add a child to this item | ISceneOutlinerTreeItem.h | |
bool CanInteract() |
Check whether it should be possible to interact with this tree item | ISceneOutlinerTreeItem.h | |
T * CastTo () |
Attempt to cast this item to another type if it is of that type. Returns nullptr if it fails | ISceneOutlinerTreeItem.h | |
const T * CastTo () |
Attempt to cast this item to another type if it is of that type. Returns nullptr if it fails | ISceneOutlinerTreeItem.h | |
bool Filter
(
FFilterPredicate Pred |
ISceneOutlinerTreeItem.h | ||
virtual void GenerateContextMenu
(
UToolMenu* Menu, |
Generate a context menu for this item. Only called if only this item is selected. | ISceneOutlinerTreeItem.h | |
virtual TSharedRef< SWidget > GenerateLabelWidget
(
ISceneOutliner& Outliner, |
Generate the label widget for this item | ISceneOutlinerTreeItem.h | |
const TSet< TWeakPtr< ISceneOutlinerTreeItem > > & GetChildren() |
Get this item's children, if any. | ISceneOutlinerTreeItem.h | |
FString GetDisplayString() |
Get the raw string to display for this tree item - used for sorting | ISceneOutlinerTreeItem.h | |
FSceneOutlinerTreeItemID GetID() |
Get the ID that represents this tree item. Used to reference this item in a map | ISceneOutlinerTreeItem.h | |
bool GetInteractiveState
(
FInteractivePredicate Pred |
ISceneOutlinerTreeItem.h | ||
virtual FString GetPackageName() |
Returns (optionally) the name of the UPackage this item represents/is-part-of | ISceneOutlinerTreeItem.h | |
FSceneOutlinerTreeItemPtr GetParent() |
Get this item's parent. Can be nullptr. | ISceneOutlinerTreeItem.h | |
virtual bool GetPinnedState() |
Query the pinned staet of this item. Only called if the item has its own pinned state info | ISceneOutlinerTreeItem.h | |
virtual FFolder::FRootObject GetRootObject() |
Get the optional context object root of a tree item. | ISceneOutlinerTreeItem.h | |
virtual bool GetVisibility() |
Query this items visibility state. Only called if the item type has visibility info | ISceneOutlinerTreeItem.h | |
virtual bool HasPinnedStateInfo() |
Returns true if this item can set its own pinned state | ISceneOutlinerTreeItem.h | |
virtual bool HasVisibilityInfo() |
Returns true if this item can set its own visibility | ISceneOutlinerTreeItem.h | |
bool IsA() |
Returns true if this item is of the specified type | ISceneOutlinerTreeItem.h | |
bool IsValid() |
Returns true if the data the item references is valid | ISceneOutlinerTreeItem.h | |
virtual void OnExpansionChanged() |
Called when this item is expanded or collapsed | ISceneOutlinerTreeItem.h | |
virtual void OnLabelChanged() |
Called when this item's label has changed | ISceneOutlinerTreeItem.h | |
virtual void OnVisibilityChanged
(
const bool bNewVisibility |
Called when this items visibility changed | ISceneOutlinerTreeItem.h | |
void RemoveChild
(
const FSceneOutlinerTreeItemRef& Child |
Remove a child from this item | ISceneOutlinerTreeItem.h | |
virtual bool ShouldRemoveOnceLastChildRemoved() |
Whether the item should be removed when the last child has been removed. | ISceneOutlinerTreeItem.h | |
virtual bool ShouldShowPinnedState() |
Returns true if this item should show pinned state | ISceneOutlinerTreeItem.h | |
virtual bool ShouldShowVisibilityState() |
Returns true if this item should show its visibility state | ISceneOutlinerTreeItem.h |